Add an external tool on a Lessons page

From Sakai Help

Instructors can add links to external tools, or LTI items, on a Lessons page. This allows instructors to seamlessly incorporate content from third party applications within the site.

Contents

Go to Lessons

Go to Lessons.png

Click on the Lessons page title in the Tool Menu to display the page.

Note: The default or blank Lessons page contains text and images that explain the basic functionality of the Lessons tool.

Click Add Content, then Add External Tool

Click Add Content, then Add External Tool..png

From the Add Content drop-down menu, select Add External Tool.

Specify the external tool

Select a tool from items already configured for your institution

Select a tool from items already configured for your institution.png

If your institution has already configured one or more external tools at the system level, you may choose from any of the tools listed here.

To add it to the Lessons page, click on the tool title.

And then click Save

And then click Save.png

The external tool will now appear on the Lessons page

The external tool will now appear on the Lessons page.png

Or, click Manage of Install Tools to add a new tool

Or, click Manage of Install Tools to add a new tool.png

If there are no system level tools, or the tool you would like to add does not appear in the list, click on the Manage or Install Tools link to configure a new tool for your site only.

Click Install LTI 1.1 Tool

Click Install LTI 1.1 Tool.png

Enter a tool title

Enter a tool title.png

This is the title of the link as it will display on your Lessons page.

Choose whether or not the title can be changed

Choose whether or not the title can be changed.png

Choose a custom icon (Optional)

Choose-custom-icon.jpg

Enter the button text

Enter the button text.png

This is the title of the tool as it will display if added to the Tool Menu in the site.

Choose whether or not the button text can be changed

Choose whether or not the button text can be changed.png

Add a description of the external tool

Add a description of the external tool.png

Specify whether or not the tool is enabled

Specify whether or not the tool is enabled.png

Enter the Launch URL

Enter the Launch URL.png

The Launch URL is provided by the external tool application provider.

Specify whether or not the launch URL can be changed

Specify whether or not the launch URL can be changed.png

Enter the Launch Key

Enter the Launch Key.png

The launch key is provided by the external tool application provider. It is unique to you.

Specify whether or not the launch key can be changed

Specify whether or not the launch key can be changed.png

Enter the Launch Secret

Enter the Launch Secret.png

The launch secret is provided by the external tool application provider. The launch secret is a unique value.

Specify whether or not the launch secret can be changed

Specify whether or not the launch secret can be changed.png

Enter Frame Height (Optional)

Enter Frame Height. (Optional).png

Enter a specific frame height if desired. Otherwise, leave blank to use the default height.

Select the tool order (Optional)

Select the tool order. (Optional).png

If you want the tool to appear in a specific order, use the up and down arrows to select the order. Otherwise, leave blank to use the default order.

Specify whether or not the frame height can be changed

Specify whether or not the frame height can be changed.png

Choose whether or not you want the configuration dialog to display when the tool is selected

Choose whether or not you want the configuration dialog to display when the tool is selected.png

Specify Privacy settings

Specify Privacy settings.png

Check the boxes next to the settings you want to enable.

Note: Most LTI tools require user names if there is a grade associated with the activity.

Specify Services

Specify Services.png

Check the boxes next to the services you want to enable.

Note: If you plan to collect grade information, be sure to select Allow External Tool to return grades

Specify Content Item Selection launches

Specify Content Item Selection launches.png

Note: Be sure to check to see if your external tool is capable of Content Item launches before selecting those options, as not all tools support this type of launch.

Specify Popup preference

Specify Popup preference.png

Specify Debug preference

Specify Debug preference.png

Launching in debug mode is typically only used for advanced troubleshooting or application development purposes.

Custom launch parameters (Optional)

Custom launch parameters. (Optional).png

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

Splash Screen (Optional)

Splash Screen. (Optional).png

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.

Click Save to save your tool configuration settings

Click Save to save your tool configuration settings.png

The new tool will now appear in the list when you go to Lessons > Add External Tool

The new tool will now appear in the list when you go to Lessons ) Add External Tool.png

To add it to the Lessons page, click on the tool title.

And then click Save

And then click Save 1.png

The external tool link will appear on the Lessons page

The external tool link will appear on the Lessons page.png

More questions about the Lessons tool?


Sakai.png

This page is adapted from an equivalent Sakai Community help article.

The original Sakai Community help article, unedited, is available at https://sakai.screenstepslive.com/s/sakai_help