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

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

ApiRollup

ApiRollupRegistrationPostBackUrl

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

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

User name to use when posting registration data.

ApiRollupRegistrationAuthPassword

Password to use when posting registration data.

ApiRollupRegistrationFormat

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

Should rollup registration postbacks be sent during a learning session, instead of
waiting for the learner to exit?.

LaunchAuth

LaunchAuthType

The type of authentication scheme to use when launching content

LaunchAuthExpiry

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

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

Tells if fingerprint validation should be enabled or disabled

LaunchAuthIpAddress

Tells if IP address validation should be enabled or disabled

PlayerNavigation

PlayerShowFinishButton

Specifies whether the interface should show a button that allows the learner to
return to the LMS

PlayerShowCloseItem

Specifies whether the interface should show a button that allows the learner to exit
the SCO

PlayerShowHelp

Specifies whether the interface should show a help button

PlayerShowProgressBar

Specifies whether the interface should show a progress bar

PlayerUseMeasureProgressBar

Specifies whether the interface should determine progress bar progress using Measure
Rollup or individual SCO completion.

PlayerShowCourseStructure

Specifies whether the interface should show the course outline to the learner

PlayerCourseStructureStartsOpen

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

Specifies whether the interface should show the navigation bar containing buttons
like Prev, Next, Exit, etc

PlayerShowTitleBar

Specifies whether the interface should show the title bar containing the name of the
package being delivered

PlayerEnableFlowNav

Specifies whether the interface should allow the learner to use Previous and Next
navigation elements to go through the course

PlayerEnableChoiceNav

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

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

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

Specifies the method of disabling items in the course outline which for which a
request would not succeed.

SuppressNavbarWhenForcedFrameset

When enabled, prevents the navbar from showing for requests with the forceFrameset
parameter

PlayerLaunchBehavior

PlayerDesiredWidth

The number of pixels in width the course would like to have available, if possible,
during delivery.

PlayerDesiredHeight

The number of pixels in height the course would like to have available, if possible,
during delivery.

PlayerDesiredFullScreen

Specifies that the course is best experienced when it occupies the full screen.

PlayerRequiredWidth

The number of pixels in width the course must occupy to function correctly.

PlayerRequiredHeight

The number of pixels in height the course must occupy to function correctly.

PlayerRequiredFullScreen

Specifies that the course must be experienced in full screen mode to function
correctly.

PlayerScoLaunchType

Specifies how the individual parts of the course should be launched

PlayerLaunchType

Specifies how the player as a whole should be launched for this course.

PlayerPreventWindowResize

Specifies whether the player should allow the learner to resize its windows.

PlayerRudimentarySequencing

PlayerIntermediateScoSatisfiedNormalExitAction

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.

PlayerIntermediateScoSatisfiedSuspendExitAction

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.

PlayerIntermediateScoSatisfiedTimeoutExitAction

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.

PlayerIntermediateScoSatisfiedLogoutExitAction

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.

PlayerIntermediateScoNotSatisfiedNormalExitAction

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.

PlayerIntermediateScoNotSatisfiedSuspendExitAction

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.

PlayerIntermediateScoNotSatisfiedTimeoutExitAction

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.

PlayerIntermediateScoNotSatisfiedLogoutExitAction

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.

PlayerFinalScoCourseSatisfiedNormalExitAction

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.

PlayerFinalScoCourseSatisfiedSuspendExitAction

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.

PlayerFinalScoCourseSatisfiedTimeoutExitAction

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.

PlayerFinalScoCourseSatisfiedLogoutExitAction

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.

PlayerFinalScoCourseNotSatisfiedNormalExitAction

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.

PlayerFinalScoCourseNotSatisfiedSuspendExitAction

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.

PlayerFinalScoCourseNotSatisfiedTimeoutExitAction

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.

PlayerFinalScoCourseNotSatisfiedLogoutExitAction

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.

PlayerRudimentaryRollup

PlayerStatusDisplayPreference

Specifies how the player should display the completion and success status of
individual SCOs.

PlayerScoreRollupModeValue

Specifies how the player should rollup scores from individual SCOs to aggregations in
SCORM 1.2

PlayerScoreRollupModeNumberOfScoringObjects

Specifies how the player should rollup scores from individual SCOs to aggregations in
SCORM 1.2

PlayerStatusRollupModeValue

Specifies how the player should rollup completion status from individual SCOs to
aggregations in SCORM 1.2

PlayerStatusRollupModeThresholdScore

Specifies how the player should rollup completion status from individual SCOs to
aggregations in SCORM 1.2

PlayerApplyRollupStatusToSuccess

Specifies whether the success status should be updated based on the rudimentary
status rollup rules.

PlayerFirstScoIsPretest

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

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

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

Should the SCP always launch the first SCO when the course is launched regardless of
sequencing rules.

PlayerLogoutCausesPlayerExit

Should the SCP allow a cmi.exit request of logout to exit the entire player

PlayerResetRunTimeData

Should the SCP always persist runtime data when the exit type is suspend, or should
this be left up to the sequencer?

PlayerValidateInteractionResponses

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

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.

