JISC Learning Analytics Statements and Vocabulary

The following terms are in use in the Jisc learning analytics recipes. NOTE: The xapi.jisc.ac.uk namespace URI may change. IRIs will not necessarily link to a page in a browser, as these are identifiers and not linked resources.

1.0 Verb

The following example of a Verb entity uses the 'en' language tag, but any RFC 5646 language tag can be used:

"verb": {
        "id": "https://brindlewaye.com/xAPITerms/verbs/loggedin",
        "display": {
            "en" : "logged in to"
        }
    },

The following xAPI Verbs are defined as part of the Jisc Profile:

Attended

Verb	Attended
Description	Indicates the Actor was present at a virtual or physical event or activity.
IRI	http://adlnet.gov/expapi/verbs/attended
Statement Example	Attended learning activity

Completed

Verb	Completed
Description	Completing an Activity - finishing it in its entirety
IRI	http://adlnet.gov/expapi/verbs/completed
Statement Example	Assignment submitted

Logged in

Verb	Logged in
Description	Logged in to some service
IRI	https://brindlewaye.com/xAPITerms/verbs/loggedin
Statement Example	Logged in

Logged out

Verb	Logged out
Description	Logged out of some service
IRI	https://brindlewaye.com/xAPITerms/verbs/loggedout
Statement Example	Logged out

Scored

Verb	Scored
Description	Indicates a numerical value related to an Actor's performance on an Activity.
IRI	http://adlnet.gov/expapi/verbs/scored
Statement Example	In Assignment Graded Statement template

Session timed out

Verb	Session timed out
Description	Indicates that the Activity provider has determined that the session was abnormally terminated, either by an Actor or due to a system failure.
IRI	https://w3id.org/xapi/adl/verbs/abandoned
Statement Example	Session Timeout

Viewed

Verb	Viewed
Description	Indicates that the Actor has viewed the Object.
IRI	http://id.tincanapi.com/verb/viewed
Statement Example	Resource Viewed

2.0 Result

In the Jisc Profile, the use of the Result entity and any of its properties is optional, unless clarified in a specific Statement template. For an example of a Result in a Statement template, see Assignment Graded.

Example:

 "result":{
        "score":{
            "raw":8
                }
        "extensions": {
        	"http://xapi.jisc.ac.uk/grade":"5 stars"
        	}
    },

2.1 Result Extensions

The following are extension properties in the Result entity:

Attendance Late

Label	Attendance Late
Description	Indicates if Agent had late attendance
IRI	http://xapi.jisc.ac.uk/attendance_late
Example in Statement template	attendance
Data Type	Integer
Value Space	1 for late
Sample Value	1

Attendance Category

Label	Attendance Category
Description	Enables the classification of the type of non-attendance
IRI	http://xapi.jisc.ac.uk/attendance_category
Example in Statement template	attendance
Data Type	String
Value Space	defined by the source system
Sample Value	C

Grade

Label	Scored
Description	A non-numerical assessment result. Data type is string (256)
IRI	http://xapi.jisc.ac.uk/grade
Statement Example	Assignment Graded
Value Space	String
Sample Value	5 Stars

3.0 Object

3.1 Activity Types

The following are types of the Activity Definition Object. Activity Types may use the subType extension to further indicate the subType of the Activity.

