diff --git a/README.md b/README.md index e9d01de..1932cde 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ This documentation intends to describe assessment profile defined by the Gaia-X ## Statements +### Completion + +All these statements are **MANDATORY** in ordre to comply with this profile. + +- [Started](./statements/mandatory/started.md) +- [Terminated](./statements/mandatory/terminated.md) +- [Answered a question](./statements/mandatory/answered-question.md) + +### Detailed completion actions + +All these statements are **HIGHLY RECOMMENDED**. + +### Other actions + +All these statements are **OPTIONAL**. + + ## Contributors | Github user | Name | Company/Institution | diff --git a/profile/profile.jsonld b/profile/profile.jsonld new file mode 100644 index 0000000..696b3c7 --- /dev/null +++ b/profile/profile.jsonld @@ -0,0 +1,147 @@ +{ + "id": "http://schema.dases.eu/xapi/profile/assessment", + "@context": "https://w3id.org/xapi/profiles/context", + "type": "Profile", + "conformsTo": "https://w3id.org/xapi/profiles#1.0", + "prefLabel": { + "en": "Assessment" + }, + "definition": { + "en": "Statements related to assessment activity on e-learning." + }, + "seeAlso": "", + "versions": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "generatedAtTime": "2023-01-10T20:28:48.429Z" + } + ], + "author": { + "type": "Organization", + "name": "Gaia-X Data Space for Education and Skills (DASES)", + "url": "https://www.dases.eu" + }, + "templates": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment/templates/started", + "type": "StatementTemplate", + "inScheme": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "prefLabel": { + "en": "started" + }, + "definition": { + "en": "The user has started an assessment. \nSuch statement can be generated on several contexts. The assessment is manually launched by the user and can be time limited. The assessment is directly available on the current page and it starts when the user chose or submitted a response for the first answer. " + }, + "verb": "http://activitystrea.ms/start", + "objectActivityType": "http://adlnet.gov/expapi/activities/assessment", + "rules": [ + { + "location": "$.timestamp", + "presence": "included" + } + ] + }, + { + "id": "http://schema.dases.eu/xapi/profile/assessment/templates/terminated", + "type": "StatementTemplate", + "inScheme": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "prefLabel": { + "en": "terminated" + }, + "definition": { + "en": "A moderator has terminated an assessment." + }, + "verb": "http://adlnet.gov/expapi/verbs/terminated", + "objectActivityType": "http://adlnet.gov/expapi/activities/assessment", + "rules": [ + { + "location": "$.timestamp", + "presence": "recommended" + } + ] + }, + { + "id": "http://schema.dases.eu/xapi/profile/assessment/templates/answered-question", + "type": "StatementTemplate", + "inScheme": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "prefLabel": { + "en": "answered a question" + }, + "definition": { + "en": "The user answered a question in the assessment." + }, + "verb": "http://adlnet.gov/expapi/verbs/answered", + "contextParentActivityType": [ + "http://adlnet.gov/expapi/activities/assessment" + ], + "rules": [ + { + "location": "$.timestamp", + "presence": "included" + }, + { + "location": "$.result.score.max", + "presence": "recommended" + }, + { + "location": "$.result.score.min", + "presence": "included" + }, + { + "location": "$.result.success", + "presence": "recommended" + }, + { + "location": "$.result.response", + "presence": "recommended" + }, + { + "location": "$.result.score.scaled", + "presence": "recommended" + }, + { + "location": "$.object.definition.interactionType", + "presence": "included" + } + ] + }, + { + "id": "http://schema.dases.eu/xapi/profile/assessment/templates/initialized", + "type": "StatementTemplate", + "inScheme": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "prefLabel": { + "en": "initialized" + }, + "definition": { + "en": "A moderator has initialized an assessment." + }, + "verb": "http://adlnet.gov/expapi/verbs/initialized", + "objectActivityType": "http://adlnet.gov/expapi/activities/assessment", + "rules": [ + { + "location": "$.timestamp", + "presence": "included" + } + ] + }, + { + "id": "http://schema.dases.eu/xapi/profile/assessment/templates/completed", + "type": "StatementTemplate", + "inScheme": "http://schema.dases.eu/xapi/profile/assessment/v/1", + "prefLabel": { + "en": "completed" + }, + "definition": { + "en": "The user has successfully completed its assessment. The user has answered all the questions necessary for an evaluation. The assessment is sent to evaluation or has been evaluated but the user can no longer attempt the assessment until being allowed by the assessment administrator." + }, + "verb": "http://adlnet.gov/expapi/verbs/completed", + "objectActivityType": "http://adlnet.gov/expapi/activities/assessment", + "rules": [ + { + "location": "$.timestamp", + "presence": "included" + } + ] + } + ] +} \ No newline at end of file diff --git a/statements/mandatory/answered-question.md b/statements/mandatory/answered-question.md new file mode 100644 index 0000000..77bf97d --- /dev/null +++ b/statements/mandatory/answered-question.md @@ -0,0 +1,64 @@ +# Answered a question + +## Description + +The user answered a question in the assessment. + +## Examples + +```json +{ + "actor": { + "account": { + "name": "john", + "homePage": "http://gaiax.org" + } + }, + "verb": { + "id": "http://adlnet.gov/expapi/verbs/answered" + }, + "object": { + "id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c", + "definition": { + "interactionType": "choice" + } + }, + "context": { + "contextActivities": { + "category": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment", + "definition": { + "type": "http://adlnet.gov/expapi/activities/profile" + } + } + ], + "parent": [ + { + "id": "http://gaiax.org/xapi/activities/0f5c4525-8778-4403-8e3e-b75c4feed309", + "definition": { + "type": "http://adlnet.gov/expapi/activities/assessment" + } + } + ] + } + }, + "timestamp": "2016-06-09T15:34:26.887Z" +} +``` + +## Properties + +- `verb.id`: INCLUDED, must be `http://activitystrea.ms/start` +- `context.contextActivities.parent`: MUST contain an activity with the `http://adlnet.gov/expapi/activities/assessment` definition.type. + +## Rules + +- `object.definition.interactionType`: INCLUDED, must be specified. +- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id. +- `result.score.min`: RECOMMENDED. +- `result.score.max`: RECOMMENDED. +- `result.score.scaled`: RECOMMENDED. +- `result.success`: RECOMMENDED. +- `result.response`: RECOMMENDED. +- `timestamp`: INCLUDED \ No newline at end of file diff --git a/statements/mandatory/completed.md b/statements/mandatory/completed.md new file mode 100644 index 0000000..6c04a2b --- /dev/null +++ b/statements/mandatory/completed.md @@ -0,0 +1,54 @@ +# Completed + +## Description + +The user has successfully terminated its assessment. +The user has answered all the questions necessary for an evaluation. +The assessment is sent to evaluation or has been evaluated but the user can no longer attempt the assessment until being allowed by the assessment administrator. + +## Examples + +```json +{ + "actor": { + "account": { + "name": "john", + "homePage": "http://gaiax.org" + } + }, + "verb": { + "id": "http://adlnet.gov/expapi/verbs/completed" + }, + "object": { + "id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c", + "definition": { + "type": "http://adlnet.gov/expapi/activities/assessment", + "name": { + "en": "How much do you know about xAPI?" + } + } + }, + "context": { + "contextActivities": { + "category": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment", + "definition": { + "type": "http://adlnet.gov/expapi/activities/profile" + } + } + ] + } + }, + "timestamp": "2016-06-09T15:34:26.887Z" +} +``` +## Properties + +- `verb.id`: INCLUDED, must be `http://adlnet.gov/expapi/verbs/completed` +- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`. + +## Rules + +- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id. +- `timestamp`: INCLUDED \ No newline at end of file diff --git a/statements/mandatory/initialized.md b/statements/mandatory/initialized.md new file mode 100644 index 0000000..70a3b08 --- /dev/null +++ b/statements/mandatory/initialized.md @@ -0,0 +1,52 @@ +# Initialized + +## Description + +A moderator has initialized an assessment. + +## Examples + +```json +{ + "actor": { + "account": { + "name": "john", + "homePage": "http://gaiax.org" + } + }, + "verb": { + "id": "http://adlnet.gov/expapi/verbs/initialized" + }, + "object": { + "id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c", + "definition": { + "type": "http://adlnet.gov/expapi/activities/assessment", + "name": { + "en": "How much do you know about xAPI?" + } + } + }, + "context": { + "contextActivities": { + "category": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment", + "definition": { + "type": "http://adlnet.gov/expapi/activities/profile" + } + } + ] + } + }, + "timestamp": "2016-06-09T15:34:26.887Z" +} +``` +## Properties + +- `verb.id`: INCLUDED, must be `http://adlnet.gov/expapi/verbs/initialized` +- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`. + +## Rules + +- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id. +- `timestamp`: INCLUDED \ No newline at end of file diff --git a/statements/mandatory/started.md b/statements/mandatory/started.md new file mode 100644 index 0000000..c868d27 --- /dev/null +++ b/statements/mandatory/started.md @@ -0,0 +1,56 @@ +# Started + +## Description + +The user has started an assessment. +Such statement can be generated on several contexts. +The assessment is manually launched by the user and can be time limited. +The assessment is directly available on the current page and it starts when the user chose or submitted a response for the first answer. + +## Examples + +```json +{ + "actor": { + "account": { + "name": "john", + "homePage": "http://gaiax.org" + } + }, + "verb": { + "id": "http://activitystrea.ms/start" + }, + "object": { + "id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c", + "definition": { + "type": "http://adlnet.gov/expapi/activities/assessment", + "name": { + "en": "How much do you know about xAPI?" + } + } + }, + "context": { + "contextActivities": { + "category": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment", + "definition": { + "type": "http://adlnet.gov/expapi/activities/profile" + } + } + ] + } + }, + "timestamp": "2016-06-09T15:34:26.887Z" +} +``` + +## Properties + +- `verb.id`: INCLUDED, must be `http://activitystrea.ms/start` +- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`. + +## Rules + +- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id. +- `timestamp`: INCLUDED \ No newline at end of file diff --git a/statements/mandatory/terminated.md b/statements/mandatory/terminated.md new file mode 100644 index 0000000..96d3a2c --- /dev/null +++ b/statements/mandatory/terminated.md @@ -0,0 +1,53 @@ +# Terminated + +## Description + +A moderator has terminated an assessment. + +## Examples + +```json +{ + "actor": { + "account": { + "name": "john", + "homePage": "http://gaiax.org" + } + }, + "verb": { + "id": "http://adlnet.gov/expapi/verbs/terminated" + }, + "object": { + "id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c", + "definition": { + "type": "http://adlnet.gov/expapi/activities/assessment", + "name": { + "en": "How much do you know about xAPI?" + } + } + }, + "context": { + "contextActivities": { + "category": [ + { + "id": "http://schema.dases.eu/xapi/profile/assessment", + "definition": { + "type": "http://adlnet.gov/expapi/activities/profile" + } + } + ] + } + }, + "timestamp": "2016-06-09T15:34:26.887Z" +} +``` + +## Properties + +- `verb.id`: INCLUDED, must be `http://adlnet.gov/expapi/verbs/terminated` +- `object.definition.type`: INCLUDED, must be `http://adlnet.gov/expapi/activities/assessment`. + +## Rules + +- `context.contextActivities.category`: MUST contain an activity with the `http://schema.dases.eu/xapi/profile/assessment` id. +- `timestamp`: INCLUDED \ No newline at end of file