Statements

A xapi.ly Statement is the core of what you'll be creating to copy/paste into your authoring tool. The data entered in the Statement form is used to generate a full xAPI Statementopen in new window when the JavaScript is triggered in the course.

The minimum needed here is the verb - all other fields are optional.

Add a Statement

  • Select your Project
  • To the right of your Activity, select + New Statement
  • The default mode is Guided Mode
    • This takes you through the form step-by-step
    • If you're familiar with the process or prefer to view the whole form, you can toggle to Open Mode

Fields

Step 1 (Choose a Verb)

FieldDescriptionRequired
VerbPre-populated list of verbsRequired

TIP

Contact us if you feel a verb should be added to the list, preferably from a published location like ADL's Profile Serveropen in new window or Rustici's older Tin Can Registryopen in new window.

Step 2 (Add Result)

Resultsopen in new window measure an outcome.

TIP

All of these fields can be entered directly or toggled to use an authoring tool variable value.

FieldTypeDescriptionRequired
ResponseStringTypically used to represent a user response (text input, answer)Optional
Raw ScoreNumberUser scoreOptional
Minimum ScoreNumberMust be smaller than Raw and Max ScoresOptional
Maximum ScoreNumberMust be larger than Raw and Min ScoresOptional
Scaled Scoreopen in new windowNumberUser score as a decimal value between -1 and 1
(Generally Raw / Max)
Optional
SuccessBooleanOptional
CompletionBooleanOptional

Step 3 (Add Context Activities)

Context Activitiesopen in new window can be added to statements to show relation to other activities.

In xapi.ly, they are structurally identical to primary Activities.

FieldDescriptionRequired
ParentThis activity has a direct relation to this statement
Generally there is only one sensible parent
Optional
GroupingThis activity has an indirect relation to the statement
There can be multiple related grouping activities
Optional
CategoryThis activity can categorize the statement like a tagOptional
OtherThis activity doesn't fit any of the other Context Activity typesOptional

Step 4 (Add Extensions)

Extensionsopen in new window can add additional metadata to statements.

Each extension can be added to:

  • Context
    • The core statement overall
  • Activity
    • Additional info to define an activity
  • Result
    • Related to an outcome
FieldDescriptionRequired
LocationContext, Activity or ResultRequired
IDThis can be a full IRI (standard) or a simple string (custom, that will be converted to an IRI).

You can optionally define the root IRI for a simple string extension in Publish > Configuration Options > Extension Root ID.
Required
ValueYour extension valueRequired
NotesThis is for your internal use, and doesn't appear in statement dataOptional

Copy Code Snippet

From the Output panel on the right of the form, select Copy code and paste the results into the JavaScript trigger/action in your authoring tool.

Last Updated:
Contributors: Matthew Kliewer