|
|
|
One of the great parts of the SCORM specification is that its extensibility allows vendors to add additional functionality without breaking the standard or requiring other vendors to use a proprietary technology. Rustici Software has extended the SCORM meta-data specification to allow content vendors added control over how the SCORM Engine will deliver their content. These added parameters determine such things as the default window size, which navigational controls are available and how the player should behave when a SCO exits. The SCORM Engine meta-data extensions can be divided into three broad categories:
The table below contains a complete list of the available parameters.
|
The SCORM Engine Meta-Data Extensions |
|||
|
Number |
Name |
Explanation |
Data Type |
|
1 |
Controls |
This container element holds all of the parameters relating to the availability of navigational controls in the SCORM Player. |
Container |
|
1.1 |
Show Finish Button |
This element determines if the SCORM Player should display the finish button to the learner. If the Show Navigation Bar parameter is no, then this element has no effect. |
yes/no |
|
1.2 |
Show Help |
This element determines if the SCORM Player should display the help button to the learner. If the Show Navigation Bar parameter is no, then this element has no effect. |
yes/no |
|
1.3 |
Show Progress Bar |
This element determines if the SCORM Player should display the progress bar to the learner. If the Show Navigation Bar parameter is no, then this element has no effect. |
yes/no |
|
1.4 |
Show Course Structure |
This element determines if the SCORM Player should make the course structure available to the learner. |
yes/no |
|
1.5 |
Course Structure Starts Open |
If the course structure is available to the learner, this element determines if the SCORM Player should begin with the course structure shown or hidden. The user can always show/hide the course structure if it is available. If the Show Course Structure parameter is no, this element has no effect. |
yes/no |
|
1.6 |
Show Navigation Bar |
This element determines if the SCORM Player should make the navigation bar available to the learner. |
yes/no |
|
1.7 |
Show Title Bar |
This element determines if the SCORM Player should make the title bar available to the learner. |
yes/no |
|
1.8 |
Enable Flow Navigation |
This element determines if the SCORM Player should display the previous and next buttons to the learner. If the Show Navigation Bar parameter is no, then this element has no effect. |
yes/no |
|
1.9 |
Enable Choice Navigation |
This element determines if the SCORM Player will allow the learner to navigate a course by clicking on links in the course structure. If the Show Course Structure parameter is no, this element has no effect. |
yes/no |
|
1.10 |
Status Display |
This element defines how icons are displayed to indicate success and completion status. |
Status Display Type |
|
2 |
Appearance |
This container element holds all of the parameters relating to the appearance of the SCORM Player. |
Container |
|
2.1 |
Display Stage |
The display stage is the area in which a SCO is delivered. These elements determine how the display stage is configured. |
Container |
|
2.1.1 |
Desired |
This container element contains the settings you would like to have used when displaying your content. The HLC will make a best effort to accommodate these settings depending on the configuration and capabilities of the learners browser. |
Container |
|
2.1.1.1 |
Width |
Represents the width of the display stage in pixels. |
Positive Integer |
|
2.1.1.2 |
Height |
Represents the height of the display stage in pixels. |
Positive Integer |
|
2.1.1.3 |
Full Screen |
This element determines if the SCORM Player should launch the content using the full screen feature of the browser. If this parameter is set to true, the content MUST include an obvious method for the user to exit the content. |
yes/no |
|
2.1.2 |
Required |
This container element contains the settings the content must have to operate correctly. Use these settings with caution. |
Container |
|
2.1.2.1 |
Width |
Represents the width of the display stage in pixels. If the content can operate with any width, use 0. |
Positive Integer |
|
2.1.2.2 |
Height |
Represents the height of the display stage in pixels. If the content can operate with any height, use 0. |
Positive Integer |
|
2.1.2.3 |
Full Screen |
This element determines if the SCORM Player should launch the content using the full screen feature of the browser. If this parameter is set to true, the content MUST include an obvious method for the user to exit the content. |
yes/no |
|
2.2 |
Course Structure Width |
The width of the course structure in the SCORM Player. |
Positive Integer |
|
3 |
Behavior |
This container element holds all of the parameters relating to the behavior of the SCORM Player. |
Container |
|
3.1 |
Launch |
This container element determines how parts of the SCORM Player should be launched (in a frameset, in a new window, etc see the description of the Launch Type data type for more detail). |
Container |
|
3.1.1 |
SCO |
This element determines how the SCORM Player should launch individual SCOs. |
Launch Type |
|
3.1.2 |
Player |
This element determines how the HLC should launch the SCORM Player itself. |
Launch Type |
|
3.1.3 |
Wrap SCO Window with API |
When a SCO is launched in a new window, some poorly implemented SCORM content can have trouble finding the SCORM API. This parameter will wrap an empty frameset around the SCO window which presents an API that relays calls back to the real SCORM Player API. |
yes/no |
|
3.2 |
Exit Actions |
These setting control what action the SCORM Player will take when a SCO exits. Some possible actions include going to the next SCO, displaying a message and exiting the course (see description of the Exit Type data type for more detail). There are three factors the SCORM Player looks at when determining the action to take when a SCO exits, the position of the SCO in the course (is it in the middle, or is it the last SCO), the state of the SCO/Course, and the SCORM exit type specified by the SCO. The following parameters allow you to adjust the SCORM Players behavior in each of these possible scenarios. Note that these parameters only take affect when the content originates an exit action by calling LMSFinish before the user initiates an exit action by using a navigational control in the SCORM Player. |
Container |
|
3.2.1 |
Intermediate SCO |
These elements deal with SCOs that are in the middle of the course, i.e. every SCO except for the last SCO. |
Container |
|
3.2.1.1 |
Satisfied |
These elements determine the players action when the intermediate SCO that just exited is satisfied (lesson_status = complete or passed). |
Container |
|
3.2.1.1.1 |
Normal |
Action when an intermediate SCO is satisfied and the exit type is normal. |
Exit Type |
|
3.2.1.1.2 |
Suspend |
Action when an intermediate SCO is satisfied and the exit type is suspend. |
Exit Type |
|
3.2.1.1.3 |
Timeout |
Action when an intermediate SCO is satisfied and the exit type is timeout. |
Exit Type |
|
3.2.1.1.4 |
Logout |
Action when an intermediate SCO is satisfied and the exit type is logout. |
Exit Type |
|
3.2.1.2 |
Not Satisfied |
These elements determine the players action when the intermediate SCO that just exited is not satisfied (lesson_status != complete or passed). |
Container |
|
3.2.1.2.1 |
Normal |
Action when an intermediate SCO is not satisfied and the exit type is normal. |
Exit Type |
|
3.2.1.2.2 |
Suspend |
Action when an intermediate SCO is not satisfied and the exit type is suspend. |
Exit Type |
|
3.2.1.2.3 |
Timeout |
Action when an intermediate SCO is not satisfied and the exit type is timeout. |
Exit Type |
|
3.2.1.2.4 |
Logout |
Action when an intermediate SCO is not satisfied and the exit type is logout. |
Exit Type |
|
3.2.2 |
Final SCO |
These elements deal with the last SCO in the course. In the case of a single SCO course, the SCO is always treated as the final SCO. |
Container |
|
3.2.2.1 |
Satisfied |
These elements determine the players action when the entire course is satisfied (note that this means all SCOs must have a lesson_status = complete or passed). |
Container |
|
3.2.2.1.1 |
Normal |
Action when the final SCO exits and the entire course is satisfied and the exit type is normal. |
Exit Type |
|
3.2.2.1.2 |
Suspend |
Action when the final SCO exits and the entire course is satisfied and the exit type is suspend. |
Exit Type |
|
3.2.2.1.3 |
Timeout |
Action when the final SCO exits and the entire course is satisfied and the exit type is timeout. |
Exit Type |
|
3.2.2.1.4 |
Logout |
Action when the final SCO exits and the entire course is satisfied and the exit type is logout. |
Exit Type |
|
3.2.2.2 |
Not Satisfied |
These elements determine the players action when the entire course is not satisfied (note that this means at least one SCO must have a lesson_status != complete or passed). |
Container |
|
3.2.2.2.1 |
Normal |
Action when the final SCO exits and the entire course is not satisfied and the exit type is normal. |
Exit Type |
|
3.2.2.2.2 |
Suspend |
Action when the final SCO exits and the entire course is not satisfied and the exit type is suspend. |
Exit Type |
|
3.2.2.2.3 |
Timeout |
Action when the final SCO exits and the entire course is not satisfied and the exit type is timeout. |
Exit Type |
|
3.2.2.2.4 |
Logout |
Action when the final SCO exits and the entire course is not satisfied and the exit type is logout. |
Exit Type |
|
3.3 |
Disable Right Click |
Determines if the SCORM Player should prevent the user from right-clicking in the SCORM Player windows. This setting can be useful for high-stakes assessments or other situations where you wish to prevent the user from looking at the internal structure of the content or data in the player. Note this setting only affects the SCORM Player windows (the course structure, title bar and nav bar) it does not affect your content. |
yes/no |
|
3.4 |
Prevent Window Resize |
Determines if the SCORM Player window can be resized by the learner. |
yes/no |
|
3.5 |
Score Rollup Mode |
Determines how scores are rolled up to the course level. |
Score Rollup Type |
|
3.6 |
Number of Scoring Objects |
If the Score Rollup Mode is fixed average, this parameter indicates how many SCOs should be reporting a score. |
Positive Integer |
|
3.7 |
Status Rollup Mode |
Determines how completion status is rolled up to the course level. |
Status Rollup Type |
|
3.8 |
Threshold Score For Completion |
If the Status Rollup Mode is complete when threshold score is met, this parameter indicates what the threshold score for completion is. This value is a decimal between 0-1 (multiply it by 100 to equate it to a percentage. |
Decimal [0.00-1.00] |
|
3.9 |
First SCO is Pretest |
This parameter indicates that if the first SCO achieves a lesson status of passed, then the rest of the SCOs in the course will be marked complete. |
yes/no |
|
3.10 |
Finish Causes Immediate Commit |
This parameter is provided to deal with a few single-SCO configurations which make it difficult to capture the exit effectively. You may want to try setting this to true if a single SCO course is not recording completions successfully. |
yes/no |
|
3.11 |
Debug |
This section contains parameters related to client-side (browser) logging. |
Container |
|
3.11.1 |
Control Audit |
Determines whether high-level logging should be done within the Control subsystem on the client. |
Yes/No |
|
3.11.2 |
Control Detailed |
Determines whether detailed log messages from the Control subsystem should be recorded on the client. |
Yes/No |
|
3.11.3 |
Runtime Audit |
Determines whether high-level logging should be done within the Runtime subsystem on the client. |
Yes/No |
|
3.11.4 |
Runtime Detailed |
Determines whether detailed log messages from the Control Runtime should be recorded on the client. |
Yes/No |
|
3.11.5 |
Sequencing Audit |
Determines whether high-level logging should be done within the Sequencing subsystem on the client. |
Yes/No |
|
3.11.6 |
Sequencing Detailed |
Determines whether detailed log messages from the Sequencing subsystem should be recorded on the client. |
Yes/No |
|
3.11.7 |
Lookahead Audit |
Determines whether high-level logging should be done within the Sequencing-Lookahead subsystem on the client. |
Yes/No |
|
3.11.8 |
Lookahead Detailed |
Determines whether detailed log messages from the Sequencing-Lookahead subsystem should be recorded on the client. |
Yes/No |
|
3.11.9 |
Include Timestamps |
Determines whether timestamps should be recorded within the client-side log. |
Yes/No |
|
3.12 |
Communications |
|
Container |
|
3.12.1 |
Max Failed Submissions |
The maximum number of attempts to try a runtime data update to the central server before declaring failure. |
Positive Integer |
|
3.12.2 |
Commit Frequency |
How often, in milliseconds, to push runtime data updates back to the central server. (Note that some events cause immediate updates as well) |
Positive Integer |
|
3.13 |
Invalid Menu Item Action |
|
Invalid Menu Item Action Type |
|
3.14 |
Always Flow To First Sco |
If true, the SCORM Engine will always load the first SCO in a course upon initial launch regardless of whether sequencing rules dictate this behavior. |
Yes/No |
|
3.15 |
Logout Causes Player Exit |
When the cmi.exit data model element is set to logout, this parameter determines whether the SCORM Engine returns to the LMS or simply closes the SCO. |
Yes/No |
|
3.16 |
Reset RT Time |
Defines when to reset Runtime Data. |
Reset RunTime Data Time Type |
There is not data associated with container elements, they are simply placeholders to facilitate logical grouping of other elements.
The yes/no data type can have two values: yes represents the affirmative and no represents the negative.
The positive integer data type is a string that represents an integer greater than or equal to zero.
The launch type data type represents methods by which new windows can be launched. The possible values are:
frameset - Launches the item in a frameset. When applied to a SCO, this will result in the standard SCORM Player configuration pictured above. When applied to the SCORM Player itself it will launch the player inline rather than popping it in a new window.
new window - Launches the item in a new window.
new window,after click - Launches the item in a new window after forcing the user to click on an explicit link. This setting can be useful for circumventing popup blockers.
new window without browser toolbar - Launches the item in a new window without the standard browser toolbar.
The exit type data type represents actions the SCORM Player can take after a SCO exits. The possible values are:
exit,no confirmation - Simply close the SCORM Player and return to the HLC
exit,confirmation - Ask the learner if he wishes to exit the course, if so, return to the HLC, if not, display a message page.
continue - Take the learner to the next SCO. If applied to the final SCO, display a message page.
message page - Display a message page. The SCORM Player determines what message to display based on the current state of the player.
do nothing - The SCORM Player will take no action.
The status display data type represents the various ways in which the SCORM Player can display the status of SCOs to the user. The possible values are:
success only - Only success status is presented to the user.
completion only - Only completion status is presented to the user.
separate - Both success and completion status are presented to the user as separate indicators.
combined - Success and completion status are presented to the user as one combined metric.
none - No SCO-level status is presented to the user.
The score rollup data type represents the various ways in which the SCORM Player can rollup scores to the course level. The possible values are:
score provided by course - Useful for single-SCO courses, this parameter simply transfers the score provided by the first SCO in the course to the course-level.
average score of all units - Sum up all the scores that were provided and divide by the total number of SCOs in the course.
average score of all units with scores - Sum up all the scores that were provide and divide by the number of units that actually reported scores.
fixed average - Sum up all the scores that were provided and divide by a fixed number (as specified in the Number Of Scoring Objects setting).
The status rollup data type represents the various ways in which the SCORM Player can rollup status to the course level. The possible values are:
status provided by course - Useful for single-SCO courses, this parameter simply transfers the status provided by the first SCO in the course to the course-level.
complete when all units complete - The course is considered complete when all of the SCOs have achieved completion. This means that the lesson status value is either failed, completed or passed.
complete when all units satisfactorily complete - The course is considered complete when all of the SCOs have achieved completion in a satisfactory manner. This means that the lesson status value is either completed or passed.
complete when threshold score is met - The course is considered complete when its rolled up score (as determined by the Score Rollup Type) exceeds a certain threshold (specified in the Threshold Score For Completion parameter).
complete when all units complete and threshold score is met - This course is considered complete when all of the SCOs have achieved completion (lesson status = failed, completed, or passed) and when its rolled up score exceeds the threshold specified in the Threshold Score For Completion parameter.
Represents the various ways to handle menu item options that are not valid
show - Invalid menu items are visible but will result in an invalid action message.
hide - Invalid menu items are not visible.
disable - Invalid menu items are visible but do nothing.
Represents when to reset runtime data
never - SCORM Engine will never reset CMI runtime data.
when exit is not suspend - Only preserves CMI runtime data if exit is suspend.
on each new sequencing attempt - The SCORM engine will reset the CMI runtime data every time the SCORM 2004 sequencing algorithms dictate that a new attempt should begin.
The table below lists the default value for all SCORM Engine metadata parameters.
|
The SCORM Engine Meta-Data Extensions |
||
|
Number |
Name |
Default Value |
|
1 |
Controls |
|
|
1.1 |
Show Finish Button |
yes |
|
1.2 |
Show Help |
yes |
|
1.3 |
Show Progress Bar |
yes |
|
1.4 |
Show Course Structure |
yes |
|
1.5 |
Course Structure Starts Open |
yes |
|
1.6 |
Show Navigation Bar |
yes |
|
1.7 |
Show Title Bar |
yes |
|
1.8 |
Enable Flow Navigation |
yes |
|
1.9 |
Enable Choice Navigation |
yes |
|
1.10 |
Status Display Type |
separate (SCORM 2004), combined (SCORM 1.1, 1.2, AICC) |
|
2 |
Appearance |
|
|
2.1 |
Display Stage |
|
|
2.1.1 |
Desired |
|
|
2.1.1.1 |
Width |
400 |
|
2.1.1.2 |
Height |
453 |
|
2.1.1.3 |
Full Screen |
no |
|
2.1.2 |
Required |
|
|
2.1.2.1 |
Width |
0 |
|
2.1.2.2 |
Height |
0 |
|
2.1.2.3 |
Full Screen |
no |
|
2.2 |
Course Structure Width |
300 |
|
3 |
Behavior |
|
|
3.1 |
Launch |
|
|
3.1.1 |
SCO |
frameset |
|
3.1.2 |
Player |
new window |
|
3.1.3 |
Wrap SCO Window With API |
no |
|
3.2 |
Exit Actions |
|
|
3.2.1 |
Intermediate SCO |
|
|
3.2.1.1 |
Satisfied |
|
|
3.2.1.1.1 |
Normal |
continue |
|
3.2.1.1.2 |
Suspend |
message page |
|
3.2.1.1.3 |
Timeout |
message page |
|
3.2.1.1.4 |
Logout |
exit,confirmation |
|
3.2.1.2 |
Not Satisfied |
|
|
3.2.1.2.1 |
Normal |
message page |
|
3.2.1.2.2 |
Suspend |
message page |
|
3.2.1.2.3 |
Timeout |
message page |
|
3.2.1.2.4 |
Logout |
exit,confirmation |
|
3.2.2 |
Final SCO |
|
|
3.2.2.1 |
Satisfied |
|
|
3.2.2.1.1 |
Normal |
message page |
|
3.2.2.1.2 |
Suspend |
message page |
|
3.2.2.1.3 |
Timeout |
message page |
|
3.2.2.1.4 |
Logout |
exit,no confirmation |
|
3.2.2.2 |
Not Satisfied |
|
|
3.2.2.2.1 |
Normal |
message page |
|
3.2.2.2.2 |
Suspend |
message page |
|
3.2.2.2.3 |
Timeout |
message page |
|
3.2.2.2.4 |
Logout |
exit,no confirmation |
|
3.3 |
Disable Right Click |
no |
|
3.4 |
Prevent Window Resize |
no |
|
3.5 |
Score Rollup Mode |
average score of all units with scores |
|
3.6 |
Number of Scoring Objects |
|
|
3.7 |
Status Rollup Mode |
complete when all units satisfactorily complete |
|
3.8 |
Threshold Score for Completion |
|
|
3.9 |
First SCO Is Pretest |
no |
|
3.10 |
Finish Causes Immediate Commit |
no |
|
3.11.1 |
Control Audit |
specified in web.config |
|
3.11.2 |
Control Detailed |
specified in web.config |
|
3.11.3 |
Runtime Audit |
specified in web.config |
|
3.11.4 |
Runtime Detailed |
specified in web.config |
|
3.11.5 |
Sequencing Audit |
specified in web.config |
|
3.11.6 |
Sequencing Detailed |
specified in web.config |
|
3.11.7 |
Lookahead Audit |
specified in web.config |
|
3.11.8 |
Lookahead Detailed |
specified in web.config |
|
3.11.9 |
Include Timestamps |
specified in web.config |
|
3.12.1 |
Max Failed Submissions |
2 |
|
3.12.2 |
Commit Frequency |
10000 (10 seconds) |
|
3.13 |
Invalid Menu Item Action |
disable |
|
3.14 |
Always Flow To First Sco |
Single SCO yes, Multiple SCOs no |
|
3.15 |
Logout Causes Player Exit |
yes |
|
3.16 |
Reset RT Time |
when exit is not suspend (SCORM 2004), never (SCORM 1.1, 1.2, AICC) |
The SCORM Engine extensions are specified within the top-level meta-data section of the manifest which affects the manifest as a whole. The extension elements are placed in the technical element of standard SCORM metadata in a container element called HSTMConfiguration. The directory that holds the file you are reading also contains a sample metadata document along with an XML Schema (xsd) describing the XML binding of these parameters (which you can use to validate the format of your extensions). When including these extensions, pay special attention to the namespace declarations at the top of the sample meta-data file and the hstm prefix on the HSTMConfiguration element. These declarations are necessary to preserve SCORM compatibility.
|
|
|
|
