Percipio External Content Sync

Administration tool ::: tool_percipioexternalcontentsync

Maintained by

Lushonline Consulting

If you are looking for the official Skillsoft Percipio Plugin please search for mod_percipio A tool to allow sync of assets from a Skillsoft Percipio site as External content activities using Percipio Content Discovery API. A Percipio site could contain 40,000 or more assets, this tool allows all these to be synched easily to Moodle. Working with the Skillsoft team you can limit the assets that are included in the sync using the Content Selection Process. The schedule task runs the sync process which will create/update or deactivate a Moodle Course, consisting of a Single External content activity for each asset synched from Percipio, more details can be found in How it works. The External content Activity and Course are setup to support Moodle Completion based on completion information sent as xAPI statement to the External content activity module LRS from Percipio.

Latest release: 13 months

2 sites

Current versions available: 1

Download

A tool to allow sync of assets from a Skillsoft Percipio site as External content activities using Percipio Content Discovery API.

A Percipio site could contain 40,000 or more assets, this tool allows all these to be synched easily to Moodle. Working with the Skillsoft team you can limit the assets that are included in the sync using the Content Selection Process.

The schedule task runs the sync process which will create/update or deactivate a Moodle Course, consisting of a Single External content activity for each asset synched from Percipio, more details can be found in How it works.

The External content Activity and Course are setup to support Moodle Completion based on completion information returned from Percipio using xAPI if EXTERNAL_MARKCOMPLETEEXTERNALLY column if Percipio supports sending a completed xAPI statement to the External content activity module LRS.

Requirements

To use this plugin you will need:

Your Moodle site must accessible over the Internet, using HTTPS and a SSL Certificate from a recognised Public Certificate Authority to be able to get results for the Percipio content via the basic LRS functionality provdied by External content activity module.
A Skillsoft Percipio Site
A Percipio Service Account with permission for accessing the CONTENT DISCOVERY API
A LRS Connection Configured by Skillsoft to connect to the basic LRS functionality provdied by External content activity module. You will need to share the information from Moodle with Skillsoft.

IMPORTANT : Skillsoft may require you to pay fees to enable the LRS connection and utilise the APIs. Please contact Skillsoft for information.

Installation

Install the External content activity module:
```
git clone https://github.com/lushonline/moodle-mod_externalcontent.git mod/externalcontent
```
Or install via the Moodle plugin directory:

https://moodle.org/plugins/mod_externalcontent
Install the plugin the same as any standard moodle plugin either via the Moodle plugin directory, or you can use git to clone it into your source:
```
git clone https://github.com/lushonline/moodle-tool_percipioexternalcontentsync.git admin/tool/percipioexternalcontentsync
```
Or install via the Moodle plugin directory:

https://moodle.org/plugins/tool_percipioexternalcontentsync
Configure the plugin.

Configuration

The following configuration settings need to be set in Moodle.

Name	Setting	Description
Percipio Base URL	baseurl	This is the base URL for accessing the Percipio API. See Skillsoft Documentation, this should be either https://api.percipio.com or https://dew1-api.percipio.com. The Skillsoft Team will provide this information.
Percipio OrgId	orgid	This is a UUID that is unique to the Percipio Site. The Skillsoft Team will provide this information.
Percipio Bearer	bearer	The Percipio API uses a Bearer token for authentication. This should be the unique bearer token created for you to use. The Skillsoft Team will provide this information.
Return assets updated since	updatedsice	This ISO8601 date time (yyyy-mm-ddTHH:MM:SSZ) is passed to the API to determine the assets to return based on when they were updated on Percipio. For example to get all the assets since December 20th 2021 at 10:00:00 UTC you would enter 2022-12-20T10:00:00Z. If left blank all items are returned. After successful sync the value is set to the time of the sync.
Max assets per request	max	The Percipio API returns a paged data set of assets. This controls the number returned for each page. The default and maximum is 1000.
Parent Category	category	When the assets are added to Moodle, sub-categories will be created automatically. This configures the parent category to create them under.
Course thumbnail	coursethumbnail	The Percipio asset contains a URL to a thumbnail image. This setting controls whether this thumbnail is downloaded and added to the Moodle Course. If this is not selected the time taken to sync a lot of assets is reduced.
Mustache teamplate	templatefile	The Percipio asset is formatted using a Mustache template to produce the course and external content description in HTML, and the HTML for the content property. There is a default template configured in `templates/content.mustache`, you can copy and edit this template and then upload it here to change the HTML produced.

The scheduled task is configured to run at 03am every day.

How it works

When the task runs the process is:

Send Percipio API request using updatedSince value.
Percipio API will return a JSON response with max assets, and headers to indicate total assets to be returned.
Plugin will process the returned JSON array of assets and take following actions for each:
1. Process the asset metadata using the selected Mustache template, either default of the custom uploaded to create a Course and External Content Activity.
2. Check Category for the asset is not null.
  1. Category exists under the Parent Category configured, skip.
  2. Category does not exist under the Parent Category configured, create a new category under the parent.
3. Lookup up Course using Moodle Course ID Number matches xapiActivityID from Percipio
  1. Course does not exist create it
  2. Course exists and the properties in Moodle are the same as from Percipio, skip.
  3. Course exists and the properties in Moodle are not the same as from Percipio, update the course overwriting values in Moodle.
    1. If the Percipio assets is no longer active the course is hidden.
  4. If the category is not empty, move the course to the category. If it is empty move the course to the parent category.
4. Lookup Moodle External Content Activity where activity ID Number matches xapiActivityID from Percipio
  1. External Content Activity does not exist create it
  2. External Content Activity exists and the properties in Moodle are the same as from Percipio, skip.
  3. External Content Activity exists and the properties in Moodle are not the same as from Percipio, update the activity overwriting values in Moodle.
5. Check Course Thumbnail, if coursethumbail setting is enabled.
  1. Course does not have thumbnail image, add the thumbnail URL and Moodle will download the image.
  2. Course has thumbnail image, and the thumbnail URL in Moodle is the same as from Percipio, skip.
  3. Course has thumbnail image, and the thumbnail URL in Moodle is not the same as from Percipio add the new thumbnail URL and Moodle will download the image.
If the JSON response indicates there are more assets to download go back to Step 2.

IMPORTANT: The first time the task runs it can take a number of hours, as Percipio can have upwards of 40,000 assets.

More details

For more information for how Percipio asset data is mapped to Course and External Content Activities using the Mustache Template see the details in Github here.