User Guide Cancel

xAPI in Captivate Prime

  1. Captivate Prime User Guide
  2. Introduction
    1. New features summary
    2. Release Notes
    3. System requirements | Adobe Captivate Prime
    4. Captivate Prime compliance to GDPR
    5. Accessibility in Captivate Prime
    6. Support for custom domain
  3. Get Started
    1. Getting started as Administrator
    2. Getting started as an Author
    3. Getting started as a Learner
    4. Getting started for Managers
    5. Getting started as an instructor in Captivate Prime
  4. Administrator
    1. User log in
    2. Add users and create user groups
    3. Add classroom locations
    4. Create course modules, instances, and learning programs
    5. Captivate Prime Content Catalog
    6. Content marketplace
    7. Reports
    8. Learning Paths
    9. Learning plans
    10. Manage Captivate Prime orders and billing
    11. Job Aids
    12. Certifications
    13. Catalogs
    14. Add users in bulk
    15. Peer accounts
    16. Create and modify skills and levels
    17. AI-based recommendation of courses
    18. Gamification
    19. Customize learner homepage
    20. Badges
    21. Color themes
    22. Learner transcripts
    23. Waitlist & attendance management
    24. Fluidic player
    25. Announcements
    26. Email templates
    27. Adobe Connect integration
    28. Settings
    29. Notifications
    30. iPad & Android tablet users
    31. Getting started as Administrator
    32. Purge users
    33. Tags
    34. Captivate Prime integration with Slack
    35. Captivate Prime Content Catalog
    36. Custom roles
    37. Catalog labels
    38. xAPI in Captivate Prime
    39. Monitoring and moderating Social Learning as an admin
    40. Enable full control of shared catalog
    41. Map skill with skill domains
  5. Integration Admin
    1. Migration manual
    2. Captivate Prime Connectors
    3. Integrate Captivate Prime with AEM
    4. Install Salesforce package in Captivate Prime
    5. Install Microsoft Teams connector
    6. Application developer manual
    7. Captivate Prime App for Salesforce
    8. Settings
    9. Manage custom roles via CSV files
  6. Authors
    1. User login
    2. Content library
    3. Creating, modify, and publish courses
    4. Catalogs
    5. Job Aids
    6. Adobe Connect integration
    7. Add learning objects in different locales
    8. User notifications
    9. Email templates
    10. How to choose course modules?
    11. Preview as learner
    12. Settings
    13. xAPI in Captivate Prime
  7. Instructor
    1. Modules
    2. Managing learners for your session
  8. Learner
    1. Log in
    2. Profile Settings
    3. Catalogs
    4. Courses
    5. Fluidic player
    6. Learning Programs
    7. Certifications
    8. Job Aids
    9. Badges
    10. Skills & Levels
    11. Gamification
    12. User notifications
    13. Announcements
    14. Waitlist & attendance management
    15. Captivate Prime app for Salesforce
    16. Adobe Connect integration
    17. Learner App for mobiles and tablets
    18. Social Learning in Captivate Prime
    19. Adobe Captivate Prime desktop application
    20. Learner home page
    21. Share to Social Learning
    22. System requirements | Adobe Captivate Prime desktop application
  9. Manager
    1. User log in
    2. Manager dashboard
    3. Reports
    4. Learning Objects
    5. User notifications
    6. Learner transcripts
    7. Settings
    8. iPad & Android tablet users
  10. Frequently Asked Questions
    1. Frequently Asked Questions for Administrators
    2. Frequently Asked Questions for Authors
    3. Frequently Asked Questions for Instructors
    4. Frequently Asked Questions for Managers
  11. Knowledge Base
    1. Unable to log in to Captivate Prime
    2. Learning Summary does not display current data
    3. Unable to upload a CSV
    4. Generate a HAR file
    5. L1 feedback auto popup does not appear
    6. Unable to view certain courses under catalog while creating a Certification
    7. Unable to view certain course under catalog while creating a Learning Program
    8. Issues in retiring a Learning Program
    9. Unable to assign a badge
    10. Session expires in Captivate Prime
    11. Unable to search a course
    12. Troubleshoot migration issues
    13. Troubleshoot Captivate Prime app issues
    14. Users get auto deleted in Captivate Prime
    15. Publishing issues in the EU domain
    16. Unable to register as external user
    17. Okta Active Directory integration with Adobe Captivate Prime
    18. Unable to view learners in a course
    19. Unable to view calendar
    20. Module is not marked complete after completing a course
    21. Unable to achieve a skill after completing a course
    22. Radio buttons are missing
    23. Unable to view file submissions in Captivate Prime

