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

FieldDescriptionTypeOptionsDefault
PlatformThis allows you to select your authoring tool, which might change the availability of some options below.selectStoryline, CaptivateStoryline
Allow Manual Sign-inIf no actor info is found in a launched course, allow a prompt to enter user name and email.booleanDeny, AllowAllow
RevisionYou can modify this between revisions of content.text--1.0.0
LanguageThis 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 VideoEXPERIMENTAL
This will track video activity (play, pause, seek) based on the Video Profileopen in new window.
booleanNo, YesNo
Track ResourcesStoryline Only

This will automatically track selected items (using 'viewed' verb) in the Storyline Resources panel.
booleanNo, YesYes
Extension Root IDURL-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 FilesStoryline 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)
booleanRemote, LocalRemote

Sidecar LRS Settings

These options are specific to the LMS and Sidecar LRS publishing method.

FieldDescriptionTypeOptionsDefault
LRSSelect from a pre-configured LRSselect(User defined)1st option
Tracking StandardThe 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.
selectSCORM, xAPISCORM

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.

FieldDescriptionTypeOptionsDefault
Activity IDURL-formatted ID that will be used as the primary activity IDtext----
Activity NamePrimary activity nametext----
Activity DescriptionPrimary activity descriptiontext----

Standalone LRS Settings

These options are specific to the Standalone publishing method.

FieldDescriptionTypeOptionsDefault
LRSSelect from a pre-configured LRSselect(User defined)1st option
Activity IDURL-formatted ID that will be used as the primary activity IDtext----
Activity NamePrimary activity nametext----
Activity DescriptionPrimary activity descriptiontext----
Last Updated:
Contributors: Matthew Kliewer