FAQ content

LTI: Add the Automagic LTI Tool to Blackboard

In this article

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

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

  • First, you need to set up the Tool Provider as an approved provider.
  • Next, you need to set up the Placements: where in the system can folks use this tool.

Please note, the Deployment ID value from Blackboard will be needed to complete the tool setup in LibApps, so it is best to work through both steps of the setup process (in LibApps and in Blackboard) at the same time.


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 Blackboard 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 Single-Course tool

If no Automagic tool using Version 1.3 exists in your system, you can create a new tool to use in Blackboard.

Please note that only one Version 1.3 Automagic tool can be configured for Blackboard, so once you have created one that will be the tool to use.

  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 Blackboard after this tool is installed, so choose wisely! If you choose to change the tool after installing it in Blackboard, you'll need to reinstall it, which will break all existing connections.
  2. Set the Tool Description.
    • ‚ÄčThis field will not update in Blackboard after this tool is installed, so choose wisely! If you choose to change the tool after installing it in Blackboard, you'll need to reinstall it, which will break all existing connections.
  3. Choose to enable the Custom Header/Footer (or keep disabled).
  4. Choose to enable the Custom JS/CSS (or keep disabled).
  5. Select Blackboard 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.blackboard.com
  7. Select Automagic Matching for the Tool Type.
  8. Click Save.
    • After saving the page will reload and you will see a new, empty Deployment ID field. This field will be filled out with a value from Blackboard that you will get when setting up the tool in Blackboard.
configuring the version 1.3 automagic lti tools options
  1. Click on the Configuration tab. Record/copy the Client ID and Tool Provider URL values.
    • The Client ID will be needed when adding the tool to Blackboard.
    • And the Tool Provider URL will be needed when creating a placement for the tool in Blackboard.
recording the configuration details for a version 1.3 automagic tool
  1. Return to the Tool Settings tab and keep this window open as you will need to record the Deployment ID from Blackboard.

Use the existing Version 1.3 Automagic tool

Please note that only one Version 1.3 Automagic tool can be configured for Blackboard. If one has been set up already that will be the tool to use.

  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 Client ID and Tool Provider URL values.
    • The Client ID will be needed when adding the tool to Blackboard.
    • And the Tool Provider URL will be needed when creating a placement for the tool in Blackboard.
recording the configuration details for a version 1.3 automagic tool
  1. Return to the Tool Settings tab and keep this window open as you will need to record the Deployment ID from Blackboard.

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 Blackboard 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 Tool Provider

  1. From the Blackboard Administrator Panel, select LTI Tool Providers under Integrations.
  2. Select Register LTI 1.3 Provider.
  3. Enter the Client ID for the tool that you copied from the Configuration tab in LibApps in the Client ID field.
  4. Click Submit.
adding the tool provider in Blackboard, part 1
  1. From the Modify LTI 1.3 Tool page, copy the Deployment ID value.
recording the deployment id from blackboard
  1. Return to the window where you have the Tool Settings tab in LibApps open and paste the Deployment ID value into the Deployment ID field.
  2. Click Save and return to the window where you are setting up the tool provider within Blackboard.
adding the deployment id from blackboard to the tool settings in libapps
  1. From the Modify LTI 1.3 Tool page, set the Tool Status to Approved and click Submit.
saving the tool provider in Blackboard

Add Placement

After the tool has been configured in LibApps and added as a tool provider in Blackboard, the next step is to add a placement for the tool. The placement allows you to set the Tool Provider URL for the tool, which is required in order to use the tool in Blackboard.

  1. From the LTI Tool Providers page in Blackboard, open the menu for the tool you just added and choose Manage Placements.
  2. Click Create Placement.
  3. Fill out the placement information fields:
    1. Label: Name as you'd like it to appear in the course options.
    2. Handle: Unique identifier for the placement.
    3. Availability: Set to "Yes" to make the placement available to course builders and instructors.
    4. Type: Select the preferred type -- Course Tool is recommended for Automagic.
  4. Enter the Tool Provider URL from the Tool Setting in LibApps in the Tool Provider URL field.
  5. Click Submit.
placement information and tool provider information fields

Add it to the Course Navigation

At this point, it's up to you whether you want to add it to all courses globally or allow each instructor to add it manually to their course's navigation.

Add Globally

  1. Go to System Admin > Course Settings > Course Menu and Structures.
  2. Click the + button and select Tool Link (in the upper left of the default menu on the screen).
    • Name: Whatever name you'd like to appear in the course menu.
    • Check off the Available to Users checkbox (if it isn't already checked).
    • Type: Find the Label you gave the tool when you set up the Placement, and choose it.
    • Click Submit.
  3. Reorder the Automagic page wherever you'd like in the course menu structure.

Add in Individual Courses

If you would prefer to have the tool in the course nav be opt-in vs. opt-out, instructors and other course editors can add it to the navigation manually. They'd follow the same basic instructions as above: once in their course, click + > Tool Link, give it a name, select the Tool from the dropdown, and check off the Available to Users checkbox.

Adding the tool to the default course menu in Blackboard

Find the Tool in Blackboard

Once it's been added, you'll find the link in the navigation menu for each course.  

Example of where to find the Automagic tool link in the course navigation
Example of where to find the Automagic tool link in the course navigation