Creating an xAPI integration to report learner data to a Learning Record Store (LRS)

In Create, you can set up xAPI endpoints that can be used by your organization to report a wide range of learner data to your Learning Record Store (LRS). Once you have configured at least one xAPI endpoint, your courses can begin reporting their data to your LRS(s).

To learn more about xAPI and what it is, see Understanding xAPI data reporting. See Supported xAPI verbs for the full list of learner activities you can track.

Note

The ability to create an xAPI endpoint is only available to Administrators.

Non-Administrator users can only apply existing xAPI endpoints to a Project. For instructions on how to do this, see Releasing a course that reports xAPI learner data.

 

Setting up a new endpoint

To report xAPI data, you need to create an endpoint. The endpoint tells Elucidat where to send the data. You can set up your endpoint in a few quick steps.

1. Obtain LRS details

To begin, you'll need to get these details from your LRS.

  • The LRS endpoint URL
    This is where your course will send learner information.
  • The LRS username (or ‘key’)
    If your LRS requires credentials to connect, then this is the username provided by the LRS.
  • The LRS password (or ’secret’)
    This is the password that corresponds to the username provided by your LRS, referenced above.

If you’re unsure about how to obtain this information, contact your LRS administrator.

Once you have these details, you are ready to create a new endpoint.

 

2. Create an endpoint

  1. Go to the Create home-page
  2. Click Integrations in the left-hand menu

    elucreate-integrations
  3. Click Add endpoint
  4. Type a name for your new endpoint in the Endpoint name field. This can be anything you like but we recommend you name it something easily identifiable.
  5. Add the endpoint URL to the LRS endpoint URL field
  6. Add the LRS username to the LRS key field
  7. Add the LRS password to the LRS secret field
  8. Use the checkbox labelled Set this as the default endpoint for your account to choose whether to make this integration the default endpoint used by your courses.
    Checked: This integration will be pre-selected when you release your course
    Unchecked: You will need to manually select this integration when you release your course
  9. Click Add endpoint

Your new endpoint will appear in the list and is ready to be used.

elucreate-integrations-xapi-endpoint-example

 

 

Next steps

For data to be reported to an LRS, you must select at least one xAPI endpoint when releasing your course.

See Selecting an xAPI endpoint for your course to learn more.

Was this article helpful?
1 out of 1 found this helpful

Articles in this section

See more
Request support
Access support that’s tailored to you by getting in touch with our Support Team.
Send us feedback
Do you have a new feature request, or want to tell us about something that works well (or not so well) for you? Get in touch!