PlayerScoreOverridesStatus

Determines whether or not the status derived from a score should override the actual
status.

PlayerAllowCompleteStatusChange

Determines whether or not the lesson status can be modified once it has been set to
complete.

PlayerScaleRawScore

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

In SCORM 2004, determines whether a set of child activities in an unknown state
rollup to "unknown" or "complete/satisfied"

PlayerReturnToLmsAction

Defines what happens when a user click "Return To LMS"

PlayerUseQuickLookaheadSequencer

In SCORM 2004 4th Edition and later, determines whether or not to use the Quick
Lookahead Sequencer

PlayerForceDisableRootChoice

Disables the Root menu item Choice option. This is to prevent new attempts being
initiated on the course.

PlayerRollupRuntimeAtScoUnload

Initiates rollup and transfer of runtime data at ScoUnload for all SCOs.

PlayerForceObjectiveCompletionSetByContent

Override the manifest settings for "Objective Set By Content" and "Completion Set By
Content" with true values.

PlayerInvokeRollupAtSuspendAll

Initiates rollup when SuspendAll is invoked.

PlayerCompletionStatOfFailedSuccessStat

Specifies the Completion Status value to apply in the case of a Failed Success
Status. Only applied if set to "completed" or "incomplete"

PlayerSatisfiedCausesCompletion

Determines whether or not activity Satisfaction will set completion

PlayerMakeStudentPrefsGlobalToCourse

When a student makes a preference (audio volume, etc) the preference should be
applied to all SCOs

PlayerLaunchCompletedRegsAsNoCredit

Determines whether an AICC or SCORM 1.2 registrations goes into "no credit" mode upon
completion

PlayerSuspendDataMaxLength

Maximum suspend data length in bytes.

PlayerTimeLimit

Time limit of the course in minutes, 0 for unlimited (no time limit)

PlayerIsCompletionTracked

Does this course package actually report completion in a meaningful way?

PlayerIsSatisfactionTracked

Does this course package actually report satisfaction (pass/fail) in a meaningful
way?

PlayerIsScoreTracked

Does this course package actually report its score in a meaningful way?

PlayerIsIncompleteScoreMeaningful

If the course is incomplete, is the score still meaningful?

PlayerIsIncompleteSatisfactionMeaningful

If the course is incomplete, is its satisfaction (pass/fail) still meaningful?

PlayerDebug

PlayerDebugControlAudit

Should the debugger capture control data at the audit level

PlayerDebugControlDetailed

Should the debugger capture control data at the detailed level

PlayerDebugRteAudit

Should the debugger capture RunTime data at the audit level

PlayerDebugRteDetailed

Should the debugger capture RunTime data at the detailed level

PlayerDebugSequencingAudit

Should the debugger capture Sequencing data at the audit level

PlayerDebugSequencingDetailed

Should the debugger capture Sequencing data at the detailed level

PlayerDebugSequencingSimple

Capture sequencing debugging information in a more human readable fashion than the
very technical Audit or Detailed level

PlayerDebugLookAheadAudit

Should the debugger capture LookAhead Sequencing data at the audit level

PlayerDebugLookAheadDetailed

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

Should debug information include timestamps and measurements of how long individual
functions are taking for performance monitoring

PlayerCaptureHistory

Specifies if the course should return attempt information to the server

PlayerCaptureHistoryDetailed

Specifies if the course should return detailed attempt information to the server

PlayerCommunication

PlayerCommCommitFrequency

The frequency (in milliseconds) with which the application will check for dirty data
and try to send it to the server. This setting has a minimum value of 5000 and
maximum value 60000 milliseconds.

PlayerCommMaxFailedSubmissions

Specifies the maximum number of times the client to server communication can fail
before the system stops trying and the learner is notified that there is an error.
This setting has a maximum value of 20 failed submissions.

MediaContent

ContentLangToUrl

JSON string that represents a list of ContentLanguageDefinition objects. The
ContentLanguageDefinition obj contains the following keys: label (required string -
The displayed string that specifies the language), srclang (string - The ISO language
code associated with the language), src (required string - The URL to the .vtt file
content), default (bool - Is this the default language), and kind (string - Specifies
the type of support file. Expected values include "captions" and "subtitles")

MediaContentStylesheetPath

Web path (absolute or relative) to a CSS file that allows for customization of
elements in the Media Content AU that are not specific to a certain content type.

MediaContentCompletionThreshold

The percentage of media that must be consumed before a media course can be considered
'Complete'.

PDFContentStylesheetPath

Web path (absolute or relative) to a CSS file that allows for customization of
elements in the Media Content AU that are specific to PDF content.

PDFContentPageDurationThreshold

Number of seconds the user must view a document page before the page will be counted
towards progress/completion calculation.

AudioVideoContentStylesheetPath

Web path (absolute or relative) to a CSS file that allows for customization of
elements in the Media Content AU that are specific to Audio/Video content types.

AudioVideoPlayer

Specifies whether the video player should be a native html5 or video.js player.

CourseVersioning

WhenToRestartRegistration

Options for moving existing registrations to the latest version of a course. NOTE:
This configuration setting is only available at the Course level.