xAPI & cmi5 Export
xAPI and cmi5 are modern eLearning standards that provide richer tracking than SCORM. Use xAPI for standalone Learning Record Store (LRS) integration, or cmi5 for LMS-managed deployment with xAPI-level analytics.
xAPI vs. cmi5
Section titled “xAPI vs. cmi5”| Feature | xAPI (Standalone) | cmi5 |
|---|---|---|
| Launch method | Direct URL or LRS portal | LMS launches the course |
| Authentication | Self-managed (URL params, config file, or prompt) | LMS provides auth automatically |
| Tracking detail | Full: media, interactions, questions, progress | Course-level: completion, pass/fail, score |
| Bookmarking | LRS State API or localStorage | LRS State API |
| Best for | Standalone deployment with an LRS | LMS deployment with xAPI analytics |
Use xAPI when you want detailed analytics (media tracking, interaction tracking) and are deploying through an LRS portal or hosting the course yourself.
Use cmi5 when your LMS supports it and you want the LMS to handle authentication and launch while still storing data in an xAPI-compatible LRS.
What xAPI tracks
Section titled “What xAPI tracks”xAPI provides the most detailed tracking of any export format:
Course progress
- Course initialized, completed, and terminated
- Progress percentage
- Session duration
Lesson tracking
- Each lesson viewed is recorded
Knowledge checks and assessments
- Question text, selected answers, correct answers, and result (correct/incorrect)
- Assessment score, pass/fail, and attempt details
Media tracking
- Video and audio play, pause, seek, and completion events
- Works with YouTube, Vimeo, direct URL, and uploaded media
Interactive components
- Accordion panels opened and closed
- Tab switches
- Button clicks
What cmi5 tracks
Section titled “What cmi5 tracks”cmi5 follows a stricter specification that limits tracking to course-level events:
- Completion - when the learner finishes the course
- Pass / fail - assessment result with score
- Bookmarking - resume position saved via the LRS State API
Detailed interaction data (media events, accordion/tab usage, individual question responses) is stored in the LRS State API rather than as individual xAPI statements, in accordance with the cmi5 specification.
xAPI configuration
Section titled “xAPI configuration”When exporting as xAPI, you choose how the course connects to your LRS:
| Mode | How it works | Best for |
|---|---|---|
| URL parameters | LRS passes credentials in the launch URL | LRS portals (e.g., SCORM Cloud xAPI launch) |
| Config file | Credentials stored in a JavaScript config file | IT-managed deployments on internal servers |
| Embedded | Credentials included in the package | Trusted internal environments |
| Prompt learner | Course asks the learner for their name and email | Quick testing or standalone use without an LRS |
cmi5 configuration
Section titled “cmi5 configuration”cmi5 requires no manual configuration. The LMS provides all authentication and connection details automatically when it launches the course. If the course is opened outside of an LMS, it falls back to standalone mode with local storage.
LRS compatibility
Section titled “LRS compatibility”xAPI and cmi5 exports are compatible with:
- SCORM Cloud
- Learning Locker
- Watershed
- Yet Analytics
- Veracity Learning
- Any ADL-conformant LRS
Deploying xAPI courses
Section titled “Deploying xAPI courses”- Export your course as xAPI from Slate
- Upload the
.zipto your LRS or host the extracted files on a web server - Configure your LRS to launch the course with the appropriate credentials
- Assign to learners through your LRS portal
Deploying cmi5 courses
Section titled “Deploying cmi5 courses”- Export your course as cmi5 from Slate
- Upload the
.zipto your LMS - The LMS reads the
cmi5.xmlmanifest and registers the course - Assign to learners. The LMS handles launch and authentication automatically.
We recommend testing with SCORM Cloud before deploying to production. SCORM Cloud supports both xAPI and cmi5 launch modes.