FAQ content

LTI: Add the Automagic LTI Tool to Sakai

In this article

The Automagic LTI tool allows you to embed content from your LibGuides site into Sakai using matching vs. selecting content manually. A field from a Sakai course is compared with the metadata added to LibGuides, and any resulting matches are displayed in the Sakai course.

As with most instructions for other vendors' products, instructions may be a bit different, depending on the version of Sakai you're using. The general steps should be consistent, though:

  • First, you need to configure the external tool in your site administration.
  • Then, you need to add the tool to lessons.  
  • You should use the LTI 1.3 Tool in LibApps to set this up in Sakai in order to get the placements set up properly.

LibApps: Get the Configuration Information

The LibApps LTI Tool is available to CMS and E-Reserves subscribers. You must be a LibApps Admin to get the configuration information for your system.

You'll need to get your Sakai admins the configuration information for the Automagic tool or create an account in one of your Springshare apps and make them a LibApps Admin.

Create a new Automagic LTI tool

If no Automagic tools using Version 1.3 exist in your system or you want to create additional tools (you can create multiple tools, if needed), you can create a new tool to use in Sakai.

  1. Go to the LibApps Dashboard.
    • Log in using your LibApps login URL, or
    • Log into any of your Springshare products, click the blue menu on the left, and choose LibApps.
  2. Go to Admin > LTI Tool Builder.
    • LibApps Admins can access this area. If you are on the LibApps dashboard and do not see an Admin menu, you are not a LibApps Admin.
  3. Click the Add LTI 1.3 Tool button.
adding a new LTI 1.3 tool, part 1
  1. Set the Tool Name.
    • ‚ÄčThis field will not update in Sakai after this tool is installed, so choose wisely! If you choose to change the tool after installing it in Sakai, you'll need to reinstall it, which will break all existing connections.
  2. Set the Tool Description.
  3. Choose to enable the Custom Header/Footer (or keep disabled).
  4. Choose to enable the Custom JS/CSS (or keep it disabled).
  5. Select Sakai from the LMS dropdown.
  6. Enter your LMS Hostname.
    • The hostname must start with http:// or https://, without a path or trailing slash. For example: https://school.sakai.com
  7. Select Automagic Matching for the Tool Type.
  8. Click Save.
configuring the version 1.3 automagic lti tool options
  1. Click on the Configuration tab. Record/copy the Launch URL, LTI 1.3 Tool Keyset URL, LTI 1.3 Tool OpenID Connect, and LTI 1.3 Tool Redirect Endpoint(s) values.
    • These values will all be needed when adding the tool to Sakai.
recording the configuration details for a version 1.3 automagic tool

Use an existing Version 1.3 Automagic tool

  1. Go to the LibApps Dashboard.
    • Log in using your LibApps login URL, or
    • Log into any of your Springshare products, click the blue menu on the left, and choose LibApps.
  2. Go to Admin > LTI Tool Builder.
    • LibApps Admins can access this area. If you are on the LibApps dashboard and do not see an Admin menu, you are not a LibApps Admin.
  3. Click the View/Edit Tool () icon for the Version 1.3 Automagic tool.
getting to the configuration options for a version 1.3 automagic tool, part 1
  1. Click on the Configuration tab. Record/copy the Launch URL, LTI 1.3 Tool Keyset URL, LTI 1.3 Tool OpenID Connect, and LTI 1.3 Tool Redirect Endpoint(s) values.
    • These values will all be needed when adding the tool to Sakai.
recording the configuration details for a version 1.3 automagic tool

Prepare LibApps and LibGuides for the LTI integration

When testing this setup, you'll need to make sure that you have your Automagic tool configured in LibApps/LibGuides. While your Sakai admins are configuring things there, review the documentation and configure the tool / add some test metadata on the LibApps/LibGuides side as well.


Set Up the External Tool in Sakai

  1. In Sakai, go to Administration Workspace and click on External Tools.
  2. Click on the Install LTI 1.x Tool link.
going to the external tools page in Sakai
  1. On the External tool configuration page, adjust only the fields listed below, starting with the Tool Title.
    • This is what the tool will be called in Sakai. We recommend a descriptive name that will be easily identifiable by course creators.
  2. Allow tool title to be changed: Set to Allow.
  3. Button text (Text in tool menu): Enter the text of your choosing.
  4. Launch URL: Enter the Launch URL value for the LTI tool from LibApps.
  5. Indicate where these tools are placed in Sakai: Select the checkboxes for Allow the tool to selected from Lessons and Allow the tool to be one of the assignment types.
  6. Tool supports LTI 1.3: Select this radio button.
  7. LTI 1.3 Tool Keyset URL: Enter the LTI 1.3 Tool Keyset URL value for the LTI tool from LibApps.
  8. LTI 1.3 Tool OpenID Connect/Initialization Endpoint (provided by the tool): Enter the LTI 1.3 Tool OpenID Connect value for the LTI tool from LibApps.
  9. LTI 1.3 Tool Redirect Endpoint(s) (comma separated and provided by the tool): Enter the LTI 1.3 Tool Redirect Endpoint(s) value for the LTI tool from LibApps.
  10. Click Save.
adding the values for a new external tool in Sakai

Add the tool a lesson

Now that the tool is configured, it needs to be placed into a lesson so that students can access your LibGuides content from it.

  1. While editing a course, go to Lessons.
  2. Click the Add Content link.
adding content to a lesson.
  1. Click the Add External Tool link from the Add Content modal.
selecting an external tool.
  1. Select your LTI tool from the External Tool Selector list.
selecting your lti tool for the lesson
  1. On the Configure External Tool modal, set the Tool Title.
  2. Set the Button Text.
  3. Click Save.
setting the title for the lti tool