cmi5launch

A plug in for Moodle that allows the launch of cmi5 content which is then played in a cmi5 player and tracked to a separate LRS.

What you will need

To use this plugin you will need the following:

Moodle 4.0+
Login details for the admin account
A Moodle course setup where you would like to add the activity
A cmi5 package in compliance with the cmi5 Specification (https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md)
A Learning Record Store (LRS) as defined in the xAPI specification (https://opensource.ieee.org/xapi/xapi-base-standard-documentation)
A running instance of the cmi5 prototype player (https://github.com/adlnet/CATAPULT/tree/main/player)
A copy of this plugin

Installation Instructions

Once the plugin is downloaded, be sure it is entirely in a file named 'cmi5launch.' Then compress that file into zip. The zip file must be named 'cmi5_moodle.zip' to be uploaded to Moodle.

Install plugin in Moodle

To install the CMI5 plugin into Moodle -

Go to Site Administration
Go to Plugins
Click on Install Plugins
- Currently the only way to install plugin is via zip file
Under Install plugin from ZIP file upload the plugin. It must be in a zip file named 'cmi5_moodle.zip'.
- Follow the Moodle instructions to upload plugin to the site

Once Moodle has finished uploading the plugin it will brin up the cmi5 Launch Link settings page. This will enable you to set the information to connect to your LRS and instance of your running CMI5 player. These are the fields:

Endpoint
- The LRS endpoint, to enable the plugin to communicate with your LRS. Ex: https://lrsendpoint.com/data/xAPI/. Must include trailing forward slash.
LRS integration
- This is an optional dropdown for addtional LRS's. Defaults to 'None.'
LRS: Basic Username
- The basic username for connecting to your LRS.
LRS: Basic Password
- Your password for connecting to your LRS.
Duration
- Used with 'LRS integrated basic authentication'. Requests the LRS to keep credentials valid for this number of minutes. Default is set to 9000.
Custom account homepage
- If entered, Moodle will use this homePage in conjunction with the ID number user profile field to identify the learner. Defaults to https://moodle.com.
Identify by email
- If selected, learners will be identified by their email address if they have one recorded in Moodle.
cmi5 Player URL -The URL to communicate with the CMI5 player, can include port number(e.g. http://player.example.com or http://localhost:63398). Must NOT include a trailing forward slash.
cmi5 Player: Basic Username
- This is the tenant username for the CMI5 player
cmi5 Player: Basic Password
- This is the basic password to login to player. (IS this needed? check code - MB)
cmi5 Player: Bearer Token
- The cmi5 tenant bearer token (should be a long string).

There are two sections "Default ccalues foor CMI5 LAunch Link activity grades" and "Default values for CMI5 Launch Link activity attempts and completion." These can be ignored for now as they are works in progress for future features.

The plugin is now accessible as a resource to be added to a Moodle course! Under your Moodle courses in edit mode select Add activity or resource and you will see cmi5 Launch Link as an available option. Currently the Launch link can take a folder or XML compliant with cmi5 specification.

Flowchart

This flowchart shows the path a user takes to get to a cmi5 Lesson Link. Once the link is clicked, the cmi5 Player opens in a new tab or window. The Moodle Application negotiates the connection by supplying credentials, tenant, and the current user session information. The Lesson Link contains a token in which both sides can track the user.

flowchart TB
  subgraph MOODLE[Moodle Application]
    direction TB
    Course(Course) --> Assignment(Assignment) --> Activity --> Link
    Webhook[Progress\nEndpoint]
    subgraph Activity
      Link(Lesson Link)
    end
  end
  MOODLE -.-> MoodleDB[(Moodle DB)]

  subgraph cmi5[cmi5 Player]
    direction TB
    Lesson --> Lesson
  end

  cmi5 -.-> Webhook
  Link <---> cmi5
  Link -.-> LRS[(LRS)]
  cmi5 -.-> cmi5DB[(cmi5 DB)]
  cmi5 -.-> LRS

Sequence diagrams for connecting to CMI5 player

Following are the two functions Moodle uses to create a course and retrieve a course URL from the CMI5 player.

Create course

sequenceDiagram
    title: Create Course
    
    participant Moodle
    participant CMI5
    participant C-DB as CMI5's MySQL Database
    participant M-DB as Moodle's MySQL Database
   
    
    Moodle->>+CMI5: Send POST to /api/v1/course
    break error
    CMI5-->>+Moodle: response other than 200
    Note over Moodle, CMI5: Check content-type, package, or token
    end
    CMI5->>+C-DB: Create course in DB
    CMI5->>+Moodle: 200, returns JSON body
    Moodle->>+M-DB: Save lmsId, Id, course metadata

Retrieve launch URL

sequenceDiagram
    title: Retrieve URL
    
    participant Moodle
    participant CMI5
    participant M-DB as Moodle's MySQL Database
   
    
    Moodle->>+CMI5: Send POST to /api/v1/course/{courseId}/launchurl/{AU index}
    break error
    CMI5-->>+Moodle: response other than 200
    Note over Moodle, CMI5: Check actor account info, returnurl, token
    end
    
    CMI5->>+Moodle: 200, returns JSON body with session id, launch method, and launch url
    Moodle->>+M-DB: Save returned course info to DB

User progress

The cmi5 player tracks user progress by tracking whether an AU is satisfied or not. The LRS is a better way to track a users progress in any detail. Currently the Moodle plugin queries the LRS for progress. This in shows AUs as complete, in-progress, or not attempted. It also breaks down sessions into detail, ex; " The actor watched video at certain time".

adlnet / cmi5-player-moodle-plugin