antshin72 / xapi

Jisc Learning Analytics Statement Templates

xAPI recipes for Jisc Learning Analytics v1.2.0

Statement Vocabulary and Common Structures

• Vocabulary gives the IRIs and definitions for Verbs, Activity types, and so on, as well as for extensions used in the Statements.
• Integrations contains the latest intergration exercises for vendors.
• Common Structures outlines common patterns used across different Statements.
• Generic Statement Templates can be found in this directory.

Learning more about xAPI starting here [https://xapi.com/overview/]

Recipes

Here are descriptions of Statements that can be sent to the Jisc Learning Data Hub, full Statement examples, and data needed to create the Statement. As far as possible all entities are the same across all the Statements, these reusable parts of Statements are linked from templates and can be found in the Common Structures page which contains all common patterns used across different Statements. If an entity is not reusable then properties are described in the Statement template.

Accessed Facilties

Statement Template	Input TSV definitions	JSON Template	Example Input
Accessed facility	facility-accessed-input.md	facility-accessed-template.json	TSV

Attendance

Statement Template	Input TSV definitions	JSON Template	Example Input
Attended learning activity	attendance-input.md	attendance-template.json	TSV

Econtent services

Statement Template	Input TSV definitions	JSON Template	Example Input
Viewing econtent	econtent-viewed-econtent-input.md	econtent-viewed-econtent-template.json
Accessed service	econtent-accessed-econtent-input.md	econtent-accessed-econtent-template.json

Intervention Case

Statement Template	Input TSV definitions	JSON Template	Example Input
Open a case	case-create-activity-input.md	case-create-activity-input.json
Update a case	case-update-activity-input.md	case-update-activity-input.json
Close a case	case-close-activity-input.md	case-close-activity-input.json
Create a note	note-create-activity-input.md	note-create-activity-input.json

Library Services

Statement Template	Input TSV definitions	JSON Template	Example Input
Library item: Borrowed item	library-item-borrowed-input.md	library-item-template.json	TSV

Login activity

Statement Template	Input TSV definitions	JSON Template	Example Input
Logged in	loggedin-input.md	loggedin-template.json	TSV
Logged out	loggedout-input.md	loggedout-template.json	TSV

Microsoft Products and Services

Statement Template	Input TSV definitions	JSON Template	Example Input
Microsoft Aggregated Activity		microsoft-aggregated-activity.json

Predictive Model Output

Statement Template

Predictive Model Alerting

Mobile Applications

Statement Template	Input TSV definitions	JSON Template
Answered Question	recipes/studyapps/uxapi/app-answered-question-input.md	recipes/studyapps/uxapi/app-answered-question-template.json
Mobile app content viewed	app-content-viewed.md	app-content-viewed.json

Reading Lists

Statement Template	Input TSV definitions	JSON Template	Example Input
Viewed a Reading List	readinglist-itemviewed-input.md	readinglist-viewed-template.json	TSV
Viewed a Reading List Item	readinglist-itemviewed-input.md	readinglist-itemviewed-template.json	TSV
Viewed reaing list e-content	readinglist-viewed-content-input.md	readinglist-viewed-content-template.json

Video

Statement Template	Input TSV definitions	JSON Template	Example Input
Video Viewed	video-viewed-input.md	video-video-templates.json	TSV

VLE

These are platform-independent Statements related to Virtual Learning Enviroments.

VLE resource viewed	vle-resourceviewed-input.md	vle-resourceviewed-template.json	TSV
Assignment Graded	vle-assignmentgraded-input.md	vle-assignmentgraded-template.json	TSV
Assignment Submitted	vle-assignmentsubmitted-input.md	vle-assignmentsubmitted-template.json	TSV
Create a forum post	vle-forum-input.md	vle-forum-template.json	TSV
Quiz: Answered Questions	vle-answered-questions-input.md	vle-answered-questions-template.json	TSV
Quiz: Quiz Completed	vle-quiz-completed-input.md	vle-quiz-completed-template.json	TSV

All VLE Statement examples

The following JSON samples are recent examples generated from plugins. They may not match the specification.

Bug reports can be directed to the Moodle or BlackBoard Github repository.

• Blackboard VLE samples
• Moodle VLE samples

Repository Workflow

The simplest way to contribute to the xAPI service is as follows:

1. Add an issue to the issue tracker to alert everyone to what you are working on and why.
2. Tag the issue with the version milestone you'd like the patch to be part of.
3. If the feature is for this version then make an edit or add a file in this repository, and save it to your own branch. If you prefer, you can fork the whole repository and work in your own repository. Otherwise create a feature-branch to work in.
4. If you are creating a new Statement in a recipe then check if a generic template will help. If you are creating a new Statement then consider creating a generic one first.
5. Send a pull request once you're done.
6. The pull request will be discussed at one of our regular meetings and either merged, or kept in the queue, depending on whether more work is required.

You can do all this through the Github GUI, but you're welcome to use any other git tool you prefer.

If the need arises, particular versions will get their own branches, but until that time, everything is merged into the main branch. Releases will be made after the group has come to an agreement.