Reserved variables

Every title has a set of predefined, reserved variables. These variables are read-only; they cannot be modified. Additional variables, some of which are read-only, are available within the title depending upon the type of title you are creating.

See also: Creating an AICC/SCORM title for a LMS

Predefined Variable

Description

Dynamically Updated?

AICC_Student_Language This variable contains either the language of the student's interface in the LMS or the language that the student selected within the content itself. Yes

BrowserType

This variable contains the name of the browser currently used to view the title. The variable is set to Saba Inspire Standard Edition when run in preview mode, and Saba Inspire when run as a title published for offline use. For titles published to the Web, the variable value contains the browser used to view the title, such as Internet Explorer.

No

CurrentChapterName

This variable contains the name of the chapter that includes the current page being displayed. If there is no current chapter, then this variable has the value of Unknown.

Yes

CurrentDate

For titles published to the Web, this variable contains today’s date in the form <Day of the Week>, <Month> <Day>, <Year>. For example: Wednesday, March 11, 2014. For titles published for offline use, this variable contains today’s date in the form <Month> <Day>, <Year>. For example: March 11, 2008.

The date and time display differently depending on the user's browser and locale settings. To avoid this situation, use the Date Format and Time Format publish strings to specify the appropriate text to be used at runtime. For details, see Specifying publish strings preferences.

No

CurrentPageName

This variable contains the name of the current page.

Yes

CurrentView This variable contains the name of the device and orientation currently being used to view the title. This will be one of the following values: Desktop, PhonePortrait, PhoneLandscape, TabletPortrait, and TabletLandscape. Yes

CurrentSectionName

This variable contains the name of the section that includes the current page being displayed. If there is no current section, then this variable has the value of Unknown.

Yes

CurrentTime

This variable contains the current time in the form hh:mm AM/PM. For example, 4:19 PM.

The date and time display differently depending on the user's browser and locale settings. To avoid this situation, use the Date Format and Time Format publish strings to specify the text to be used at runtime. For details, see Specifying publish strings preferences.

No

CurrentTitleName

This variable contains the name of the title.

Yes

ElapsedTime

This variable contains the amount of time the user has spent within the current title.

No

PageInChapter

This variable contains the current page number relative to the pages within the current chapter.

Yes

PagesInChapter

This variable contains the total number of pages in the current chapter.

Yes

PageInSection

This variable contains the current page number relative to the pages within the current section.

Yes

PagesInSection

This variable contains the total number of pages in the current section.

Yes

PageInTitle

This variable contains the current page number relative to the entire title. If your title contains frames, this variable contains the current page relative to the total number of pages within that frame.

Yes

PagesInTitle

This variable contains the total number of pages in the title. If your title contains frames, this variable contains the total number of pages within that frame.

Yes

Platform

This variable contains the name of the platform on which the published title is running. For offline-published titles, this could contain Microsoft Windows NT, Microsoft Windows XP, and so on. For titles published to the Web, the variable contains Win32 for 32-bit Windows platforms, and MacPPC for Macintosh PowerPC platforms. Values can also include:

iPad

Win32 (Windows operating system)

iPhone

MacIntel (Mac™ operating system)

Linux (Android™ operating system)

No

PublishDate

This variable contains the date and time that the title was published in the form <Month> <Day>, <Year> hh:mm AM/PM. For example, July 21, 2008 4:20 PM.

No

<test name>_Score

For each test in the title, a variable will be created that will contain the score of the test. If the test has not yet been taken or the test cannot be scored, the value is 0.

No

<test name>_<test section>_Score

For each test section in the title, a variable will be created that will contain the score of the test section. If the test has not yet been taken or the test cannot be scored, the value is 0.

No

Question_####

This variable contains the user's answer to the question. This variable name can be changed within the question's properties.

Yes

RadioGroup_####

This variable contains the user's selection from the radio buttons contained in the group. This variable name can be changed within the radio button group's properties.

Yes

Radio_####

For each radio button (not contained in a radio button group) in the title, a variable will be created that will contain whether the radio button is selected. If selected, the variable will have a value of "on" and otherwise will have no value. This variable name can be changed within the radio button's properties.

Yes

Checkbox_####

For each check box in the title, a variable will be created that will contain whether the check box is selected. If selected, the variable will have a value of "on" and otherwise will have no value. This variable name can be changed within the check box's properties.

Yes

Entry_####

For each entry field in the title, a variable will be created that will contain what the user has typed within the entry field. This variable name can be changed within the entry field's properties.

Yes

DropList_####

For each drop-down in the title, a variable will be created that will contain what the user has selected from the drop-down list. This variable name can be changed within the drop-down list's properties.

Yes

