Adding the Automagic LTI Tool to Desire2Learn (D2L) / Brightspace

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

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

  • First you set up the Tool Provider / which Org Units can access it. (If that hasn't already been done.)
  • Next you set up the Link to use within the system & define which Org Units can use it.
  • Finally, you can set up a link to the tool within a master course's navbar. Or just create the custom link and let course authors/editors know it's available to them to use.

First: Your D2L system must be configured to support LTI. If it's not yet configured to do that, your D2L admins can check out Brightspace's instructions.


LibApps: Get the Configuration Information

You must be a LibApps Admin to get the configuration information for your system.

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

  1. Log into any Springshare product and click the blue menu > choose LibApps.
  2. Go to Admin > LTI Tool Builder > LTI Automagic.
  3. Go to the Configuration Details section. Send your D2L admins the following fields:
    • LTI Launch URL
    • LTI Consumer Key
    • LTI Shared Secret

You do not need the Config URL for Desire2Learn. That is only used in Canvas.

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

LTI Tool Builder > Automagic configuration info screen

Set Up a Tool Provider

If you've previously set up a Tool Provider for LibApps (e.g., you set it up when adding the Manual tool), you do not need to add another one. You can skip ahead to adding a Link.

  1. Go to Admin Tools (the cog icon) > External Learning Tools > Manage Tool Providers.
  2. Click the New Tool Provider button.
    • Launch Point => LTI Consumer Key
    • Secret => LTI Shared Secret
    • Check off "Use custom tool consumer information instead of default".
      • Key => LTI Consumer Key
      • Name => Whatever you'd like to call it.
    • Visibility => Check off the "Allow users to use this tool provider." checkbox.
    • Security Settings - At a minimum, allow:
      • Send tool consumer information to tool provider.
      • Send context information to tool provider
      • Send LTI user ID and LTI role list to user provider.
      • Send link title to tool provider.
      • Send link description to tool provider.
      • Add Org Units that should have access to this tool provider. If a high level org unit with sub-org units, be sure to indicate that all sub-units should also have access to this tool provider.
  3. Click Save and Close.

Some of the items in the Security area are simply defaults in the system and are standard to enable, though there is one in particular that is required "Send LTI user ID and LTI role list to tool provider" must be checked off, or else you'll get an OAuth error. While the user ID is not required by our tool, if it is not sent, the result is that OAuth error.

New Tool Provider form filled out.

Adding a Tool Link

Now that your Tool Provider is set up, let's add a link for folks so they can use the Automagic tool in the system.

  1. Click Manage External Learning Tool Links OR (if you weren't already in the Learning Tools area...)
    Go to Admin Tools (Cog icon) > External Learning Tools.
  2. Click New Link.
  3. Fill out the form:
    1. Properties Section:
      • Title => This is used in the Quicklinks area, so make sure it's something recognizable for what the tool does, like LibGuides Automagic Tool or Library Guides Automagic Tool.
      • URL => LTI Launch URL (lti_launch_automagic.php?id=xxxx)
      • Visibility: check off the box to "Allow users to view this link".
    2. Key / Secret Section:
      • Signature => Check off Sign messages with key/secret with.
      • Select Link key/secret from the options below that.
    3. Security Settings Section:
      • Select Use tool provider security settings.
      • Add Org Units that should have access to this link. If a high level org unit with sub-org units, be sure to indicate that all sub-units should also have access to this link.
  4. Click Save and Close.

Do not try to use the "Preview Link" for this link, as our tool requires the context of a course in order to match content from LibGuides, etc. If you'd like to test it out, add the link to a course, make sure there is related metadata in LibGuides for that course, and then click the link. You should then see either the related guide or the Library LTI page appear, depending on the setup of the tool in LibApps.

Brightspace / D2L New Link form

Finding the Tool in D2L

One of the key things to note when using the LTI tool in D2L is that it must be set to open the link in a new window or the content will not display. We're not sure why. If any of you out there know the reason or figure out how to get it to display in the same window, please let us know!

Adding It to the Navbar for All Courses

Adding it to the default navbar for the system makes it easy to include library resources everywhere at once. If allowed in your system, course editors would need to edit their navbar to opt out of having the library link in their course navbar.

  1. Go to the System Tools (cog) menu > Navigation and Themes.
  2. Click on your default / custom navbar to edi tit.
  3. Click Add Links.
  4. Click Create Custom Link.
    • The Name field is the name of the link as it appears in the navbar.
    • Use the Insert Quicklink button to add the tool.
    • Choose External Learning Tools > click the tool name (the name given in the "Tool Link" section above).
    • Behavior must be New window/tab.
    • Fill out the rest of the form however you wish and click Create.
  5. Your new custom link should be automatically selected. If not, find it in the list and select it.
  6. Click Add.
  7. Reorder the link in the navbar, if you wish, and click Save and Close.

Adding It as a Custom Link for Courses

If you'd prefer to have an "opt in" workflow for adding library resources to navbars in courses, you can simply set up the Custom Link in the system so course editors can add it to their course navbar as they wish.

  1. Go to the System Tools (cog) menu > Navigation and Themes.
  2. Click Custom Links.
  3. Click Create Link.
    • The Name field is the name of the link as it appears in the navbar.
    • Use the Insert Quicklink button to add the tool.
    • Choose External Learning Tools > click the tool name (the name given in the "Tool Link" section above).
    • Behavior must be New window/tab.
    • Fill out the rest of the form however you wish.
  4. Click Save.

Course editors can simply edit their course navbar, Add Link, and look for the custom link in the list.

Adding a custom link to a navbar.
Create custom link form

Related Articles