How to Upload xAPI (formerly Tin Can API) Content

Learn how to upload Tin Can content in your courses

Last Updated

October 25th, 2017

Reading Time

4 min

Version

User Level

Introduction

The xAPI (formerly Tin Can API) API is an E-learning software specification. This type of software allows learning content and learning systems to speak to each other in a way that records all types of learning experiences, which are then recorded in a Learning Record Store (LRS). An LRS can exist within traditional Learning Management Systems, or on their own. Docebo supports the Tin Can Standard 1.0.

In your platform, you can upload an xAPI package from your computer, or you can do so from an external link. Begin by logging into your platform as the Superadmin or as an Instructor. From the Admin Menu (the gear icon in the top right corner of your platform), find the Courses item in the E-Learning section.

tincan course

Find the course for which you would like to upload to the package in the list of courses, then press the menu icon in the course’s row. From the dropdown menu, select the Training Materials item. On the Training Materials page for this course, select the Add Training Material button on the right side of the page to upload content. Then, from the dropdown menu, select Tin Can.

Uploading xAPI Packages in your Docebo LMS

On the upload page page, there are two tabs: Tin Can and Additional Info. In the Tin Can tab, select Browse to choose the xAPI (Tin Can API) file from your computer. Below, flag whether you want to track all activities in the package. If checked (this is the default setting), the LMS will track ALL activity, including activities and sub-activities. If not flagged, only the main activities of the package will be tracked.

Then, while the file is uploading, move to the Additional Info tab to fill out a short description for your file and select a thumbnail. You can change the learning object’s title or thumbnail later, as desired.

tincan upload

Please remember that an xAPI (Tin Can) learning object must be imported as a zip package, and it cannot exceed 800MB. When you’re finished, press Save Changes. If the file format is correct, the xAPI package will be uploaded as course material, and a message will be displayed on the top left of your screen.

Linking xAPI Content as a Learning Object

Before you can link xAPI content as training material in a course, you must first create a predefined list of links in the LMS in order for your platform to be able to play the content for learners. To do so, access the Admin Menu, then select the Advanced Settings option from the Settings section. Then, access the E-Learning tab.

tincan links

In the xAPI External Content section, add the link of the object of the corresponding text field, then press Add. It will then appear in the list below. Then, press Save. If you want to add a salt secret to the link, return to the xAPI External Content section, find the link and press the lock icon in the link’s row. Add and confirm the salt secret and press the check mark. Then, press Save again.

If you do not add the salt secret to the link, it will enable the third party to work like normal xAPI content launched from your platform. By providing the salt secret, this will validate a call out, adding a “checksum” of the parameters and salt secret, which makes the third party available to validate the content’s launch.

Once you’ve added the link, return to the Training Materials page for a course (see instructions above, if necessary). Then, select Tin Can from the Training Materials dropdown menu. On the upload page, flag the From URL option. Then, choose a URL from the Select URL dropdown menu. These are all of the links that you added in the Advanced Settings area of the platform.

tincan add link

Below, flag whether you want to track all activities in the package. If checked (this is the default setting), the LMS will track ALL activity, including activities and sub-activities. If not flagged, only the main activities of the package will be tracked. Then, add a title and description of the content in the corresponding text fields, and move to the Additional Info tab. Fill out a short description for your file and select a thumbnail. You can change the learning object’s description or thumbnail later, as desired.

Lastly, move to the Enhanced Security tab, flag the option to add an OAuth code to the launch URL, then select the OAuth client from the corresponding dropdown menu. Then, press Save Changes to create your learning object.

Managing Learning Object Settings

Once the object has been uploaded, you can manage the additional settings. Press the menu icon in the content’s row, then select Settings.

tincan settings

In the pop up box, decide if the learning object is visible or hidden, the publishing timeframe, how many times the users are able to see the Learning Object (not completed/passed, infinite times or just one time), and the dimensions and launch modeof the object. Press Save Changes when finished.

Best Practices for xAPI/Tin Can Content in Docebo

Please Note: If you want to track your xAPI (Tin Can) package remotely, you need to upload the package directly into your LMS. Your Docebo LMS does not support completely anonymous tracking. If you want to send xAPI (Tin Can) statements to our platform, you can do so using the following link format: https://www.lmsaddress.com/tcapi/

While you are able to upload xAPI (Tin Can) packages directly into the Central Learning Object Repository (CLOR), we suggest you upload them directly into a course. You can push them into the CLOR after uploading them into the course, if desired.

Share on Facebook0Tweet about this on TwitterShare on Google+0Share on LinkedIn0Email this to someone