The ClearXP integration connects the ClearXP learning platform to your organisation's Uptale environment. Learners sign in to Uptale with their ClearXP account and play Uptale experiences (immersive training content) in their web browser or on a VR headset, and their progress and results are recorded in ClearXP's learning record store (LRS) with xAPI, a standard for tracking learning activity. This integration is available on request: Uptale sets it up for your environment, with your ClearXP administrator.
About this integration
What it does
- Learners use their ClearXP account. They sign in to Uptale through a ClearXP single sign-on (SSO) connection: no separate Uptale password.
- They play on any device. Tracking works in the web player and in the Uptale Player app, including on VR headsets.
- Results are recorded as they play. Uptale sends xAPI statements to ClearXP's learning record store during the session.
What goes back to ClearXP
For each session, ClearXP's learning record store receives statements when the learner starts the experience, each time they win a star, when they pass or fail it, and when they close it (completed). Each statement carries:
- the score: the stars won, out of the stars available in the experience (see Objectives, stars & success score);
- the success and completion status, from the experience's success criteria;
- the duration of the session.
The detailed results (path, answers, session reports) stay in Uptale's reports: see Data tracked & LMS data.
What you need
- A ClearXP account for your organisation, with its learning record store.
- A ClearXP single sign-on connection on your Uptale environment, set up with Uptale. See Security settings & SSO.
- The ClearXP integration enabled for your environment by Uptale.
Set it up
How the setup works
- Your Environment Administrator contacts support@uptale.io to request the ClearXP integration.
- Uptale sets up the ClearXP single sign-on connection and the ClearXP card with your ClearXP administrator.
- Uptale confirms when the integration is active. The ClearXP card then appears on your environment's Integration tab, with To set up this integration, please contact support@uptale.io. for any later change.
What your ClearXP administrator prepares
| Information | Used for |
|---|---|
| The details of your ClearXP single sign-on | The SSO connection learners use to sign in to Uptale |
| The address of ClearXP's learning record store | The Learning Record Store Endpoint field of the card |
The Activity ID host shown on the card is set by Uptale: it builds the identifier of each experience in the xAPI statements.
Use it
How learners launch an experience
Learners open the Uptale experience from ClearXP and sign in to Uptale with their ClearXP account. They play in their web browser, or in the Uptale Player app on a VR headset, signed in the same way: see All the ways to play.
Limits
- Only published experiences can be played. See Publish an experience.
- Experiences without success criteria are sent as completed and passed about one minute after the learner starts them. Set objectives and success criteria before sharing the experience.
- Sessions launched from ClearXP don't count towards Uptale programs: a program only counts the sessions launched from the program itself.
Troubleshooting
The ClearXP card isn't on the Integration tab
The card only appears once Uptale has enabled the integration for your environment. Write to support@uptale.io.
A learner is signed out when they start an experience
Their ClearXP sign-in has expired. They sign in again with their ClearXP account and relaunch the experience.
Nothing reaches ClearXP's learning record store
Results are only sent for learners signed in with their ClearXP account. Check that the learner signed in through ClearXP, and that the ClearXP card is activated; for a change to the learning record store address, write to support@uptale.io.