Some examples of subTypes of Activity Types are included. However sub-types are not defined by the Jisc profile spec and the examples shown are indicative; it is the responsibility of the plugin to define the subType. Since the vendors do not own the IRI, these subTypes use a Jisc-controlled namespace that relates to the vendor or vendor product (for example: http://bblearn.xapi.jisc.ac.uk).

Example:

"object": {
	"objectType": "Activity",
	"id": "http://moodle.data.alpha.jisc.ac.uk/mod/quiz/view.php?id=13" 
	"definition": {
		"type": "http://xapi.jisc.ac.uk/vle/page",			
		"name": { "en": "Sample page" },			   
		"description": { "en": "sample page" } 
		"extensions": {
				"http://xapi.jisc.ac.uk/subType": "http://bblearn.xapi.jisc.ac.uk/blankpage"
				}
	 }
}

Application

Label	Application
Description	Represents any kind of software application
IRI	http://activitystrea.ms/schema/1.0/application
Statement Example	Logged in
Example Subtypes	http://id.tincanapi.com/activitytype/mobile-app

Assessment

Label	Assessment
Description	An assessment is an Activity Type that determines a learner’s mastery of a particular subject area. An assessment typically has one or more questions.
IRI	http://adlnet.gov/expapi/activities/assessment
Statement Example	assignment-submitted
Example Subtypes	http://bblearn.xapi.jisc.ac.uk/selfandpeerassessment http://bblearn.xapi.jisc.ac.uk/safeassignment http://moodle.xapi.jisc.ac.uk/assignment

Chat

Label	Chat
Description	A real time chat event, such as a chatroom
IRI	http://xapi.jisc.ac.uk/chat

Course

Label	Course
Description	A course represents an entire “content package” worth of material; the largest level of granularity. Unless flat, a course consists of multiple modules.
IRI	http://adlnet.gov/expapi/activities/course

Event

Label	Event
Description	Any event. The "event" Activity Type should only be used when the type of event is unspecified.
IRI	http://activitystrea.ms/schema/1.0/event

External Content

Label	External Content
Description	External URL
IRI	http://xapi.jisc.ac.uk/externalContent
Example Subtypes	http://jisc.xapi.jisc.ac.uk/scorm http://jisc.xapi.jisc.ac.uk/lti http://bblearn.xapi.jisc.ac.uk/mashup

External URL

Label	External URL
Description	An external URL
IRI	http://xapi.jisc.ac.uk/externalURL
Example Subtypes	http://moodle.xapi.jisc.ac.uk/externalURL http://bblearn.xapi.jisc.ac.uk/webLink

File (Deprecated as of 1.0. Use Content instead )

Label	File
Description	Accessing any kind of non-web native file type. e.g. MS office, video or audio.
IRI	http://xapi.jisc.ac.uk/vle/file

Lecture

Label	Lecture
Description	A learning activity that consists mainly of an expert giving a talk to a number of learners.
IRI	http://xapi.jisc.ac.uk/lecture

Module

Label	Module
Description	A module represents any “content aggregation” at least one level below the course level. Modules of modules can exist for layering purposes. Modules are not content. Modules are one level up from all content.
IRI	http://adlnet.gov/expapi/activities/module
Statement Example	Resource viewed
Example Subtypes	http://bblearn.xapi.jisc.ac.uk/learningmodule

Other

Label	Other
Description	A category for Activity Types that may be generated by VLE specific plugins, but are not explicitly defined in the Jisc Profile.
IRI	http://xapi.jisc.ac.uk/other
Example Subtypes	http://moodle.xapi.jisc.ac.uk/choice

Study Goal Statistics

Label	Study Goal Statistics
Description	Statistics for the Study Goal application
IRI	http://xapi.jisc.ac.uk/studygoal/stats

Tutor session

Label	Tutor session
Description	This represents a tutoring session.
IRI	http://id.tincanapi.com/activitytype/tutor-session

VLE

Label	VLE
Description	Learning Management System. At its core, a platform used to launch and track learning experiences.
IRI	http://id.tincanapi.com/activitytype/lms

VLE content

Label	VLE content
Description	Any generic resource in a VLE
IRI	http://xapi.jisc.ac.uk/vle/content
Example Subtypes	http://bblearn.xapi.jisc.ac.uk/audio http://bblearn.xapi.jisc.ac.uk/video http://bblearn.xapi.jisc.ac.uk/image http://moodle.xapi.jisc.ac.uk/data http://moodle.xapi.jisc.ac.uk/file http://moodle.xapi.jisc.ac.uk/glossary http://moodle.xapi.jisc.ac.uk/wiki http://moodle.xapi.jisc.ac.uk/lesson http://bblearn.jisc.xapi.ac.uk/lessonplan http://moodle.xapi.jisc.ac.uk/vle/workshop

VLE forum

Label	VLE forum
Description	A VLE forum/discussion board
IRI	http://xapi.jisc.ac.uk/vle/forum

VLE page

Label	VLE page
Description	Any page within a VLE that is not designed to be learning content, for example navigation or administration pages
IRI	http://xapi.jisc.ac.uk/vle/page
Example in Statement template	Resource viewed
Example Subtypes	http://moodle.xapi.jisc.ac.uk/page http://bblearn.xapi.jisc.ac.uk/blankpage http://bblearn.xapi.jisc.ac.uk/modulepage

VLE quiz

Label	VLE quiz
Description	Quiz within a VLE
IRI	http://xapi.jisc.ac.uk/vle/quiz
Example in Statement template	Resource viewed
Example Subtypes	http://moodle.xapi.jisc.ac.uk/quiz http://bblearn.xapi.jisc.ac.uk/test http://bblearn.xapi.jisc.ac.uk/survey

4.0 Object Definition and Context Extensions

The following are Jisc Profile extensions to be used in object.definition.extensions.

Application Type (Deprecated)

Was used in older recipes to identify the genre of software application. Best practice is to use subType instead.

Label	Application Type
Description	Identifies the genre of software application
IRI	http://xapi.jisc.ac.uk/applicationType
Example in Statement template	Logged in
Data Type	IRI
Sample Value	http://id.tincanapi.com/activitytype/lms

Course area

For more information, see Jisc Profile CourseArea properties.

Label	Course area
Description	Course/parent area by its home page URI
IRI	http://xapi.jisc.ac.uk/courseArea
Data Type	A JSON Object
Value Space	JSON Object with properties vle_mod_id and uddModInstanceID

DateTime

Label	DateTime
Description	Value representing a calendar date and time, such as 2013-08-27T09:26:45.001. Value should be a string formatted as an ISO8601 date and time to match the rest of the specification values.
IRI	http://id.tincanapi.com/extension/datetime
Example in Statement template	attendance
Data Type	String
Value Space	ISO 8601 date time
Sample Value	2016-02-05T17:59:45.000Z

Device Location

Label	GeoJSON
Description	Value should be a GeoJSON Object as defined by the GeoJSON specification. GeoJSON can be used to represent GPS coordinates, as well as other geometric entities. See http://www.geojson.org/ for more information.
IRI	http://id.tincanapi.com/extension/geojson
Data Type	JSON Object
Value Space	GeoJSON Object

Due Date

Label	Due Date
Description	Date student's work is due to be submitted. Format is ISO8601 date time.
IRI	http://xapi.jisc.ac.uk/dueDate
Example in Statement template	assignment-graded
Data Type	String
Value Space	ISO 8601 date time
Sample Value	2016-02-05T17:59:45.000Z

Duration

Label	Duration
Description	Value representing a length of time, for example the length of a video. Value should be formatted as an ISO8601 duration to match the result.duration property. Note that ISO8601 duration allows representations to extend beyond their carry over points; for example one and a half hours can be represented as either PT1H30M0S or PT90M. This extension will generally be used within an Activity Definition to indicate a length of an Activity as compared to the result.duration which captures the length of time for a specific event. For example a video may be 5 minutes long (this extension), but an Actor may have only watched 30 seconds of it (the result.duration).
IRI	http://id.tincanapi.com/extension/duration
Example in Statement template	attendance
Data Type	String
Value Space	ISO 8601 duration
Sample Value	PT1H30M0S

Event Mandatory

Label	Event Mandatory
Description	Indicates whether or not the session is optional.
IRI	http://xapi.jisc.ac.uk/event_mandatory
Example in Statement template	attendance
Data Type	Boolean
Value Space	1 for mandatory, 0 for non mandatory
Sample Value	1

Event Max Count

Label	Event max count
Description	Value representing the total number of people who could have gone to the session
IRI	http://xapi.jisc.ac.uk/event_type_id
Example in Statement template	attendance
Data Type	Integer
Sample Value	32

Event Type Description

Label	Event Type Description
Description	Plain text describing an event
IRI	http://xapi.jisc.ac.uk/event_type_id
Example in Statement template	attendance
Data Type	String
Value Space	Description of event
Sample Value	Lecture

Event Type ID

Label	Event Type ID
Description	Value representing an Activity Type (for example 1 for lecture, 2 for seminar)
IRI	http://xapi.jisc.ac.uk/activity_type_id
Example in Statement template	attendance
Data Type	Integer
Value Space	Related to activity type.
Sample Value	1

IP address

Label	Session id
Description	Client's address location on internet
IRI	http://id.tincanapi.com/extension/ip-address
Data Type	String
Value Space	IP address in either IPv4 or IPv6 format
Sample Value	10.3.3.48

Planned End Time

Label	End time
Description	An ISO8601 timestamp representing the planned end time of a scheduled or planned event.
IRI	http://xapi.jisc.ac.uk/endtime/a>
Data Type	ISO 8601 timestamp
Value Space	Timestamp
Sample Value	2016-02-05T10:00:00.000Z

Planned Start Time

Label	Start time
Description	An ISO8601 timestamp representing the planned start time of a scheduled or planned event.
IRI	http://xapi.jisc.ac.uk/starttime
Data Type	ISO 8601 timestamp
Value Space	Timestamp
Sample Value	2016-02-05T10:00:00.000Z

Recipe Version (deprecated since 1.0)

Label	Recipe Version
Description	Version of profile the Statement template was taken from. Version number can be found on recipe page. Data CAN be supplied that meets later, experimental or tweaked versions of Statements or recipes by using version number of the form “x-[dateStamp]”. Purely experimental data can have version number of “x-ignore”. This data can be anything, and should be ignored in normal processing.
IRI	http://xapi.jisc.ac.uk/recipeVersion
Data Type	String
Value Space	Version number found on recipe page, follows Semantic Versioning.
Sample Value	1.0

Session id

Label	Session id
Description	Local identifier for the internet session
IRI	http://xapi.jisc.ac.uk/sessionId
Data Type	String
Value Space	Session id as reported by the VLE
Sample Value	32456891

Sub Type

Label	Sub Type
Description	Identifies the sub genre of any Activity Type.
IRI	http://xapi.jisc.ac.uk/subType
Example in Statement template	Logged in
Data Type	IRI or String
Sample Value	http://id.tincanapi.com/activitytype/lms

Timetabled Event

Label	Timetabled Event
Description	Indicates whether or not a learning activity was scheduled.
IRI	http://xapi.jisc.ac.uk/event_timetabled
Example in Statement template	attendance
Data Type	Boolean
Value Space	1 for timetabled events, 0 for non-timetabled events
Sample Value	1

xAPI Profile Version

Label	Jisc Profile Version
Description	Version number of the xAPI Jisc Profile being used; found on homepage of the current Github repository.
IRI	http://xapi.jisc.ac.uk/version
Data Type	String
Value Space	A version number as specified on homepage the Github homepage for the Jisc xAPI, for example "1.0".
Sample Value	1.0

5.0 CourseArea properties

CourseArea indicates the academic context in which the Activity is situated (for example umbrella course, or parent area). The properties in courseArea must be a UDD Module Instance ID or a VLE Module ID or both.

Example:

      	"http://xapi.jisc.ac.uk/courseArea": {
			"http://xapi.jisc.ac.uk/vle_mod_id": "LA101",
			"http://xapi.jisc.ac.uk/uddModInstanceID": "LA101-200-2016S1-0",
		},

UDD Module Instance ID

Label	UDD Module Instance ID
Description	An identifier for a module instance The value should correspond to the UDD module_instance.MOD_INSTANCE_ID identifier that identifies the relevant module in UDD compliant data.
IRI	http://xapi.jisc.ac.uk/uddModInstanceID

VLE Module ID

Label	VLE Module ID
Description	Property that connects a courseArea in a VLE with a module. It is used in the module_VLE_map entity of the UDD to link module instances to course areas. Note that several module instances (as identified by their UDD MOD_INSTANCE_ID) can link to one courseArea.
IRI	http://xapi.jisc.ac.uk/vle_mod_id

Files

vocabulary.md

Latest commit

History

vocabulary.md

File metadata and controls

JISC Learning Analytics Statements and Vocabulary

Table of Contents

1.0 Verb

Attended

Completed

Logged in

Logged out

Scored

Session timed out

Viewed

2.0 Result

2.1 Result Extensions

Attendance Late

Attendance Category

Grade

3.0 Object

3.1 Activity Types

Application

Assessment

Chat

Course

Event

External Content

External URL

File (Deprecated as of 1.0. Use Content instead )

Lecture

Module

Other

Study Goal Statistics

Tutor session

VLE

VLE content

VLE forum

VLE page

VLE quiz

4.0 Object Definition and Context Extensions

Application Type (Deprecated)

Course area

DateTime

Device Location

Due Date

Duration

Event Mandatory

Event Max Count

Event Type Description

Event Type ID

IP address

Planned End Time

Planned Start Time

Recipe Version (deprecated since 1.0)

Session id

Sub Type

Timetabled Event

xAPI Profile Version

5.0 CourseArea properties

UDD Module Instance ID

VLE Module ID