How do I configure the External Tool (LTI) settings?

If your External Tool has not already been configured by your system administrator, and you have the appropriate permissions to add or configure external tools, you may configure the tool in your site. Site members who are not site owners cannot access the configuration screen for the tool. Also, in some cases, institutions choose to limit external tool configuration permission to admins.

The External Tool configuration within an individual course or project site (as opposed to the administrator-configured External Tools for the system within the Administration Workspace) should only be used to set up LTI 1.1 tools. LTI 1.3 / Advantage tools should be configured by your system administrator.

Go to External Tool (LTI).

Select External Tool from the Tool Menu of your site.

Click Edit.

Configuring the External Tool settings

The site owner can set up a link to any external tool by configuring the External Tool (LTI) manually. When you make arrangements with an external tool provider, they will provide you with a launch URL for the tool, key, and a secret. Enter these values as

  1. Remote Tool Url,
  2. Remote Tool Key, and
  3. Remote Tool Secret respectively.

Once you have entered these values into the tool, it can properly sign launch requests.

Caution: Do not share these values with other members of the site.

Configure the Display Information.

  1. Complete the Set Tool Title field.
  2. Optionally, click Choose an icon for this tool to select an custom icon for the external tool.

Configure Gradebook settings.

To configure the external tool to send information to the Gradebook, enter a title for the gradebook item to be created.

Configure Launch Window Information.

  1. Check Open in a New Window to open the tool in a new window.
  2. Enter an iFrame Height in pixels to set the frame to a particular size.
  3. Activate Debug Launch to displays the launch data each time the external tool is used. This feature is helpful if troubleshooting the tool configuration.

Release user information.

The external tool configuration also includes the ability to send or suppress user identity information to the external tool, such as the user's name or email address. Check

  1. Send Names to the External Tool,
  2. Send Email Addresses to the External Tool, and/or
  3. Allow the External Tool to retrieve the course roster

to release this information to the external tool.

Splash Screen (Optional)

Add information to the Splash Screen field to display custom text to users before they are redirected to the external tool.

Note: This field is plain text only. HTML is not allowed.

Custom Launch Parameters (Optional)

Set custom launch parameters in the Custom Launch Parameters field.

Click Update Options to save your configuration settings.