Skip to main content

Integration with LRS using SuperWrapper

This guide explains how to integrate Adobe Captivate projects with a Learning Record Store (LRS) using the SuperWrapper library. It covers event verbs, project setup, and publishing instructions.


Verbs and Events

VerbWhen it triggers / sends to LRSAdditional Properties
accessWhen course is launched
enterWhen user enters a slide
returnWhen returning to a menu slide
viewWhen leaving a slide
completeWhen last slide is entered
pressedTap/Click of button or clickbox
focusWhen focus on window happens
unfocusWhen focus on window is lost

Video Events

VerbWhen it triggers / sends to LRSAdditional Properties
playWhen video is played
pauseWhen video is paused
scrubWhen video is scrubbed
watchWhen end of video is reached
muteWhen video is muted
unmuteWhen video is unmuted

Quiz Events

VerbWhen it triggers / sends to LRSAdditional Properties
startWhen quiz is started
finishWhen quiz is finished
answeredWhen question is answered
reviewedWhen slide is visited in review mode
skipWhen question is skipped

Step-by-Step Setup

Step 1: Initialize SuperWrapper

On the first slide of your project:

  1. Select the slide and open the Actions panel.
  2. Set On Enter to execute JavaScript.
  3. Add the following script:
javascript
init();
v_prodKey = [Your LRS Key]
v_prodSecret = [Your LRS Secret]
v_prodEndpoint = [Your LRS Endpoint]
v_key = [Sandbox LRS Key]
v_secret = [Sandbox LRS Secret]
v_endpoint = [Sandbox LRS Endpoint]

Step 3: Publish Captivate Project

  • Set project name and description: Captivate → Preferences → Project Information
  • Publish HTML only (SWF / Flash not supported)
  • SCORM or non-SCORM publishing is acceptable
  • Do not zip files (uncheck publish setting)

Step 4: Copy SuperWrapper Files

  1. Clone or download the repository.
  2. Copy the following files from superWrapperSource:
    • controller.js
    • controllerNoIE.js
    • tincan.js
  3. Paste them into your Captivate publish folder: assets/js/

Step 5: Modify index.html or index_scorm.html

  1. Open index.html or index_scorm.html.
  2. Locate the <script> tag (around line 10).
  3. Insert the following code after the script tag:
// SuperWrapper setup
var controllerVersion, tincan;

/* SuperWrapper is not compatible with Microsoft IE */
if (navigator.appName !== "Microsoft Internet Explorer") {
controllerVersion = "assets/js/controller.js";
tincan = "assets/js/tincan.js";
} else {
controllerVersion = "assets/js/controllerNoIE.js";
}
// End of SuperWrapper insertion

Step 6: Append JS Files

  1. Search for the line defining JS files (around line 120):
var lJSFiles = ['assets/js/jquery-1.11.3.min.js','assets/js/CPM.js'];
  1. Append SuperWrapper files:
lJSFiles.push(tincan, controllerVersion);