List_####

For each list box in the title, a variable will be created that will contain what the user has selected from the list box. This variable name can be changed within the list box's properties.

Yes

ProgressBar_#### For each custom progress bar in the title, a variable will be created that will contain the value of the range position of the progress bar. You can select to associate this progress bar with an existing variable, a new variable, or no variable. Yes

If you have designated your title as an AICC/SCORM for LMS title type, the following additional variables are available within your title:

Predefined Variable

Description

Modifiable?

AICC_Core_Lesson

This variable contains information used by the published title to properly calculate the score of the user in the current title. If you modify the value of this variable within the content of a title that contains more than one automatically graded test, then the AICC_Score of the student cannot be properly updated and reflected to the AICC/SCORM Learning Management System (LMS).

For all versions of SCORM including SCORM 2004, this variable is typically referred to by your LMS as cmi.suspend_data.

Yes

AICC_Core_Vendor

This variable contains the information required by the program when running an AICC-compliant title within an AICC learning management system. This variable is not used by published content.

No

AICC_Course_ID

This variable contains the id of the course in the AICC/SCORM learning management system.

No

AICC_Credit

This variable reflects whether the AICC/SCORM title is being taken for "credit" or just in a "browse" mode.

No

AICC_Lesson_ID

This variable contains the name of the title's assignable unit.

No

AICC_Lesson_Location

This variable contains the current location within the title content. The published content sets this variable on every page of the title to reflect the current location of the student within the AICC/SCORM LMS.

For all versions of SCORM including SCORM 2004, this variable is typically referred to by your LMS as cmi.location.

Yes

AICC_Lesson_Status

This variable contains the current status of the course within the AICC/SCORM LMS. The program sets the value of this variable to incomplete. The AICC/SCORM LMS will further modify the variable based on the current AICC_Score for the user and the value specified as the Mastery Score.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.success_status . For all other versions of SCORM, it is typically referred to as cmi.core.lesson_status.

Yes

AICC_Score

This variable contains the average of all test scores in the published title. If you modify the value of this variable within the content of a course that contains more than one automatically graded test, the modification will be lost when the user completes an automatically graded test.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.score.raw. For all other versions of SCORM, it is typically referred to as cmi.core.score.raw.

Yes

AICC_Student_ID

This variable contains the user id as reported by the AICC/SCORM LMS.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.learner_id. For all other versions of SCORM, it is typically referred to as cmi.core.student_id.

No

AICC_Student_Name

This variable contains the user name as reported by the AICC/SCORM LMS.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.learner_name. For all other versions of SCORM, it is typically referred to as cmi.core.student_name.

No

AICC_Time

This variable contains the total time the user has been in the published title. This value is automatically updated while the student is viewing the title. If you modify the value of this variable, the modification will be lost when the student exits the title. Also, this variable must be in the format of HH:MM:SS:mm to be valid when reported to the AICC LMS.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.total_time. Additionally, cmi.session_time is also automatically set.

Yes

CMI_Core_Entry

This variable is only accessible in SCORM published titles and contains information related to whether the student has previously accessed the published title.

For SCORM 2004 this variable is typically referred to by your LMS as cmi.entry and for all other versions of SCORM it is referred to as cmi.core.entry.

No

CMI_Core_Exit

This variable is only accessible in SCORM-published titles and is used to indicate how or why the student exited the published title.

For SCORM 2004 this variable is typically referred to by your LMS as cmi.exit and for all other versions of SCORM it is referred to as cmi.core.exitcmi.core.exit.

This exit value is automatically set to suspend if an unfinished course is being attempted, otherwise it is left alone. Some LMS vendors require specific values that you can set through this write-only variable. If your LMS vendor requests that the course needs to set this variable, it can be done with a Modify Variable action. For details about configuring the Modify Variable action, see Adding an action.

Yes

CMI_Completion_Status

This variable is only accessible in SCORM 2004 published titles and determines the point at which the student has actually completed viewing the published title. In a SCORM 2004 published course, the author MUST set this variable at the point in the course that the student has been determined to have completed viewing the necessary content for the course.

For SCORM 2004, this variable is typically referred to by your LMS as cmi.completion_status.

Yes

If the title is being created for placement on the CourseMill learning management system, the following additional variables are available:

Predefined Variables

Description

Modifiable?

CM_Course_ID

This variable contains the ID of the course as defined in CourseMill.

No

CM_Course_Name

This variable contains the name of the title as defined in CourseMill

No

CM_Student_ID

This variable contains the student ID as reported by CourseMill.

No

CM_Student_Name

This variable contains the student name as reported by CourseMill.

No

Support | About Saba
© Copyright Trivantis 2019