FAQ content

LTI: Add the Automagic LTI tool to Canvas

In this article

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

As with most instructions for other vendors' products, instructions may be a bit different, depending on the version of Canvas you're using. The general idea of the thing should hold true, though:

  • You can set the tool up at the Account or Sub-Account level, depending on your Canvas setup.
    • Account level: Tool is available in all courses throughout the whole system.
    • Sub-Account level: Tool is available in all courses within that Account (i.e., a large University may have Sub-Accounts for each school within the University; you can set the tool up for a specific school / Sub-Account).
  • You must use the LTI 1.3 Tool in LibApps to set this up in Canvas in order to get the placements set up properly.
  • Placements are the areas in the system where you can access the tool. The Automagic tool is placed / available for the Course Navigation.

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 provide your Canvas admins with this configuration information for the Automagic tool or create them 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 Canvas.

  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 Canvas after this tool is installed, so choose wisely! If you choose to change the tool after installing it in Canvas, 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 disabled).
  5. Select Canvas 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.canvas.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 JSON URL and Redirect URI values.
recording the configurationd 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 JSON URL and Redirect URI values.
recording the configurationd 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 Canvas admins are configuring things there, review the documentation and configure the tool / add some test metadata on the LibApps / LibGuides side as well.


Add the Tool to Canvas

With the version 1.3, Automagic set up in LibApps, and the JSON URL and Redirect URI values in hand, you can continue the setup within Canvas.

  1. Go to Admin > Select the appropriate Account or Sub-Account - wherever you'd like to set it up.
  2. In Account Navigation, click the Developer Keys link.
  3. Click the Add Developer Key button, click the Add LTI Key option.
selecting the LTI key option for developer keys
  1. Record the Key Name: the name to give the tool in Canvas.
  2. Enter the Redirect URI for the tool using the URI from LibApps.
  3. Under the Configure heading, select Enter URL from the Method dropdown.
  4. Enter the JSON URL for the tool using the JSON URL from LibApps.
  5. Click Save.
configuring the key settings for the lti tool within Canvas
  1. For the newly added Developer Key, copy the Client ID from the Details column.
    • This will be used to add the tool to a course.
copying the client id for the created key
  1. Return to Admin > Select the appropriate Account or Sub-Account.
  2. Go to Settings > Apps and click the Add App button.
  3. On the Add App window, choose By Client ID from the Configuration Type dropdown.
  4. Paste in the Client ID for the key that was created.
  5. Click Submit.
adding the single-course app to canvas

Find the Tool in Canvas

When using the Automagic LTI tool in a Canvas course, you'll find it in the Course Navigation.

This tool is an "opt-out" type of placement vs. an "opt-in" type of placement, meaning it's going to appear in every course navigation menu automatically. Instructors/course editors can edit their course navigation to remove it if they wish.

The name of the tool is the name given in your LibApps > LTI Tool Builder > LTI Automagic > Setup Options area. Remember, once it's added to Canvas, you cannot use the LibApps options to change the name or description. So make sure it has the appropriate name before it's added to Canvas.

Example Canvas course with automagic tool pointed out in the navigation
Example Automagic tool added to a Canvas course