You're looking at an older version of Totara Learn.

Please see Totara 15 help for the latest version.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space TL25PMS and version 12

The external tool activity in Totara Learn lets you incorporate content from external LTI tool providers. 

LTI stands for Learning Tools Interoperability, which is a standard for developing and integrating external learning applications with a learning platform, such as Totara Learn. Using LTI, external learning applications can receive data from and send data to your Totara Learn site.

Content creators can add an external tool directly to a course. Alternatively, a Site Administrator can add one at the system level, so that Course Creators can reuse it throughout the site, which is great for shared applications.

Totara Learn supports LTI 1.0, LTI 1.1 and LTI 2.0.

Add an external tool (to a course)

To add an external tool to your course page:

  1. Click Turn editing on.
  2. Select External Tool from the Add an activity/ resource menu.
  3. Enter the activity name, this is the name that appears on the course page for learners.
  4. Customise the available settings, see External tool settings to learn more.
  5. Click Save and display (or Save and return to course).

External tool settings 

Activity name

Give the title you wish the learners to see on the course page.

Activity description

Give a short description here.

Display description on course pageChoose to show the description along with the activity name.-
Display activity name when launchedHave this appear when the learner clicks the link.-
Display activity description when launchedHave this appear when the learner clicks the link.-
Preconfigured toolThis is how Totara communicates with the tool provider. If in doubt, leave as default.-
Select content

If enabled, this button allows you to configured any tool specific settings, whereas previously you would have had to launch the tool to do this. 

Tool URLThis is the URL of the external tool you are connecting to.-
Secure launch URLSimilar to Launch URL, but used instead of the launch URL if high security is required. Totara will use the secure launch URL instead of the launch URL if the Totara site is accessed through SSL, or if the tool configuration is set to always launch through SSL. The Launch URL may also be set to an https address to force launching through SSL, and this field may be left blank.-
Launch container

This is how the external tool will be displayed. The options are:

  • Default: If in doubt; leave as default.
  • Embed: The external tool will be embedded in the Totara course page with blocks and navigation bar.
  • Embed without blocks: The external tool will be embedded in the Totara course page, but without blocks.
  • New Window: The external tool will open in a new window.
Consumer keyThe consumer key must be provided by the tool provider. The method of obtaining a consumer key varies between tool providers. It may be an automated process, or it may require a dialogue with the tool provider. Tools which do not require secure communication from Totara and do not provide additional services (such as grade reporting) may not require a resource key.-
Shared secretFor pre-configured tools, it is not necessary to enter a shared secret here, as the shared secret will be provided as part of the configuration process. This field should be entered if creating a link to a tool provider which is not already configured. If the tool provider is to be used more than once in this course, adding a course tool configuration is a good idea.-
Custom parametersCustom parameters are settings used by the tool provider. For example, a custom parameter may be used to display a specific resource from the provider. Each parameter should be entered on a separate line using a format of "name=value"; for example, "chapter=3". It is safe to leave this field unchanged unless directed by the tool provider.See more in the Custom parameters section below. 
Icon URLThe icon URL allows the icon that shows up in the course listing for this activity to be modified. Instead of using the default LTI icon, an icon which conveys the type of activity may be specified. If Totara is accessing Totara through SSL then use the secure icon URL field.-
Share launcher's name with the tool

Specify whether the full name of the user launching the tool should be shared with the tool provider. The tool provider may need launchers' names to show meaningful information within the tool.

This setting may be overridden in the tool configuration.

Share launcher's email with the tool

Specify whether the e-mail address of the user launching the tool will be shared with the tool provider. The tool provider may need launcher's email addresses to distinguish users with the same name, or send emails to users based on actions within the tool.

This setting may be overridden in the tool configuration.
Accept grades from the toolSpecify whether the tool provider can add, update, read, and delete grades associated only with this external tool instance. Some tool providers support reporting grades back to Totara based on actions taken within the tool, creating a more integrated experience.This setting may be overridden in the tool configuration.
Common module settings

