Show Advanced KnowledgeHide Advanced Knowledge

xAPI Learning Module Object

If you need any help in filling out this wiki page, please visit our ILIAS Community FAQ.

1 Initial Problem

A primary requirement for xAPI is to include content in accordance with the cmi5 specification. cmi5 (The cmi5 Project) is a “profile” for using the xAPI specification with traditional learning management (LMS) systems and describes interoperable runtime communication between LMS and Assignable Units (AU). The cmi5 project was formally transferred in 2014 from AICC (Aviation Industry Computer-Based Training Committee) to the Advanced Distributed Learning (ADL) Initiative which is the leader in the field of standardization of e-learning technologies.

LMS requirements to conform to the specification are as follows:

• Implement an LRS as defined in the xAPI specification.
• Implement additional "State API" requirements to initialize the AU state.
• Implement the runtime launch interface.
• Implement additional xAPI "Statement API".
• Implement additional xAPI "Agent Profile API".
• Implement course structures.

The specification has functionalities similar to those previously available for SCORM learning modules without the complexity of SCORM 2004.
A short overview can be found here: EduTechWiki. Also helpful for orientation is this comparison of cmi5 with SCORM,

A sub-object appears to be necessary with the justifications that were initially introduced with the xAPI Standard Object.

2 Conceptual Summary

For users, cmi5 generally means a simplification compared to xAPI in three ways:

1. Details like Activity ID do not have to be given, as the LMS is responsible anyway. If content is uploaded, information about key and secret will also be omitted.
2. The orientation is facilitated because a certain set of verbs is given.
3. Much is known from SCORM (Zip file upload etc.), with many setting options omitted.

The specification describes requirements with the terms "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", "MAY" and "NEED NOT". In a first development step, the "must" requirements are to be fullfilled and, in addition, taking into account the practical experience with SCORM. One such requirement in practice is the display of the points achieved in the learning progress - a challenge in learning modules with many AU / SCO, which are very rare in practice.
For this we recommend the following simplification: If the learning module consists of only one AU, the achieved score is displayed during the learning progress (if available). If the learning module consists of many AUs, the number of AUs with ILIAS status 'completed' is used. If the condition for the status 'completed' is to be fine-tuned, the learning module with only one AU uses the obligatory masterScore. For a multi-AU learning module, the mastery_score would be tagged with a language variable such that the percentage of AUs with status 'completed' determines the overall status of the learning module.

A big advancement in cmi5 is that the multilingualism of learning modules is provided in the specification (languagePreference). Here we would orientate ourselves on the language set in ILIAS and provide English as a second language. An adjustment option is not mandatory for this. Because the XML file of the content may contain values for several languages (title, description, objectives), metadata are necessary. If available for the language the user has set for ILIAS, metadata should be provided on the info-page in the suitable language.

When integrating content, we see three options:

• Upload only the XML file
• Upload the ZIP file
• Selection of content from a content upload directory analogous to SCORM learning module.

Note: The upload directory must be specified in the administration under Learning Modules, but can only be used by administrators when creating SCORM learning modules. This is not satisfactory, because the upload directory in addition to the advantages in terms of possible file size and ftp use in practice offers a significant advantage: With SCORM, the zip file is unpacked on the server when uploading from local directory, but remains and therefore needs storage space. When using the upload directory, the zip file remains in the upload directory and is only unpacked. This saves storage space. Another option for minimizing required storage space is the link with which the repeated creation of objects can be avoided. Unfortunately, the right to join is linked to the right to delete, which is why in practice, course administrators often can not link a repository-based SCORM learning module to their course. The right to delete should be restricted. From the point of view of content management, especially with regard to the new configuration options for the xAPI Learning Module, it would be advantageous if the right to link could be decoupled from the right to delete (see Permission to link object). The upload directory is just an incomplete replacement.

The xAPI learning module object supports also Learning Progress and therefore certificates.

We would like to use a separate icon for this sub-object.

3 User Interface Modifications

3.1 List of Affected Views

{Please list all views (screens) of ILIAS that should be modified, newly introduced or removed.}

3.2 User Interface Details

Create Object

Settings for launch mode, mastery score and window

3.3 New User Interface Concepts

none

4 Technical Information

none

5 Contact

• Author of the Request: Kohnle, Uwe [ukohnle]
• Maintainer: Kohnle, Uwe [ukohnle]
• Implementation of the feature is done by: Kohnle, Uwe [ukohnle]

6 Funding

If you are interest in funding this feature, please add your name and institution to this list.

• DoD NL

7 Discussion

JourFixe, ILIAS [jourfixe], 29 JUL 2019 : We highly appreciate this suggestion and schedule the feature for 6.0. We keep the discussion open if we call this type of learning module xAPI Learning Module or CMI5 Learning Module. Please also support the upload of an individual picture for the tile view (as well as for the standard object).

8 Implementation

{The maintainer has to give a description of the final implementation and add screenshots if possible.}

Test Cases

Test cases completed on 2019-12-08 by Kohnle, Uwe [ukohnle]

• 32136: cmi5 Lernmodul einbinden von lokalem Verzeichnis
• 32137: cmi5 Lernmodul einbinden über Upload-Verzeichnis

Approval

Approved at 26 Nov 2019 by Bakker, Onno [onnobakker].