External tool activity settings
    • 01 Nov 2022
    • 4 minutes to read

    External tool activity settings


    Article Summary

    When adding an external tool to a course you can configure the following settings and custom parameters.

    External tool settings

    Setting
    Description
    Notes

    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 page

    Choose to show the description along with the activity name.

    -

    Display activity name when launched

    Have this appear when the learner clicks the link.

    -

    Display activity description when launched

    Have this appear when the Learner clicks the link.

    -

    Preconfigured tool

    This 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 URL

    This is the URL of the external tool you are connecting to.

    -

    Secure launch URL

    Similar 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 key

    The 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 secret

    For 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 parameters

    Custom 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 URL

    The 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 email 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 tool

    Specify 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 to learn more.

    -

    Restrict access

    See restrict access to learn more.

    -

    Tags

    See tags to learn more.

    -

    Custom parameters

    VariableSource

    $Context.id

    Course id (system generated)

    $Context.title

    Course fullname

    $Context.label

    Course shortname

    $Context.sourcedId

    Course idnumber

    $Context.longDescription

    Course summary

    $Context.timeFrame.begin

    Course start date

    $CourseSection.title

    Course fullname

    $CourseSection.label

    Course shortname

    $CourseSection.sourcedId

    Course idnumber

    $CourseSection.longDescription

    Course summary

    $CourseSection.timeFrame.begin

    Course start date

    $User.id

    User id (system generated)

    $User.username

    User profile username

    $Person.name.full

    User profile first name + surname

    $Person.name.given

    User profile first name

    $Person.name.family

    User profile surname

    $Person.email.primary

    User profile email address

    $Person.sourcedId

    User profile idnumber

    $Person.name.middle

    User profile middle name

    $Person.address.street1

    User profile street

    $Person.address.locality

    User profile city

    $Person.address.country

    User profile country

    $Person.address.timezone

    User profile timezone

    $Person.phone.primary

    User profile phone 1

    $Person.phone.mobile

    User profile phone 2

    $Person.webaddress

    User profile URL

    $Membership.role

    Comma 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 = $Person.name.full

    acme_tool_course_id = $Context.sourcedId

    acme_tool_user_roles = $Membership.role

    © Copyright 2024 Totara Learning Solutions. All rights reserved. Some content originally obtained via GPLv3 license and continues to be available under GPLv3. All other content is the sole copyright of Totara Learning Solutions. 


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.