Adding the Manual LTI tool to Brightspace / Desire2Learn

The Manual LTI tool allows you to embed Guide content, Database links, and/or E-Reserves Courses into Brightspace / Desire2Learn (D2L).

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 need to set up the Tool Provider / which Org Units can access it.
  • Next you need to set up the Link to use within the system & define which Org Units can use it.
  • Finally, you can set up a (or several) link(s) to the tool within a master course, if you wish. Or just let course authors/editors know the link is 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 their 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. Go to LibApps:
    • Either log in using your LibApps Login URL, or
    • Log into any Springshare product and click the blue menu > choose LibApps.
  2. Go to Admin > LTI Tool Builder.
  3. On the LTI Manual Mode tab, review / modify the Setup Options.
  4. Then review the Configuration Details. Send your Brightspace / D2L admins the following fields:
    • LTI Launch URL
    • LTI Consumer Key
    • LTI Shared Secret

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

LTI Tool Builder > Manual Mode configuration / setup 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 Automagic 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.

The role is critical to the Manual tool, however, in order for authorized course editors to make the initial selection of content to display / edit that selection. If the tool does not know that the user is an authorized editor, it will not allow the user to select content, which will result in an 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 Manual 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 Manual Tool or Library Guides Manual Tool.
      • URL => LTI Launch URL (lti_launch_manual.php)
      • 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 / your role in the course in order to select content, etc. If you'd like to test it out, add the link to a course and then click it. You should then see the selection tool appear and can select content to display.

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

If you'd like, you can add one or more instances of the manual tool to your course's navbar.

  1. Go to Course Admin > Navigation and Themes.
  2. Go to Custom Links.
  3. If you only want to add one link, click Create Link & fill out the form.
    • The Name field will be how 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.
  4. If you want to create multiple links for a menu, click Create Link Group.
    • The Name field will be how it appears in the navbar.
    • In the Links section, click Create Link.
      • The Name field will be how it appears in the navbar's submenu.
      • Use the Insert Quicklink button to add the tool.
      • Behavior must be New window/tab.
      • Choose External Learning Tools > click the tool name (the name given in the "Tool Link" section above).
      • Fill out the rest of the form as you wish and click Create.
    • Once you've added all of the links you want to have in the menu, click Save.
  5. Now go to Navbars > Edit your navbar.
  6. Click Add Links > Custom Links or Custom Groups and use the search box to find your newly added link / group.
    • Check off the box for the link/group you want to add.
    • Click Add.
    • Reorder the new link/group in the nav bar.
    • Click Save and Close.
  7. Now that the links are set up, you need to set the link to display the content you want to display. Click each link in the navbar and select which content you'd like to display when students click this link.
Adding a link group to a navbar.
Examples of a single link and link group in the navbar.

Adding it to the Content Area

  1. In a module in the Content area, click Existing Activities > External Learning Tools > Select the Manual tool.
  2. Click the down arrow next to the tool's name and select Edit Properties In-place.
  3. Rename the tool to whatever you'd like - the name of the content you'll select is a good option, or something like "Research Guide", etc.
  4. Check off Open as External Resource. (Must be checked in order to view content.)
  5. Click the down arrow again > View Topic.
  6. Click Open in New Window and select the content you'd like to display when students click this link.
Adding an Existing Tool to the Content area of a course.
Editing the title / description and selecting the option to open in a new window.

Related Articles