API Configuration Settings

Configuration in SCORM Cloud


Our V2 API has brought a big overhaul to the configuration of both the player and postbacks in SCORM Cloud. Now these settings can be set at any one of multiple levels in SCORM Cloud’s application hierarchy. This means that, for example, you could set your postback url at the level of your application id, and (as long as it’s not set at any more specific level) that would mean that any registrations launched in that application will assume the postback url set at the application level.

To make things a little clearer, lets break down each of the levels:

  • default - This is the system wide default set by SCORM Cloud itself
  • application - /appManagement/configuration
  • learningStandardForApplication - /appManagement/configuration with learningStandard specified
  • course - /courses/{course ID}/configuration
  • dispatch - Dispatch currently only has support for postback configuration (no player configuration) in the settings cascade. As such, a configuration endpoint is not yet available. Dispatch specific settings including postback settings can be set during calls to createDispatches and updateDispatch
  • registration - /registrations/{registration ID}/configuration

Now, any time a registration needs part of its configuration (like the postback url we mentioned above) it will crawl up the levels until it finds something it can use. Beginning with the registration level, and crawling up to dispatch (if the registration is a dispatch), then course etc.

This should hopefully save lots of copying course configuration and postback settings around and allow you to set things in a more logical arrangement, which better suits the way you use SCORM Cloud.

API Configuration


The semantics for each of the resources with a configuration endpoint are mostly identical. In each instance setting configuration is as easy as a POST request to the appropriate endpoint with a JSON payload like this:

{
    "settings": [
        { 
            "settingId": "PlayerScoLaunchType", 
            "value": "NEW_WINDOW", 
            "explicit": false 
        }
    ]
}

Since the settings parameter is an array, you may specify multiple configuration values at once.

A note on the optional explicit parameter:

The optional parameter explicit is a boolean which signifies if you want to explicitly set the provided setting at that level even if that is already the ‘effective’ setting at that level. It is important to note that the default for this value is false. This means that if, for instance, you made the same request as the above example at the registration level, while the course level already had PlayerScoLaunchType set to NEW_WINDOW: no actual change will take place. This is an intentional design to prevent the needless duplicating of settings across levels of the application.

Settings Reference


Note: Level Specificity is the configuration level which is the most specific possible level for that setting. For instance, if a setting has a Level Specificity of course, then that setting will have no meaning or effect if one attempts to apply it at the registration level.

Api


ApiImportResultsPostBackUrl

Type Level Specificity
secretString system
Specifies a URL to which to post import results, will convert
username:password@hostname to basic authentication if provided.




ApiRollup


ApiRollupRegistrationPostBackUrl

Type Level Specificity
string registration
Specifies a URL to which to post activity and status data within an interval in which
dirty data is available or as soon as possible when the course is completed.


ApiRollupRegistrationAuthType

Type Level Specificity Default
string registration httpbasic
Indicates how to authorize against the given postbackurl, can be 'form' or
'httpbasic'. If form authentication, the username and password for authentication are
submitted as form fields 'username' and 'password', and the registration data as the
form field 'data'. If httpbasic authentication is used, the username and password are
placed in the standard Authorization HTTP header, and the registration data is the
body of the message. This field is set to 'httpbasic' by default.


ApiRollupRegistrationAuthUser

Type Level Specificity
string registration
User name to use when posting registration data.


ApiRollupRegistrationAuthPassword

Type Level Specificity
secretString registration
Password to use when posting registration data.


ApiRollupRegistrationFormat