What is xAPI?

The Experience API (xAPI), 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). LRSs can exist within traditional learning management systems (LMSs) or on their own.

For more information on xAPI, see:  https://github.com/adlnet/xAPI-Spec.

How does Captivate Prime support xAPI?

Captivate Prime has an inbuilt Learning Record Store. This LRS has the full capability of accepting xAPI statements from content that has been hosted within Captivate Prime. It even accepts xAPI statements that third parties generate. These xAPI statements are stored within Prime and they can then be exported outside Prime to be visualized into any third-party data warehousing system.

When do you use xAPI?

Increasingly there is a need to capture learning experiences of the end user which span across multiple systems.  There is also a need to track the exact engagement of the learner with training content. It goes beyond Start, In Progress and Completion (which are the only attributes captured by SCORM).

Using xAPI in Prime

Set up your application

  1. Log in as Integration Admin. Select Applications > Register.

    App registration
    App registration

  2. Register a new application.

    Create application
    Create application

  3. Define the scope for the application.

    • If Admin role xAPI read and write access is enabled, the Admin is able to post and get xAPI statements and documents.
    • If Learner role xAPI read and write access is enabled, the Admin is able to post and get xAPI statements and documents.
  4. Save changes. You get your developer id and secret.

End points :

Click the link below to view the xAPI swagger document:

https://captivateprimeeu.adobe.com/docs/primeapi/xapi/

Note: xAPI version supported in Prime is 1.0.3.

API authentication

Captivate Prime xAPI use OAuth 2.0 framework to authenticate and authorize your client applications. Once you register your application, you can get the clientId and clientSecret. Get URL is used in browser as it authenticates the Captivate Prime users using their pre-configured accounts such as SSO, Adobe ID. 

GET https://captivateprime.adobe.com/oauth/o/authorize?client_id=<Enter your clientId>&redirect_uri=<Enter a url to redirect to>&state=<Any String data>&scope=<admin:xapi or learner:xapi>&response_type=CODE.

Tracking xAPI statements as Prime LO

As an Author you can now choose xAPI module while creating courses to monitor user experience outside Prime. For example, you can use this feature to evaluate the activities of users on a third-party platform used for course consumption.

  1. While creating an Activity Module, in the Type option, use the pop-up menu to select xAPI-based Module. 

    x-API based module creation
    x-API based module creation

  2. You are requested to provide an IRI. If not provided, prime generates one automatically.

    Note:

    IRI for an activity is unique across an account. That means, two modules in Captivate Prime cannot have same IRI. A new IRI is generated in the following cases:

    • When a course with xAPI module is shared across accounts.
    • When a certification with xAPI module recurs

     

    Any xAPI statement with the mentioned IRI is tracked in the above module and are reflected in the Prime reports. 

  3. To copy the auto-generated IRI, revisit the Activity Module page.

  4. Publish the Module.

Points to note:

  • Captivate Prime currently supports only mbox as an identifier. Other identifiers including mboz_sha1, openid , account are not supported.
  • The stateId and profileId is a UUID when used with Prime.
  • PUT request does not overwrite the document for xAPIs agents/profile, activity/profile, and  activity/state
  • Unidentified group is not supported in Actor.
  • The parameter "related_activities" is not supported in  GET statement.
  • The parameters 'format=ids' & 'format=canonical' is not supported in GET statements.
  • Voiding of xAPI statement does not undo any actions that happened in Prime when the statement was posted.

Generate reports

xAPI reports can be generated as excel reports. As an Administrator, open Reports > Excel reports > xAPI activity report.

The downloaded report fetches all the information posted by the Learner and Administrator for any statement.

Same reports can be gernerated / scheduled using FTP and Box connectors for any third- party integration. Follow these steps:

Log in as Integration Admin > Open FTP/Box connector > Select xAPI Activity report from the left pane> Choose to schedule/ generate a report.

Schedule a report
Schedule a report

Note:
  • When only raw score is sent in xAPI statement without max score, Quiz score is not shown in LT.
  • To get the percentage score in Prime, scaled scores are sent through xAPI.

Sample report

Download

Adobe logo

Sign in to your account

[Feedback V2 Badge]