Automagic LTI Tool setup options

There are 2 major pieces when customizing the Automagic LTI tool:

  1. Customizing the general setup / how it functions.
  2. Customizing the options on the Library LTI Page.

This FAQ takes you through the first part: options for the general setup.

Getting there...

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

  1. Go to LibApps: Log into any Springshare app, click the blue menu > choose LibApps.
  2. Go to Admin > LTI Tool Builder > LTI Automagic.
  3. LTI Automagic Setup Options is open by default; options are discussed below.

Getting to the LTI Automagic area of LibApps.

Modify Name & Description before adding to your Learning Management System (LMS):

The Name & Description field must be set up before you add it to your LMS (Blackboard, Canvas, Desire2Learn, Moodle, Sakai, etc.). Not every LMS actually uses these fields, but for the ones that do (like Canvas), it's a one-time addition. If you want to change it after initial installation, you'd need to remove the tool and re-add it to your system.

  • Click the text with the blue dashed underline to make it editable.
  • Make whatever changes you'd like and click the blue checkmark to save.
Editing the Description field

Custom Header / Footer and Custom JS/CSS:

These options allow you to display (or not) your header & footer from LibGuides and/or apply (or not) the CSS/code in your LibGuides Custom JS/CSS box. They are Disabled by default. These fields can be altered at any time - before or after the tool is added to your LMS. 

Please be aware that these options do not affect your Library LTI Page itself. They only affect the display of guides & course pages.

Custom Header / Custom CSS display options.

Content Display Behavior

Like the options just above, these options can be changed at any time - before and/or after the Automagic tool is added to your LMS. In fact, it's the best way to really get a feel for what they do!

The description takes a little time to read through / wrap your head around. There's a file attached to this FAQ (at the bottom of the screen) that walks you through how it all works in flowchart form. You may want to download it / read through it as you also read through this section.

Before we get into the Content Display Behavior options, it's good to have an understanding of the default display behavior. Once the tool has run the search (matching LMS value to LibGuides metadata), it sends all matches (or lack thereof) to the LMS. Default display is as follows:

Content Display Behavior options
  • If a single guide OR course match is found, that guide OR course loads.
  • If multiple guide and/or course matches are found (one of each; multiple of one/both), the Library LTI Page loads with all matches listed. If a subject match is also found, the Database link and Subject Expers areas are customized for that subject.
  • If neither guide nor course matches are found, the Library LTI Page loads with no guides or courses listed. (Only the Database link and any additional sections you opt to display in the Library LTI Page Builder section.)
  • If only a subject match is found, the Library LTI Page loads with the Database link and Subject Experts areas customized for that subject.

The options in the Content Display Behavior area allow you to change this default behavior however you'd like. Want to display a default guide if there are no matches? No problem! Always want to display the Library LTI Page, because you want people to have access to LibChat or booking rooms / appointments? You've got it! Want it all - a default guide and access to LibAnswers / LibCal widgets? You can have it all!


  • When no matches are found, display the following guide
    • This means there's no match on guide, course, or subject.
    • Check this box and a dropdown of Published guides from your LibGuides system appears.
  • Display the Library LTI Page when a single matching guide / course is found.
    • This overrides that first "default" display (when a single match is found, just display that thing) so everyone sees the Library LTI Page, even if just a single match is found.
    • Since you can add various LibAnswers and LibChat widgets to that page, it exposes your students to more library offerings / options / help.
  • When displaying the Library LTI Page, display a link to the following guide if no matching guides are found
    • This only relates to guide matches - if no guide match is found (there may be a course or subject match), you can display a link to a default guide.
    • Check this box and a dropdown of Published guides from your LibGuides system appears.

You can use one, two, or all three of these options together. How would all 3 work together?

  • If no matches are found whatsoever, a default guide displays. Maybe this is a guide about how to start research, generally speaking. It's a way to provide some help for courses where you may not have anything more specific...yet.
  • If only one match is found, instead of displaying that guide directly, point them instead to a page that provides additional help / makes them more aware of library services.
  • If a match on course and/or subject is found, but not a guide, you can display a default guide to help them on their way. Again, it could be that general guide on starting research.

No matter what, your students will never be given an error message or an empty page.

Related Articles