How do I make an LTI 1.1 tool available to site owners?

Note: Configuration of an external tool requires information unique to the external solution being integrated. In addition, integration with a solution from a third-party vendor may require an account with that vendor. Be sure to confirm all necessary information for an external solution before configuration.

Go to External Tools.

Select External Tools from the Tool Menu in the Administration Workspace.

View Installed Tools.

If any external tools have been configured and made available in your instance, you'll see them listed.

Click Install LTI Tool.

Click Install LTI Tool. The External Tool page displays.

The Install LTI Tool Page displays.

Enter a tool title and click Continue.

  1. Enter a Tool Title.
  2. If you want the external tool to be available in all sites, be sure to leave this field blank. (Enter the appropriate site ID in the Site Id field if you want the external tool to be available ONLY in that site.)

Enter the tool configuration settings.

  1. Edit text in the Tool Title field. When users access the tool in a site, this text displays at the top of the frame.
  2. (Optional) Enter text in the Description field. This description will display to site owners when they select the tool via Site Info.
  3. Select tool status Enabled or Disabled.
  4. Choose either Visible or Stealthed (Manual Deployment). Visible tools are available for selection by site owners in all sites. Stealthed tools are not available for selection unless deployed to a particular site. This is intended to allow admins to roll out experimental or limited release tools to selected sites.
  5. Enter a Launch URL. This is URL is obtained from the tool provider.
  6. Choose whether you want the tool to launch in a pop up (new window) Never, Always, or Allow popup to be changed.
  7. (Optional) Indicate a specific Frame Height. To specify a height for the tool frame in a site, enter a value (in pixels) in the field.
  8. (Optional) Select a custom icon for the tool. (Leave blank to use the default icon.)
  9. Select the launch message type. If this is a single tool, select The tool URL supports a single LTI tool (Resource Link launch). If this is a “store”, allowing a tool to be chosen from a “catalog” of tools, select The tool URL supports a "resource picker" experience with one or more tools (Deep Link launch).
  10. Choose where the tool should appear within the Sakai UI: Lessons, rich text editor, assignment types, site level navigation, or provide a common cartridge response.
  11. Indicate the desired Privacy Settings: Send usernames, send email addresses, and/or support privacy launch message.
  12. Select the desired Services: return grades, create grade columns, and/or provide roster to external tool.
  13. Choose the Debug mode. This is typically only enabled when testing.
  14. Specify if the Configuration dialog should be bypassed or shown.
  15. (Optional) Enter custom Splash screen information.
  16. (Optional) Enter Custom Parameters.
  17. (Optional) If needed, enter role information to Manually map Sakai roles to IMS roles.
  18. Choose if the tool supports LTI 1.1, LTI 1.3, or both LTI 1.1. and 1.3.
  19. Enter the Launch Key and Launch Secret.
  20. Click Save.

Note: If the external tool is added as a Stealthed tool, a Deploy Tool to Sites button displays at the top of the form, as shown in the image below. The deployment process using this button is the same as the process when selecting the number in the deployment column of the external tool listing. See How do I deploy a Stealthed LTI tool to a site or sites? for more information.