Brickfield Education Labs

Introduction

This Usertour Uploader tool provides the ability to import usertours easily in bulk. Otherwise, each usertour would need to be uploaded individually via the existing Moodle user tours interface. This tool includes a collection of popular and useful usertours, some community, and some custom.

 

It will show a list of the available usertours for importing, in which you can see whether they have already been imported or not. Once imported, these user tours are then stored and manageable as normal from the core Moodle user tours interface.

 

Furthermore, if an institution has a number of their own usertours, they can upload these same JSON files into the plugin’s /usertours/ folder, so they can also be imported via this interface.

Administration

This section is for the administration of the Usertour Uploader tool.

Version Support

This plugin is supported for Moodle versions 3.9, 3.11, 4.00, 4.01, 4.02, and 4.03.

Deployment

To install the Usertour Uploader tool (tool_bfusertour):

  1. Unzip and copy the bfusertour folder into Moodle’s admin/tool/ folder.
  2. Go to Site administration > Notifications to install the tool.

 

Further installation instructions can be found on the Installing plugins Moodle documentation page.

Capabilities

Capability name Manager
tool/bfusertour:tour: Able to access the user tour importer Allow

View capability

The capability “tool/bfusertour:tour” allows users with the relevant permissions for that context to view the Usertour Uploader tool.

 

This capability is granted by default to these following archetype roles, using system context:

  • Manager

Copyright and funding

This plugin has been developed, maintained, copyrighted, and funded by Brickfield Education Labs.

Usage as Site administrator

This involves importing user tours individually or in bulk through the usertours importer interface. After the user tours have been imported, they can be managed as usual.

Import user tours

To access the “Brickfield User Tours” page:

  1. Go to site administration.
  2. Click the Appearance tab.
  3. Click the Brickfield User Tours link.

 

The “Brickfield User Tours” page displays:

  • User Tours – the user tours table.
  • Import Selected User Tours – the button to import selected user tours.

 

The User Tours table displays the following for each user tour:

  • Select – the checkbox to select the user tours for importing.
  • Name of Tour – the user’s tour name.
  • Date Updated – the last date the user tour was updated.
  • Install Status – Indicates if the user tour has been installed.
  • The bulk import workflow in the bottom row – The checkbox in the final row for selecting all users tours to import in bulk.

Importing an individual user tour

To import an individual user tour:

  1. Click the checkbox in the user tours row.
  2. Click the Import Selected User Tours button.

Importing user tours in bulk

To import user tours in bulk:

  1. Click the Select all checkbox in the final row of the User Tours table.
    1. Alternatively, click the checkbox in the user tours row for each relevant user tour.
  2. Click the Import Selected User Tours button.
Brickfield User Tours table displaying four columns Select, Name of Tour, Date Updated, and Install Status per row for each user tour. In the Install Status column each usertour is marked as Not Installed.