Node Copied to Clipboard!

XAPI

The Experience 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).

Setup Remote

To track XAPI in your lesson you will need to connect to your LRS within the Editor. We call XAPI.SetupRemote at the beginning of the lesson to do this. Select the node and input the proper information.

  • Endpoint: The URL path to your LRS.
  • Password: The password for your LRS account.
  • Username: The username for your LRS account.

Set Language

The next step is to make sure the language is set at the beginning of your lesson. Use the Localizer.SetLanguage node and for English input en-US.

Creating Xapi Statements

Each XAPI statement is made up of an Agent, Verb, and Activity. From the xAPIStatement (type) dereference a value. This will provide you with an XAPI statement node with three arguments to fill in.

Agent

An Agent is the user that will complete the lesson. The agent will be the same for every statement in the lesson. This must be the same user you signed in with through the SetupRemote node. From the xAPIAgent (Type) dereference a value. Select the value node and fill in the properties.

  • Email: Email of the LRS user account.
  • Name : Username of the LRS User (same as the one used in the SetupRemote).

Verb

The Verb is the action word that will be displayed in the XAPI statement. From the xAPIVerb (type) dereference a value. Select that value node and fill in the properties.

  • Id: This is a unique URL usually constructed from the LRS URL for example http:// lrs.corp.modesttree.com/xAPI/verb/100 using a unique identifier for each verb.
  • Name: The verb you want to use in the statement.

Activity

The Activity contains the details of the experience. From the xAPIActivity (type) dereference a value. Select this value and fill in the properties.

  • Description: Details of the experience.
  • Id: A unique URL usually constructed from the LRS URL for example http:// lrs.corp.modesttree.com/xAPI/activities/100 using a unique identifier for each activity.
  • More Info: A URL link.
  • Name: The name of the activity.
  • Type: The URL of the XAPI activity type.

Writing XAPI Statements to the LRS

Once you have constructed an XAPI Statement from an Agent, Verb, and Activity you can feed it into the xAPI.WriteStatement node. You can write a statement at anytime during the lesson and when the user gets to that point it will write the statement to your LRS.

Node