Sakai 21 - External Tool (LTI): How do I configure the External Tool (LTI) settings?

Skip navigation
Welcome to PLU’s Knowledge Base, a resource for online help documents. To get started, enter a keyword into the search bar and press the Enter key. Documents related to your search will appear in a results list. Please contact for assistance.

Topics Map > Sakai > Sakai 21 Help > External Tool (LTI)

Sakai 21 - External Tool (LTI): How do I configure the External Tool (LTI) settings?


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

Go to External Tool (LTI).

Select the External Tool (LTI) from the Tool Menu of your site.

Click on Edit.

When you enter the External Tool initially, you will see a message saying that it has not yet been configured.

Click on the Edit icon in the upper right hand corner of the tool, near direct link and Help icons.

Configure 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. These values must be entered as part of the configuration of the tool. Make sure not to reveal these values to the other members of the site. Once you have entered these values into the tool, it can properly sign launch requests. Site members who are not site owners cannot see the configuration screen for the tool.

Display Options

You can indicate the button text and tool title location here. You may also select an icon for the tool from the Choose an icon for this tool drop-down menu.

Gradebook Settings

If you want the tool to send information to the Gradebook, you can enter a Gradebook Item here. Or, you can select an existing Gradebook Item from the drop-down menu.

Optional Launch Window Information

  1. Check the box for 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. Some newer tools may require you to Enable SHA-256 Signatures. Check this option to enable if appropriate.
  4. You may also opt to set it to Debug Launch, which displays the launch data and can be helpful in troubleshooting the tool configuration.

User Information

The External Tool (LTI) 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. In addition, you can set the frame size, as well as the button and title text for the tool from the configuration screen. (If the tool you are working with was created by a system administrator, they may have already pre-configured and locked a number of the configuration options for the tool.)

Storing Tool Settings (Optional)

This option allows the external tool to store and retrieve its own settings.

Splash Screen (Optional)

If you would like to display custom text to users before they are redirected to the external tool, you may enter it here.

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

Custom Launch Parameters (Optional)

If you would like to add custom launch parameters, you may do so here.

Click Update Options to save your configuration settings.

Keywords    Doc ID115751
OwnerSean H.GroupPacific Lutheran Univ
Created2022-01-12 16:51:47Updated2023-10-09 14:25:40
SitesPacific Lutheran University
Feedback  0   0