See Common module settings to learn more.

Activity completion

See Activity Completion 1 to learn more.

Restrict access

See Restrict access to learn more.


See Tags to learn more.


Custom parameters 

$Context.idCourse id (system generated)
$Context.titleCourse fullname
$Context.labelCourse shortname
$Context.sourcedIdCourse idnumber
$Context.longDescriptionCourse summary
$Context.timeFrame.beginCourse start date
$CourseSection.titleCourse fullname
$CourseSection.labelCourse shortname
$CourseSection.sourcedIdCourse idnumber
$CourseSection.longDescriptionCourse summary
$CourseSection.timeFrame.beginCourse start date
$User.idUser id (system generated)
$User.usernameUser profile username
$ profile first name + surname
$ profile first name
$ profile surname
$ profile email address
$Person.sourcedIdUser profile idnumber
$ profile middle name
$Person.address.street1User profile street
$Person.address.localityUser profile city
$Person.address.countryUser profile country
$Person.address.timezoneUser profile timezone
$ profile phone 1
$ profile phone 2
$Person.webaddressUser profile URL
$Membership.roleComma separated list of roles. If the user has the capability mod/lti:manage in the activity, then Instructor is returned. Otherwise, Learner is returned. Also, if the user is a Site Administrator, then full URN or URI values are added to the list, depending on the version of LTI tool used.

As an example you could have three parameters like this:

acme_tool_user_fullname = $
acme_tool_course_id = $Context.sourcedId
acme_tool_user_roles = $Membership.role

Managing external tools

As a Site Administrator you can add and manage site-wide external tools, that is tools that will be made available for everyone to use. To access these settings from the Administration quick-access menu go to Plugins > Activity modules > External tool > Manage tools.

Add a new tool (at the site level)

You can add a new tool via two methods:

  • Enter the tool URL into the space provided and click the Add button
  • You can also click the configure a tool manually link to enter in the full settings yourself

 If On the Manage tools page you can do several important things. You can add a tool at the system/site level by adding the tool URL or by selecting the configure a tool manually link. You can also select Manage preconfigured tools to add preconfigured tools, or select Manage external tool registrations to configure new registrations.

Additionally, you can see a list of configured tools under the Tools heading.

Add a new tool (system level)

You can add and configure tools at the system level by following these steps:

  1. Log in as Site Administrator or Site Manager.
  2. Go to Quick-access menu > Plugins > Activity modules > External tool > Manage tools.
  3. On the Manage tools page, either enter the tool URL and select Add, or select the link configure a tool manually.

Manage tools page.Image Added

If you have an LTI cartridge then you can enter that URL (as in the first option of step 3 above) and all the required information will be automatically configured for you. 

When adding a new tool there are a number of configuration options, most of which are the same as when setting up an external course on a course (see above). However, there are some that differ such as:

Tool configuration usage

Content-Item MessageEnabling this option will mean the Select content button is active when this preconfigured tool is added to a course. The button will enable the trainer who is setting up the tool to access any specific configuration within Totara, rather than having to launch the tool to access additional configurations (as was previously the case). This helps ensure that learners do not end up being confronted with unconfigured tools (where the trainer had not realised additional configurations were required within the tool itself). -

You will need to complete the two mandatory fields (Tool name and Tool URL), but it is recommended that you configure each setting as required.

Configuring external tool settings.Image Added

Manage preconfigured tools

Both Manage preconfigured tools and Manage external tool registrations allow you to see which tools have been successfully configured, which ones are pending, and which ones have been rejected. 

Once you have added tools you will also be able to come into this section to register them (tick icon), edit their settings (cog icon) and delete them (cross icon). 

Manage external tool registrations

LTI (Experimental)

By using the LTI authentication plugin, together with the Publish as LTI tool enrolment plugin, you can allow remote users to access selected courses and activities. In other words, Totara functions as an LTI tool provider. Find out more (including set up) in the Publish as LTI tool section of the enrolment help page

titleOn this page

Table of Contents