Skip to content
Honen Academy

Docs

Track learning with xAPI and cmi5

3 min read

Use xAPI for detailed learning records and cmi5 when an LMS launches assignable units using that standard. These are separate from SCORM and the Connector API.

Choose the workflow

Goal Use
Send Honen learning events to another learning record store Send learning records to an LRS
Let an approved external producer write records into Honen Use Honen as an LRS
Import a live Honen learning unit into a cmi5-compatible LMS Export a cmi5 package

Follow the linked walkthrough for the complete setup, screenshots, and validation steps.

Configure xAPI

  1. Open Organization → Integrations → Your LMS and choose the xAPI/cmi5 path.
  2. Review whether xAPI is enabled for the workspace. It is off until configured; the first cmi5 export can also enable it.
  3. For forwarding, open Send to an LRS → Add destination. Enter a name, HTTPS endpoint, xAPI version, Basic auth key, and Basic auth secret from your LRS. Use Test after saving.
  4. For external access to Honen's LRS, open Honen as an LRS → New credentials. Name the connection and choose Read only for reporting, or Read and write when the external system must submit records. Choose Create credentials and copy the one-time secret.
  5. Under What Honen records, select the event types you need. Review whether to include learner email. Keep the identifier prefix stable so new records retain the same activity identities.
  6. Complete a test activity. Inspect the records in the destination LRS or query Honen's LRS with your xAPI client. Check Recent delivery problems for forwarding errors.

When xAPI is enabled, Honen stores your selected learning events and can forward them to configured destinations. Use Test to check the destination connection, then complete a learning activity and inspect its record in the LRS.

Export cmi5

  1. In an organization workspace, open the manage screen of a course you can edit and select Export → cmi5 package.
  2. Choose the audience and completion/pass requirements, including the moveOn policy.
  3. Download the ZIP and import it into a compatible LMS.
  4. Launch as a test learner, complete the required work, and check the LMS/LRS for the expected initialized, completion or success, and terminated records.

cmi5 packages load live content. Exporting the first package can enable the workspace's xAPI configuration; an explicitly disabled xAPI configuration blocks the export. cmi5 needs an LRS reporting channel.

Interpret completion

Completed, Passed, CompletedAndPassed, and CompletedOrPassed wait for different evidence. NotApplicable is informational. Check the LMS's mastery score and launch mode: Browse and Review launches should not award a new completion or pass.

Use the right connection credentials

Honen's LRS uses HTTP Basic xAPI credentials and the X-Experience-API-Version header. Use dedicated xAPI credentials for your LRS client. Honen exports cmi5 packages for LMS delivery and produces xAPI records for learning analysis.

Follow Honen as an LRS for client authentication and record verification, or Export a cmi5 package for LMS launch and reporting setup. Use a test learner in your target LMS/LRS to confirm the launch and reporting flow.

For package delivery without detailed xAPI records, see SCORM packages. For registered external-tool launches, see LTI 1.3.

PreviousExport a course as a cmi5 packageNextSend learning records to an LRS