davidpesce / moodle-mod_tincanlaunch

A Moodle plugin that allows the launching of xAPI content using the Rustici Launch Method.
45 stars 41 forks source link

xAPI Launch Link

A Moodle plug-in that allows the launch of xAPI content using a separate LRS.

Background

The plugin is called tincanlaunch because of the original research project called 'Project Tin Can'. At this point in time, the more commonly heard names of Tincan are the 'Experience API' and 'xAPI'. More details can be found here: https://xapi.com/tin-can-experience-api-xapi

One of the key issues in xAPI is launching content in such a way that the activity provider knows:

This project will utilize the most common launch method:

A second method will be considered as development continues, cmi5.

What you will need

To use this plugin, you will need the following:

Installation (Recommended)

It is recommended to get this plugin from the Moodle Plugins Database (https://moodle.org/plugins/mod_tincanlaunch)

This plugin is installed in the same way as any activity plugin. Download the zip file and navigate to Moodle System administration > Plugins > Install plugins.

Course set up

This plugin can be added to a course like any other course activity. Simply add an activity and select xAPI Launch Link from the list.

There are appearance settings that allow various launch settings.

The settings for this module all have help text which can be accessed by clicking the '?' icon next to that setting.

Using the plugin

Depending on the settings chosen during the activity setup, the learner will either directly launch the content (Simplified Launch) or be brought to a Registrations page (Single/Multiple Registrations).

Moodle will pass the xAPI content a registration ID as a universal unique ID (UUID) representing the previous attempt or a newly generated one for a new attempt. It's up to the xAPI content what it does with that data, but ideally, it will store its bookmarking state on a per-registration basis.

Note that the list of attempts is stored in the LRS, rather than Moodle, and can therefore be read and modified by another LMS or by the learning activity itself. Additionally, if another copy of the launch link is installed elsewhere on Moodle or even on another Moodle, the data will be shared so long as the user email and activity ID are the same.

FAQ

Where does the tracking data go?

Tracking data from the learning activity is stored in your LRS and can be retrieved and viewed using an xAPI-compliant reporting tool.

Why doesn't the plugin do x, y, or z?

If you'd like the plugin to do something, please raise an issue; perhaps someone within the community will develop it for you. If you want to make sure it happens or is done quickly, please email david.pesce@exputo.com if you'd like to hire us.

Reporting issues

Please report any issues with this plugin here: https://github.com/davidpesce/moodle-mod_tincanlaunch/issues Please provide screenshots of your settings (both at the plugin and instance level) and a link to your content.

The majority of issues are caused by incorrect settings. You can see previously closed issues here: https://github.com/davidpesce/moodle-mod_tincanlaunch/issues?q=is%3Aissue+is%3Aclosed