Tutorials

Create xAPI

Table of Contents

CREATE xAPI

OVERVIEW

image3002Create xAPI is for Premier and Enterprise level account holders only.

image3002Only LMS Managers can upload an xAPI package.

To add a new xAPI package to your records list, navigate to the main menu. Under Courses > Manage xAPI, select Create xAPI:

imagexAPI_005

Select the Add New Tin Can Record button from the Tin Can Records List page:

imagexAPI_006

From the Create TIN CAN RECORD page:
    • Enter the name for your lesson.
    • Create a unique folder for each Tin Can published ZIP file.
    • Upload your published xAPI ZIP from your computer.

WarningDo NOT add text into the Content URL or Activity ID fields. By default, the Content URL and the Activity ID will automatically be read from your uploaded file.

  • Select the Create Course button:

    imagexAPI_007

image3027
While uploading… Be patient. Depending on how large the xAPI package is, it may take some time to upload. You should notice the % upload in the bottom right corner: imagexAPI_008
After the upload is complete, you will see the text Tin Can Record Created. Return to the RECORDS LIST page by selecting the Back to Tin Can Records List button:

imagexAPI_009

ADD xAPI AS CONTENT

In C4EBridge, Instructors and LMS Managers can add xAPI packages as content in three different areas:
  • The Course Information/Summary page
  • A Quiz
  • A Lesson

ADD xAPI TO THE COURSE SUMMARY PAGE

You can easily add xAPI packages on your Course Information page. When uploading an xAPI package from the CREATE COURSE OR EDIT COURSE SETTINGS, the learner will view the xAPI content from the Course Information page. This type of content is usually used as an introduction to the course. After creating a new course, in the Course Description field, you can either insert a button to launch your uploaded xAPI content or insert your course in an iFrame (such as a lightbox).

imagexAPI_010

    ADD xAPI PACKAGE AS AN IFRAME
Under the Course Description, select the xAPI button “Insert your course as an iFrame” (see image above). Another window will popup. From the Select Course dropdown, select your xAPI package from the list.

imagexAPI_011

WarningOnly an LMS Manager can upload xAPI packages, but if you are an instructor, you will see the list here.

Choose the frame width and height by adjusting the slider. It is recommended you choose the same width and height as your published output:

imagexAPI_012

Once complete, select the Insert button to continue or Cancel to go back to your Course Settings and ensure you Publish or Update your changes in the PUBLISH panel:

imagexAPI_013

The xAPI package will be embedded as an iframe at the top of the COURSE INFORMATION page. This is an example of a Captivate course published as xAPI:

imagexAPI_014

    ADD xAPI PACKAGE AS A BUTTON
If you want to add the xAPI package into your Course Information page as a button, from the CREATE COURSE page select the xAPI button:

imagexAPI_015

Another window will pop up. From the Select Content dropdown, select your xAPI package from the list and choose if you want to open in full screen mode or not.

imagexAPI_016

Feel free to change look of your button by making changes to the color, text, padding, and border. Once you are done, select the Insert button.

imagexAPI_017

Be sure to select the Update button in the PUBLISH panel to save your changes.

imagexAPI_018

Once you update your changes, the xAPI package will be embedded as a button on the Course Information page. Select the button to launch the xAPI:

imagexAPI_019

The course will open in a light box. This is an example of a RISE course published as xAPI:

imagexAPI_020

ADD xAPI TO A QUIZ

You may also choose to your xAPI packages to your quiz and quiz question descriptions. After creating a new quiz, in the General Settings options, add your xAPI package:

imagexAPI_021

Use the Record xAPI Data toggle button in the MANAGE THIS QUIZ EXPERIENCE panel to enable recording of the data.

imagexAPI_022

image3002
Assign a competency to this quiz: Select a quiz competency from this list. If you do not select a competency your xAPI data will be rejected by the LRS. Competencies are created in Courses > Manage xAPI > Competencies and need to be assigned one or more competency types in the Competencies box.
image3002
Select an ADL verb URL: This is a live ADL verb list. Select an Activity ID URL. You must select a URL from this list or your xAPI data will be rejected by the LRS.

ADD xAPI TO A LESSON

You can add an xAPI file to your lessons on the LESSON EDITOR page. While in Lesson Edit mode, select the Add Content (+) button in the top right corner to open the Tools panel.

imagexAPI_023

Drag and drop xAPI Button to launch your xAPI package from a button or drag and drop xAPI Embed to embed your xAPI package as an iFrame. After dragging and dropping the tool, a settings panel will pop up.

XAPI EMBED SETTINGS:

  • Select your course from the dropdown menu. You can also change the criteria to Auto Complete Lesson or to Control Mark Complete Button.
  • Adjust your frame width and height
  • Select Save when complete.
  • Select Save As to save your xAPI Embed as a tool template or Cancel to go back to the Lesson Editor.

imagexAPI_024

XAPI BUTTON SETTINGS:

  • Select your course from the dropdown menu.
  • You can also change the criteria to Auto Complete Lesson or to Control Mark Complete Button.
  • Adjust the look of your button by making changes to the color, text, and border.
  • Select Save when complete.
  • Select Save As to save your xAPI Button as a tool template or Cancel to go back to the Lesson Editor.

imagexAPI_025

In the ADVANCED TAB for both xAPI Button and xAPI Embed, you can make changes to spacing, visibility, animations, and more.

imagexAPI_026

image3002
Auto Complete Lesson: The lesson will automatically complete and go to the next lesson once a student reaches the end.
image3002
Control Mark Complete Button: A student must select the Mark Complete button to track lesson completion.
Previous Manage xAPI Overview
Next Records List
Table of Contents