Configuration Options
xapi.ly provides some Configuration Options to add control some optional features.
If you're unsure, you can use the default settings and adjust later if needed.
Primary Settings
Field | Description | Type | Options | Default |
---|---|---|---|---|
Platform | This allows you to select your authoring tool, which might change the availability of some options below. | select | Storyline, Captivate | Storyline |
Allow Manual Sign-in | If no actor info is found in a launched course, allow a prompt to enter user name and email. | boolean | Deny, Allow | Allow |
Revision | You can modify this between revisions of content. | text | -- | 1.0.0 |
Language | This will set the Context language property for the statement overall. (This does not affect language maps for verb, activity, etc. Those are currently all en-US .) | text | -- | en-US |
Track Video | EXPERIMENTAL This will track video activity (play, pause, seek) based on the Video Profile. | boolean | No, Yes | No |
Track Resources | Storyline Only This will automatically track selected items (using 'viewed' verb) in the Storyline Resources panel. | boolean | No, Yes | Yes |
Extension Root ID | URL-formatted ID to use as the base for any custom extensions where a URL isn't identified. Otherwise, a default xapi.ly base ID will be used. | text | -- | -- |
Library Script Files | Storyline Only REMOTE: loads xapi.ly from remote CDN LOCAL: Requires manually including and referencing xapi.ly library in course files (possibly useful in certain regions or for security) | boolean | Remote, Local | Remote |
Sidecar LRS Settings
These options are specific to the LMS and Sidecar LRS publishing method.
Field | Description | Type | Options | Default |
---|---|---|---|---|
LRS | Select from a pre-configured LRS | select | (User defined) | 1st option |
Tracking Standard | The standard chosen for your course publish. For SCORM, you will likely want to define your Activity information, but for xAPI it pulls from the course settings. | select | SCORM, xAPI | SCORM |
SCORM Activity Information
If SCORM is selected as the Tracking Standard, these optional but recommended xAPI fields can be defined. Otherwise xapi.ly will try to read SCORM data, which may vary depending on your setup.
Field | Description | Type | Options | Default |
---|---|---|---|---|
Activity ID | URL-formatted ID that will be used as the primary activity ID | text | -- | -- |
Activity Name | Primary activity name | text | -- | -- |
Activity Description | Primary activity description | text | -- | -- |
Standalone LRS Settings
These options are specific to the Standalone publishing method.
Field | Description | Type | Options | Default |
---|---|---|---|---|
LRS | Select from a pre-configured LRS | select | (User defined) | 1st option |
Activity ID | URL-formatted ID that will be used as the primary activity ID | text | -- | -- |
Activity Name | Primary activity name | text | -- | -- |
Activity Description | Primary activity description | text | -- | -- |