External tool settings

External tool


Add a new external tool to a course

A preconfigured tool 'Chemistry quiz' shown in the activity chooser

  1. With the editing turned on, in the section you wish to add your external tool, click the "Add an activity or resource" link and choose either 'External tool' or a preconfigured tool.
  2. This will take us to the settings page titled "Adding a new external tool". All settings may expanded by clicking the "Expand all" link top right.
  3. If the external tool has not been configured by the administrator, we will need to have in advance the correct URL, consumer key and secret. These should have been provided to you by the managers of the LTI-compliant website we are going to be connecting to. Click "Show more" to access the consumer key and secret fields.

General settings

The following settings are available by clicking ""Show more":

Privacy settings

(These settings are collapsed by default)

Site administration settings

Adding a tool site-wide

An administrator can manually configure external tools in Site administration > Plugins > Activity modules > External tool> Manage tools so that they are available across the site.

A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.

Registering a tool using a cartridge

We can register a tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add'. We will be asked to enter a key and secret. If you don't have them, we can leave them blank and press save changes.

Registering an external tool

To register an external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add'.

This will open the tool, which may in turn ask us to decide on some settings.

Then we will be shown the capabilities the tool wants to use and we can decide if you want to allow the tool or not.

Viewing more details

On the 'Manage tools' page we can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:

We can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities. 1. Click 'Configure a new external tool registration'

2. Configure the details on the settings page:

'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:

4. After obtaining a success message, click to complete the process:

5. If all requirements are met then we will be able to register automatically.

6. Now go to Site administration > Plugins > Activity modules > External tool > Manage external tool types and click the 'Pending tab'

7. Click the tick/checkmark to activate it:

See the screencast External tool registration for a demonstration of the above steps.

External tool capabilities