Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mandatory statements templates #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ This documentation intends to describe assessment profile defined by the Gaia-X

## Statements

### Participation

All these statements are **MANDATORY** in order to comply with this profile.
> Note: mandatory statements are `cmi5 defined` statements (see [specification definition](https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#713-types-of-statements) for more information)

- [Launched](./statements/mandatory/launched.md)
- [Initialized](./statements/mandatory/initialized.md)
- [Completed](./statements/mandatory/completed.md)
- [Passed](./statements/mandatory/passed.md)
- [Failed](./statements/mandatory/failed.md)
- [Terminated](./statements/mandatory/terminated.md)

### Detailed completion actions

All these statements are **HIGHLY RECOMMENDED**.

### Other actions

All these statements are **OPTIONAL**.


## Contributors

| Github user | Name | Company/Institution |
Expand Down
147 changes: 147 additions & 0 deletions profile/profile.jsonld
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
]
}
65 changes: 65 additions & 0 deletions statements/mandatory/completed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Completed

## Description

The learner viewed or did all of the relevant activities in an assignment, by experiencing all relevant materials.
The criterion for determining relevant learning materials is defined by the course designer.
For a given assignment in a given course registration, not multiple `completed` statements can be generated for a given learner.

## 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/cmi.interaction",
"name": {
"en": "How much do you know about xAPI?"
}
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "https://w3id.org/xapi/quiz",
"definition": {
"type": "http://adlnet.gov/expapi/activities/profile"
}
}
]
}
},
"result": {
"completion": true,
"duration": "PT16.36S"
},
"timestamp": "2016-06-09T15:34:26.887Z"
}
```

## Determining properties

| Property | Value |
|----------------|-----------------|
| verb.id | Must be `http://adlnet.gov/expapi/verbs/completed` |
| object.definition.type | Must be `http://adlnet.gov/expapi/activities/cmi.interaction` |

## Rules

- `context.contextActivities.category`: INCLUDED, MUST contain an activity with the `https://w3id.org/xapi/quiz` id.
- `result.score`: EXCLUDED.
- `result.success`: EXCLUDED.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure?

Copy link
Contributor Author

@quitterie-lcs quitterie-lcs May 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the responsibility of passed and failed statements to carry this information

- `result.completion`: INCLUDED.
- `result.duration`: INCLUDED.
- `timestamp`: INCLUDED.
59 changes: 59 additions & 0 deletions statements/mandatory/failed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Failed

## Description

The user has attempted and failed an assessment.
For a given assignment in a given course registration, not multiple `failed` statements can be generated for a given learner.

## Examples

```json
{
"actor": {
"account": {
"name": "john",
"homePage": "http://gaiax.org"
}
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/failed"
},
"object": {
"id": "http://gaiax.org/xapi/activities/12d4f3f2-58e0-4a42-b3c6-b9b9cd7b0a7c",
"definition": {
"type": "http://adlnet.gov/expapi/activities/cmi.interaction"
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "https://w3id.org/xapi/quiz",
"definition": {
"type": "http://adlnet.gov/expapi/activities/profile"
}
}
]
}
},
"result": {
"success": false,
"duration": "PT16.36S"
},
"timestamp": "2016-06-09T15:34:26.887Z"
}
```

## Determining properties

| Property | Value |
|----------------|-----------------|
| verb.id | Must be `http://adlnet.gov/expapi/verbs/failed` |
| object.definition.type | Must be `http://adlnet.gov/expapi/activities/cmi.interaction` |

## Rules

- `context.contextActivities.category`: INCLUDED, MUST contain an activity with the `https://w3id.org/xapi/quiz` id.
- `result.success`: INCLUDED, MUST be set to `False`.
- `result.duration`: INCLUDED.
- `timestamp`: INCLUDED.
61 changes: 61 additions & 0 deletions statements/mandatory/initialized.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Initialized

## Description

The assignment has been fully initialized.
It is the first statement generated for an assignment session.
It is followed within a reasonable period of time by a `launched` statement.
For a given assignment, not multiple `initialized` statements can be generated.

## 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/cmi.interaction",
"name": {
"en": "How much do you know about xAPI?"
}
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "https://w3id.org/xapi/quiz",
"definition": {
"type": "http://adlnet.gov/expapi/activities/profile"
}
}
]
}
},
"timestamp": "2016-06-09T15:34:26.887Z"
}
```

## Determining properties

| Property | Value |
|----------------|-----------------|
| verb.id | Must be `http://adlnet.gov/expapi/verbs/initialized` |
| object.definition.type | Must be `http://adlnet.gov/expapi/activities/cmi.interaction` |

## Rules

- `context.contextActivities.category`: INCLUDED, MUST contain an activity with the `https://w3id.org/xapi/quiz` id.
- `result.score`: EXCLUDED.
- `result.success`: EXCLUDED.
- `result.completion`: EXCLUDED.
- `timestamp`: INCLUDED.
Loading