Overview

The Experience API (xAPI), also known as the Tin Can API, is an e-learning software specification that allows learning content and learning systems to speak to each other in a manner that records and tracks all types of learning experiences. Learning experiences are recorded in a Learning Record Store (LRS). Visit this link to find out more about how xAPI works. 

Our xAPI integration allows users to create statements (learning experiences) in MATRIX, which are later saved in your preferred LRS.

You can connect MATRIX LMS to an LRS, then start creating statements made from actors, verbs, and objects. All learning events are stored as statements in the LRS.

The xAPI integration is linked to our automation feature, so xAPI statements can be added everywhere in MATRIX where automation is enabled. For example, you can invoke an xAPI when creating new accounts, when learners finish courses, modules, assessments, learning paths, etc. You can also invoke an xAPI when learners achieve a certain score or drop below a certain level of competencies.

Configuring xAPI

To start using xAPI, go to Admin/App center and install xAPI. Then click on Configure to start setting up your options.

All the statements produced by our LMS will be saved in an LRS, so the first thing you have to do is connect our platform to your LRS (or an external one). We recommend for you to use Learning Locker if you try to set up your own LRS.

 To add an LRS, click Add from the top right.

Fill in the fields with the required information about the LRS, then click Save.

Here are a few notes regarding the fields:

To edit the LRS Server, click the Edit icon. To delete the LRS Server, click the Delete icon.

Adding actors, verbs, and objects

The Statement is the core of the xAPI. All learning events are stored as Statements. A Statement is akin to a sentence of the form "I did this".

A simple construct consisting of <actor (learner)> <verb> <object>, with <result>, in <context> to track an aspect of a learning experience. A set of several Statements may be used to track complete details about a learning experience. 

Actors

An actor is who the Statement is about, as an Agent or Group Object. They represent the "I" in "I Did This". To add a new actor, click Add in the Actors tab.

Enter the name and the JSON code.

To edit the actor, click the Edit icon. To delete the actor, click the Delete icon.

Verbs

A verb is the action of the Learner or Team Object. Represents the "Did" in "I Did This". To add a new verb, click Add in the Verbs tab.

Enter the name and the JSON code.

To edit the verb, click the Edit icon. To delete the verb click the Delete icon.

Objects

An object can be an Activity, Agent, or another Statement that is the Object of the Statement. It represents the "This" in "I Did This". To add a new object, click Add in the Objects tab.

Enter the name and the JSON code.

To edit the object, click the Edit icon. To delete the object, click the Delete icon.

Using xAPI

xAPI statements can be added everywhere on the site where rules can be added. For more details on how to add rules, visit the Rules topic.

When adding a rule, select the xAPI option from the list.

Then select the xAPI server, actor, verb, and object. You can also add new actors, verbs, and objects.

Each xAPI statement can have variables associated with it that can be inserted into the JSON code of actors, verbs, and objects.

xApi widget

Administrators can add the xAPI widget to the admin dashboard. To add the widget go to the dashboard and click the "Edit widgets" button.

Then select "Center Panel" from the pop-up.

From the "Available widgets" area you can add the xAPI widget to the center panel using drag-and-drop, then click Save.

The widget shows the number of xAPI calls and the number of errors.

To learn more about dashboard widgets visit the Widgets topic.