xAPI (sometimes called TinCan) stands for Experience API. Like SCORM, it is a standard that is used to track learner data. However, where a traditional SCORM package can only track two actions—whether the learner has completed the course, and whether they have passed—xAPI is designed to capture detailed data about the learner's experience as well as their overall result.
xAPI data is reported to a Learning Record Store (LRS). Without an LRS, you won't be able to view your xAPI data. Using an LRS is useful if you want to examine the data holistically with other sources of learning or use your existing data analysis tools. Some LMSs have their own LRSs built in; some LRSs are standalone applications that run independently.
See Supported xAPI verbs in Elucidat to learn more about the actions you can track with xAPI.
Note: Elucidat’s xAPI tracking is primarily intended to be used with an Online Link release type, so that users without an LMS can gather additional analytics data via an LRS. However, the xAPI feature will also work with the SCORM for LMS release type. A SCORM release which also uses xAPI tracking is intended to send SCORM data to the LMS, and send xAPI to your separate LRS. For more information about the different release types, see Deciding which release mode is right for your Project. |
Contents:
2. Configuring your Project to use TinCan mode
i. If you plan to use the Online Link release option
ii. If you plan to use the SCORM for LMS release option
Before you begin
Set up your LRS
In order to view your xAPI data, you'll need to:
- have an LRS to direct it to; and
- have the LRS endpoint and credentials ready to add to your course
Tip: If you don’t have an LRS, you can use SCORM Cloud's LRS functionality to recieve xAPI data. See Using SCORM Cloud's LRS for xAPI learner data reporting for a tutorial on how to do this. |
Obtain LRS details
Before you set up xAPI tracking, you need to collect details from your LRS.
The details you’ll need from your LRS are:
- The LRS endpoint URL—this is where your course will send learner information.
- The LRS username—if your LRS requires credentials to connect, then this is the username provided by the LRS.
- The LRS password—if your LRS requires credentials to connect, then this is the password that corresponds to the username provided by your LRS, referenced above.
You may be able to get this information yourself if you are responsible for the LRS. If you aren’t, you will need to speak to whomever manages your LRS to obtain these details.
Once you have these details, you are ready to begin setting up your course to report xAPI data.
Configuring your Project to report xAPI data
1. Open your Project.
2. Select the Configure tab
3. Select Learner tracking
If you plan to use the Online Link release option
1. Select xAPI/TinCan 1.0 from the Tracking mode dropdown
2. Add the endpoint URL to the LRS Endpoint URL field and add 'statements' the to the end. It should look something like this:
https://cloud.scorm.com/lrs/FOEMWG2YH6/statements
3. Add the username to the LRS Username field
4. Add the password to the LRS Password field
It is best to copy and paste these details as they can be quite complex; pasting them in avoids any typing errors.
5. Set the Learner access control to Identify
6. Select Save changes to save your configuration
Caution: Using xAPI/TinCan mode requires the Identify option to be enabled. If this is not enabled, your statements will not be reported to your LRS. |
If you plan to use the SCORM for LMS release option
1. Choose your preferred SCORM format from the tracking mode drop down menu:
2. Check the box labelled Add xAPI/TinCan 1.0
Add the endpoint URL to the LRS Endpoint URL field and add 'statements' the to the end. It should look something like this:
https://cloud.scorm.com/lrs/FOEMWG2YH6/statements
4.. Add the username to the LRS Username field
5. Add the password to the LRS Password field
6. Select Save changes to save your configuration