Type Level Specificity Default
string registration activity
Level of detail in the information that provided when posting registration data. It
may be one of three values: 'course' (course summary), 'activity' (activity summary,
or 'full' (full detail), and is set to 'activity' by default. The information will be
posted as JSON, using the schemas for the registration /progress or /progress/detail
resources depending on the format selected, with an additional wrapper specifying the
registration ID.


ApiRollupRegistrationDuringSession

Type Level Specificity Default
bool registration true
Should rollup registration postbacks be sent during a learning session, instead of
waiting for the learner to exit?.




LaunchAuth


LaunchAuthType

Type Level Specificity Default
Enum registration COOKIES
The type of authentication scheme to use when launching content
Value Description
COOKIES Use browser cookies for launch authorization
VAULT Use ContentVault for launch authorization


LaunchAuthExpiry

Type Level Specificity Default
int registration 28800
An integer value greater than 300 seconds and less than 31540000 seconds that defines
the number of seconds content should be made available for a launch


LaunchAuthSlidingExpiry

Type Level Specificity Default
int registration 60
An integer value greater than 60 seconds and less than 31540000 seconds that defines
how large the 'sliding window' of content should be available


LaunchAuthFingerprint

Type Level Specificity Default
bool registration true
Tells if fingerprint validation should be enabled or disabled


LaunchAuthIpAddress

Type Level Specificity Default
bool registration true
Tells if IP address validation should be enabled or disabled




PlayerNavigation


PlayerShowFinishButton

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show a button that allows the learner to
return to the LMS


PlayerShowCloseItem

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show a button that allows the learner to exit
the SCO


PlayerShowHelp

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show a help button


PlayerShowProgressBar

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show a progress bar


PlayerUseMeasureProgressBar

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should determine progress bar progress using Measure
Rollup or individual SCO completion.


PlayerShowCourseStructure

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show the course outline to the learner


PlayerCourseStructureStartsOpen

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show the course outline when the course loads
or if it should initially be collaspsed and hidden. Only valid if ShowCourseStructure
is true.


PlayerShowNavBar

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show the navigation bar containing buttons
like Prev, Next, Exit, etc


PlayerShowTitleBar

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should show the title bar containing the name of the
package being delivered


PlayerEnableFlowNav

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should allow the learner to use Previous and Next
navigation elements to go through the course


PlayerEnableChoiceNav

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the interface should allow the learner to choose specific parts to
the course to take in any order from the course outline


PlayerCourseStructureWidth

Type Level Specificity
nonNegativeInt registration
Specifies the default width in pixels for the course outline when shown in the legacy
player. This setting does not apply to the modern player.


PlayerPreventRightClick

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the player should allow the learner to right click within its
frames. This setting can add a small measure of security to the application by making
it harder to view the source.


PlayerInvalidMenuItemAction

Type Level Specificity
Enum registration
Specifies the method of disabling items in the course outline which for which a
request would not succeed.
Value Description
SHOW Show the menu item and have it fully enabled
HIDE Hide the menu item completely
DISABLE Show the menu item, but disable its link


SuppressNavbarWhenForcedFrameset

Type Level Specificity Default
bool registration false
When enabled, prevents the navbar from showing for requests with the forceFrameset
parameter




PlayerLaunchBehavior


PlayerDesiredWidth

Type Level Specificity
nonNegativeInt registration
The number of pixels in width the course would like to have available, if possible,
during delivery.


PlayerDesiredHeight

Type Level Specificity
nonNegativeInt registration
The number of pixels in height the course would like to have available, if possible,
during delivery.


PlayerDesiredFullScreen

Type Level Specificity Default
bool registration UNDEFINED
Specifies that the course is best experienced when it occupies the full screen.


PlayerRequiredWidth

Type Level Specificity
nonNegativeInt registration
The number of pixels in width the course must occupy to function correctly.


PlayerRequiredHeight

Type Level Specificity
nonNegativeInt registration
The number of pixels in height the course must occupy to function correctly.


PlayerRequiredFullScreen

Type Level Specificity Default
bool registration UNDEFINED
Specifies that the course must be experienced in full screen mode to function
correctly.


PlayerScoLaunchType

Type Level Specificity
Enum registration
Specifies how the individual parts of the course should be launched
Value Description
FRAMESET Display the player or SCO in a child frameset.
NEW_WINDOW Display the player or SCO in a popup window.
NEW_WINDOW_AFTER_CLICK Display the player or SCO in a popup window after prompting the user to click a link to avoid popup blocker restrictions.
NEW_WINDOW_WITHOUT_BROWSER_TOOLBAR Display the player or SCO in a popup window (without toolbar).
NEW_WINDOW_AFTER_CLICK_WITHOUT_BROWSER_TOOLBAR Display the player or SCO in a popup window (without toolbar) after prompting the user to click a link to avoid popup blocker restrictions.


PlayerLaunchType

Type Level Specificity
Enum registration
Specifies how the player as a whole should be launched for this course.
Value Description
FRAMESET Display the player or SCO in a child frameset.
NEW_WINDOW Display the player or SCO in a popup window.
NEW_WINDOW_AFTER_CLICK Display the player or SCO in a popup window after prompting the user to click a link to avoid popup blocker restrictions.
NEW_WINDOW_WITHOUT_BROWSER_TOOLBAR Display the player or SCO in a popup window (without toolbar).
NEW_WINDOW_AFTER_CLICK_WITHOUT_BROWSER_TOOLBAR Display the player or SCO in a popup window (without toolbar) after prompting the user to click a link to avoid popup blocker restrictions.


PlayerPreventWindowResize

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the player should allow the learner to resize its windows.




PlayerRudimentarySequencing


PlayerIntermediateScoSatisfiedNormalExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has been satisfied in
the middle of a course exits with an exit type of normal.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoSatisfiedSuspendExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has been satisfied in
the middle of a course exits with an exit type of suspend.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoSatisfiedTimeoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has been satisfied in
the middle of a course exits with an exit type of timeout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoSatisfiedLogoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has been satisfied in
the middle of a course exits with an exit type of logout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoNotSatisfiedNormalExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO in the middle of a course
that has not been satisfied exits with an exit type of normal.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoNotSatisfiedSuspendExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has not been satisfied
in the middle of a course exits with an exit type of suspend.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoNotSatisfiedTimeoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has not been satisfied
in the middle of a course exits with an exit type of timeout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerIntermediateScoNotSatisfiedLogoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO that has not been satisfied
in the middle of a course exits with an exit type of logout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseSatisfiedNormalExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has been satisfied exits with an exit type of normal.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseSatisfiedSuspendExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has been satisfied exits with an exit type of suspend.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseSatisfiedTimeoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has been satisfied exits with an exit type of timeout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseSatisfiedLogoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has been satisfied exits with an exit type of logout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseNotSatisfiedNormalExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has not been satisfied exits with an exit type of normal.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseNotSatisfiedSuspendExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has not been satisfied exits with an exit type of suspend.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseNotSatisfiedTimeoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has not been satisfied exits with an exit type of timeout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action


PlayerFinalScoCourseNotSatisfiedLogoutExitAction

Type Level Specificity
Enum registration
The navigation behavior the SCP should display when a SCO at the end of the course
that has not been satisfied exits with an exit type of logout.
Value Description
EXIT_COURSE Exit the entire course player
EXIT_COURSE_AFTER_CONFIRM Exit the entire course player after asking the learner’s permission
GO_TO_NEXT_SCO Immediately go to the next SCO
DISPLAY_MESSAGE Display a status message to the learner
DO_NOTHING Do not take any action




PlayerRudimentaryRollup


PlayerStatusDisplayPreference

Type Level Specificity
Enum registration
Specifies how the player should display the completion and success status of
individual SCOs.
Value Description
SUCCESS_ONLY Only display an icon to represent the success status of the activity.
COMPLETION_ONLY Only display an icon to represent the completion status of the activity.
SEPARATE Display two icons, one to represent the completion status of the activity, another to represent the success status.
COMBINED Display a single icon that represents both the success and completion status of an activity.
NONE Do not display any status representation icons.


PlayerScoreRollupModeValue

Type Level Specificity
Enum registration
Specifies how the player should rollup scores from individual SCOs to aggregations in
SCORM 1.2
Value Description
SCORE_PROVIDED_BY_COURSE For use with single SCO courses, uses whatever score is provided by the SCO.
AVERAGE_SCORE_OF_ALL_UNITS Adds up all reported scores and divides by the number of SCOs in the course.
AVERAGE_SCORE_OF_ALL_UNITS_WITH_SCORES Adds up all reported scores and divides by the number of SCOs that actually reported a score.
FIXED_AVERAGE Adds up all reported scores and divides by a fixed number.
AVERAGE_SCORE_OF_ALL_UNITS_WITH_NONZERO_SCORES Adds up all reported scores and divides by the number of SCOs that reported a score greater than zero.
LAST_SCO_SCORE Use the score of the last SCO.


PlayerScoreRollupModeNumberOfScoringObjects

Type Level Specificity
int registration
Specifies how the player should rollup scores from individual SCOs to aggregations in
SCORM 1.2


PlayerStatusRollupModeValue

Type Level Specificity
Enum registration
Specifies how the player should rollup completion status from individual SCOs to
aggregations in SCORM 1.2
Value Description
STATUS_PROVIDED_BY_COURSE For use with single SCO courses, just takes whatever status is reported by the course.
COMPLETE_WHEN_ALL_UNITS_COMPLETE Marks the course complete whenever all of the SCOs are complete, even if the SCO is failed.
COMPLETE_WHEN_ALL_UNITS_COMPLETE_AND_NOT_FAILED Marks the course complete whenever all of the SCOs are complete and not failed.
COMPLETE_WHEN_THRESHOLD_SCORE_IS_MET Marks the course complete whenever a certain score has been obtained as calculated by the Score Rollup Method.
COMPLETE_WHEN_ALL_UNITS_COMPLETE_AND_THRESHOLD_SCORE_IS_MET Marks the course complete whenever all of the SCOs are complete and not failed and a certain score has been obtained as calculated by the Score Rollup Method.
COMPLETE_WHEN_ALL_UNITS_ARE_PASSED Marks the course complete whenever all of the SCOs are satisfied(passed). In 1.2, any SCO that is passed will also be complete (but not necessarily the other way around).


PlayerStatusRollupModeThresholdScore

Type Level Specificity
nullableDouble registration
Specifies how the player should rollup completion status from individual SCOs to
aggregations in SCORM 1.2


PlayerApplyRollupStatusToSuccess

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the success status should be updated based on the rudimentary
status rollup rules.


PlayerFirstScoIsPretest

Type Level Specificity Default
bool registration UNDEFINED
Specifies whether the first SCO in the course should be considered a pretest. If true
and the first SCO is passed, the rest of the course will be marked as completed.




PlayerCompatibility


PlayerWrapScoWindowWithApi

Type Level Specificity Default
bool registration UNDEFINED
When a SCO is launched in a new window, this specifies whether the window should be
wrapped with a shell window containing a copy of the SCORM API. This setting allows
content with errors in the use of its API finder algorithm to still be delivered in a
new window. Essentially, this mimics the structure of the ADL Test Suite.


PlayerFinishCausesImmediateCommit

Type Level Specificity Default
bool registration UNDEFINED
This setting forces data to be sent to the server immediately upon the call of
LMSFinish or Terminate by the SCO. Can be useful for SCOs that are not completing
because of timing issues related to window closing.


PlayerAlwaysFlowToFirstSco

Type Level Specificity Default
bool registration UNDEFINED
Should the SCP always launch the first SCO when the course is launched regardless of
sequencing rules.


PlayerLogoutCausesPlayerExit

Type Level Specificity Default
bool registration UNDEFINED
Should the SCP allow a cmi.exit request of logout to exit the entire player


PlayerResetRunTimeData

Type Level Specificity
Enum registration
Should the SCP always persist runtime data when the exit type is suspend, or should
this be left up to the sequencer?
Value Description
NEVER Never reset the runtime data
WHEN_EXIT_IS_NOT_SUSPEND Use the RunTime data’s exit flag to determine when to reset the data
ON_EACH_NEW_SEQUENCING_ATTEMPT Reset the data whenever a new sequencing attempt begins


PlayerValidateInteractionResponses

Type Level Specificity Default
bool registration UNDEFINED
Determines whether the interaction responses are validated for expected SCORM format.
 Use this setting when you want to include descriptive text in addition to the single
number/character allowed by SCORM 1.2.  This affects both the user response and the
correct response


PlayerLookaheadSequencerMode

Type Level Specificity
Enum registration
Determines how the Lookahead Sequencer should function on the client side. The
Lookahead Sequencer is used intelligently enable/disable activities and controls
within the Scorm Content Player based on possible future paths.
Value Description
DISABLED Completely Disabled
ENABLED Fully Enabled
REALTIME Enabled, with real-time status updates


PlayerScoreOverridesStatus

Type Level Specificity Default
bool registration UNDEFINED
Determines whether or not the status derived from a score should override the actual
status.


PlayerAllowCompleteStatusChange

Type Level Specificity Default
bool registration UNDEFINED
Determines whether or not the lesson status can be modified once it has been set to
complete.


PlayerScaleRawScore

Type Level Specificity Default
bool registration UNDEFINED
In SCORM 2004 content, if a SCO sets a raw score but not a scaled score, should the
raw score count as the normative score for the SCO?


PlayerRollupEmptySetToUnknown

Type Level Specificity Default
bool registration UNDEFINED
In SCORM 2004, determines whether a set of child activities in an unknown state
rollup to "unknown" or "complete/satisfied"


PlayerReturnToLmsAction

Type Level Specificity
Enum registration
Defines what happens when a user click "Return To LMS"
Value Description
Legacy Legacy - This likely would never be used unless you’re transitioning from Rustici Engine prior to 2008.
SuspendAll SUSPEND ALL Navigation Request
ExitAll EXIT ALL Navigation Request
Selectable Selectable by the user


PlayerUseQuickLookaheadSequencer

Type Level Specificity Default
bool registration UNDEFINED
In SCORM 2004 4th Edition and later, determines whether or not to use the Quick
Lookahead Sequencer


PlayerForceDisableRootChoice

Type Level Specificity Default
bool registration UNDEFINED
Disables the Root menu item Choice option. This is to prevent new attempts being
initiated on the course.


PlayerRollupRuntimeAtScoUnload

Type Level Specificity Default
bool registration UNDEFINED
Initiates rollup and transfer of runtime data at ScoUnload for all SCOs.


PlayerForceObjectiveCompletionSetByContent

Type Level Specificity Default
bool registration UNDEFINED
Override the manifest settings for "Objective Set By Content" and "Completion Set By
Content" with true values.


PlayerInvokeRollupAtSuspendAll

Type Level Specificity Default
bool registration UNDEFINED
Initiates rollup when SuspendAll is invoked.


PlayerCompletionStatOfFailedSuccessStat

Type Level Specificity
Enum registration
Specifies the Completion Status value to apply in the case of a Failed Success
Status. Only applied if set to "completed" or "incomplete"
Value Description
Unknown The completion status is unknown and has not been set yet. Note this is a different than the enumeration being undefined, which indicates that the enumeration itself is ‘null’
Completed The learner has completed the activity
Incomplete The learner has started, but not finished the activity
Browsed The learner viewed the activity, but just to browse it, not as an attempt
Not_Attempted The learner has not started the activity


PlayerSatisfiedCausesCompletion

Type Level Specificity Default
bool registration UNDEFINED
Determines whether or not activity Satisfaction will set completion


PlayerMakeStudentPrefsGlobalToCourse

Type Level Specificity Default
bool registration UNDEFINED
When a student makes a preference (audio volume, etc) the preference should be
applied to all SCOs


PlayerLaunchCompletedRegsAsNoCredit

Type Level Specificity Default
bool registration UNDEFINED
Determines whether an AICC or SCORM 1.2 registrations goes into "no credit" mode upon
completion


PlayerSuspendDataMaxLength

Type Level Specificity
nonNegativeInt registration
Maximum suspend data length in bytes.


PlayerTimeLimit

Type Level Specificity
nonNegativeInt registration
Time limit of the course in minutes, 0 for unlimited (no time limit)


PlayerIsCompletionTracked

Type Level Specificity Default
bool registration UNDEFINED
Does this course package actually report completion in a meaningful way?


PlayerIsSatisfactionTracked

Type Level Specificity Default
bool registration UNDEFINED
Does this course package actually report satisfaction (pass/fail) in a meaningful
way?


PlayerIsScoreTracked

Type Level Specificity Default
bool registration UNDEFINED
Does this course package actually report its score in a meaningful way?


PlayerIsIncompleteScoreMeaningful

Type Level Specificity Default
bool registration UNDEFINED
If the course is incomplete, is the score still meaningful?


PlayerIsIncompleteSatisfactionMeaningful

Type Level Specificity Default
bool registration UNDEFINED
If the course is incomplete, is its satisfaction (pass/fail) still meaningful?




PlayerDebug


PlayerDebugControlAudit

Type Level Specificity Default
bool registration true
Should the debugger capture control data at the audit level


PlayerDebugControlDetailed

Type Level Specificity Default
bool registration true
Should the debugger capture control data at the detailed level


PlayerDebugRteAudit

Type Level Specificity Default
bool registration true
Should the debugger capture RunTime data at the audit level


PlayerDebugRteDetailed

Type Level Specificity Default
bool registration true
Should the debugger capture RunTime data at the detailed level


PlayerDebugSequencingAudit

Type Level Specificity Default
bool registration true
Should the debugger capture Sequencing data at the audit level


PlayerDebugSequencingDetailed

Type Level Specificity Default
bool registration true
Should the debugger capture Sequencing data at the detailed level


PlayerDebugSequencingSimple

Type Level Specificity Default
bool registration true
Capture sequencing debugging information in a more human readable fashion than the
very technical Audit or Detailed level


PlayerDebugLookAheadAudit

Type Level Specificity Default
bool registration true
Should the debugger capture LookAhead Sequencing data at the audit level


PlayerDebugLookAheadDetailed

Type Level Specificity Default
bool registration false
Should the debugger capture LookAhead Sequencing data at the detailed level (use care
when setting this to true, it can have a noticable performance impact)


PlayerDebugIncludeTimestamps

Type Level Specificity Default
bool registration true
Should debug information include timestamps and measurements of how long individual
functions are taking for performance monitoring


PlayerCaptureHistory

Type Level Specificity Default
bool registration UNDEFINED
Specifies if the course should return attempt information to the server


PlayerCaptureHistoryDetailed

Type Level Specificity Default
bool registration UNDEFINED
Specifies if the course should return detailed attempt information to the server




PlayerCommunication


PlayerCommCommitFrequency

Type Level Specificity
nonNegativeInt registration
The frequency (in milliseconds) with which the application will check for dirty data
and try to send it to the server.