How to set up ProQuest as an External Tool within Canvas using LTI 1.3 Deep Linking Technology 

 

This page will guide you through the process of setting up ProQuest as an External Tool within Canvas. Once completed, your Canvas users will be able to search for ProQuest documents from within Canvas, select them, and embed them directly for viewing within Canvas courses. The advantage of this method is that users will be able to read external documents from ProQuest without leaving Canvas, and users will not be prompted to authenticate. 

 

This process will take approximately 20 minutes. If you experience difficulties or errors during the set up process, please reach out to ProQuest Technical Support 

 

Before you begin, make sure you have the following information at hand: 

 

Step 1 - Create a Developer Key in Canvas 

  1. Log into Canvas with your system administrator username and password. 

  1. Select the Admin option on the left side of the screen and select the first option under the Admin heading in the menu that appears. 

  1. Select Developer Keys from the menu on the left side of the screen.  

  1. Select the + Developer Key button to add a new Developer Key. Pick + LTI Key from the dropdown menu. This will load a new page with a form titled Key Settings. 

 
User-added image 
 

  1. On the left column of the Key Settings page, add a value for the Key Name. This can be any name you’d like. Users will not see this name; it is only for your later reference. You can use a name like “ProQuest Key” or similar. 

  1. On the left column of the Key Settings page, in the Redirect URIs field, enter https://sso-authenticate.prod.proquest.com/ltiLaunch 

  1. Under the Configure heading to the right, use the Method dropdown menu and select Manual Entry (this could be the default selection). 

  1. Under Title, enter the name you would like your users to see for this External Tool (e.g. ProQuest Platform). This can be any name you want, but try to choose a name that your users will recognize and understand. 

  1. Under Description, enter a description of the database tool you are adding. This can be any description you want. Again, enter a description that is understandable to your users. 

  1. In the Target Link URI field, enter https://sso-authenticate.prod.proquest.com/ltiLaunch 

  1. In the OpenID Connect Initiation Url field, enter https://sso-authenticate.prod.proquest.com/oidcLogin 

  1. Using the JWK Method dropdown menu, select Public JWK URL. 

  1. For Public JWK URL enter https://sso-authenticate.prod.proquest.com/.well-known/jwks.json 

  1. Open the Additional Settings section.  In the Domain field, enter proquest.com 

  1. Also within Additional Settings, set a Selection Height and Selection Width to be used for the window that will display the ProQuest session. These are pixel values. You can choose whatever values you want, but we recommend a Selection Height of 700 and a Selection Width of 1000, which will work well for laptop devices. 

  1. Under Placements, if there is not already a value added for Link Selection in the dropdown menu, you will need to add one. select Link Selection from the dropdown, a Link Selection section will be added below. 

  1. In the same Placements dropdown menu, select and add Assignment Selection and Editor Button. Your Placements menu should now appear like this: 

User-added image 

 

  1. Open the Link Selection section and paste the following URL in the Target Link URI field: https://www.proquest.com/ltiDeepLinkSelect/embedded/$LOGIN_TOKEN 

 

NOTE: This URL will set up access to the ProQuest Platform, which will allow your Canvas users to cross-search across all your subscribed ProQuest databases. While we strongly recommend this option, you can set up access to only a specific database on the ProQuest K-12 platform.  To do so, replace the Target Link URl with the desired option below.  

 

ProQuest Platform 

Target Link URl  

ProQuest Platform - all databases 

RECOMMENDED 

https://www.proquest.com/ltiDeepLinkSelect/embedded/$LOGIN_TOKEN 

eLibrary only 

https://explore.proquest.com/svc/grapple/ltiDeepLinkCreate/elibrary/embedded/$LOGIN_TOKEN 

SIRS Issues Researcher only 

https://explore.proquest.com/svc/grapple/ltiDeepLinkCreate/sirsissuesresearcher/embedded/$LOGIN_TOKEN 

SIRS Discoverer only 

https://explore.proquest.com/svc/grapple/ltiDeepLinkCreate/sirsdiscoverer/embedded/$LOGIN_TOKEN 

 

  1. Under the Select Message Type heading, select the LtiDeepLinkingRequest option. A warning message may appear (“This placement requires Deep Link support by the vendor”). This is expected. You can ignore the message and move on. 

  1. Set the Selection Height and Selection Width to the same values selected before. Again, we recommend a Selection Height of 700 and a Selection Width of 1000. 

  1. Complete steps 18-20 for the Assignment Selection and Editor Button sections. 

  1. In the Editor Button section, add a value of your choosing to the Text field. We recommend something recognizable like “ProQuest Resources”. 

  1. In the Icon Url field, add the following URL: https://pq-static-content.prod.proquest.com/lti/PQ-LTI-Icon.png 

  1. Select Save at the bottom of the page to create the Developer Key and return to the Developer Keys page. 

  1. In the table of Developer Keys, find the row for the key you just created. Click the eye icon in that row to make the Developer Key visible. 

 
User-added image

  1. Set the State of the new Developer Key to ON by clicking the OFF button. 

 User-added image

  1. In the Details column, directly above the Show Key button, you will see a Client ID. Copy this Client ID and paste it somewhere you can access, like in a notes file, as it will be used later in the setup process.  

User-added image

Step 2 – Add the ProQuest External Tool to your Canvas Account Settings 

  1. While still in the Admin section in Canvas, select the Settings option in the left panel (it’s the last option). 

  1. Select the Apps tab and click the + App button to add a new App placement. 

  1. On the form displayed, select the Configuration Type dropdown menu, and then select By Client ID. The form will change and show only a Client ID field. Paste the Client ID you copied from the Developer Keys page. 

  1. Select Submit. A popup will tell you a Tool was found for your Client ID and will ask if you would like to install it. Choose Install. The placement will be added and shown in the List of External Apps. 

  1. From the gear dropdown on the External App entry, select the Deployment ID option. A popup will display the Deployment ID for this tool placement. Copy the Deployment ID and paste it in a notes file, as it will be used in the setup on the ProQuest Administrator Module. 

 

You should now have a notes file with a single Client ID and Deployment ID. You will need these numbers to complete the setup process on the ProQuest Administrator Module as described in Step 3 below. If you are not the administrator for your ProQuest account, you will need to pass this information to your institution’s ProQuest administrator so they can complete the tasks described in Step 3. 

 

Step 3 - Connect the new External Tool in Canvas to your ProQuest account. 

  1. Log into the ProQuest Administrator Module (https://admin.proquest.com) with the Account you wish to connect to the External Tool placement created in steps 1 and 2. 

  1. Select the Authentication/Access tab on the left panel. 

  1. From the Authentication/Access screen, select the LTI tab. 

User-added image 

 

  1. Select the usage group you would like to associate with the LTI usage. 

  1. Under Issuer ID enter https://canvas.instructure.com 

  1. Under Client ID enter the Client ID you copied in Step 1 above. 

  1. Under Deployment ID enter the Deployment ID you recorded in Step 2 above. 

  1. Determine the root URL for your Canvas instance. This is the part of your Canvas URL up to but not including the first slash (e.g. https://canvas-lms.schooldomain.edu).  Copy this Root URL.  

  1. Paste your Root URL into the following three fields: Public Keyset URL, Access Token URL, and Authentication Request URL 

  1. In the Public Keyset URL input box, directly after your Root URL in the same field, copy and paste the following: /api/lti/security/jwks 

  1. For the Access Token URL input box, directly after your Root URL in the same field, copy and paste the following: /login/oauth2/token 

  1. For the Authentication Request URL input box, directly after your Root URL in the same field, copy and paste the following: /api/lti/authorize_redirect 

  1. Select the Add credentials button and verify that the entries added in the list above are all correct. 

 

Your Canvas users with course editing permissions are now ready to use the ProQuest External Tool. You can test your configuration and make sure everything is working as expected by following the instructions in the support article below: 

Embedding ProQuest documents into Canvas modules and assignments using an External Tool configured with LTI 1.3 Deep Linking Technology 

Embedding ProQuest documents into Canvas modules and assignments using an External Tool configured with LTI 1.3 Deep Linking Technology 

Once your Canvas account is configured to use ProQuest as an External Tool by your Canvas administrator, you will be able to search for ProQuest documents from within Canvas, select them, and embed them directly for viewing within Canvas courses and assignments. The advantage of this method is that users will be able to read external documents from ProQuest without leaving Canvas, and users will not be prompted to authenticate. 

This document describes the process of adding a ProQuest document as an item within a course module, embedding a ProQuest document within a Canvas assignment, and adding a link to a ProQuest document using the assignment page’s rich text editor. 

 

Embedding a ProQuest document as an item within a course module 

 

  1. After logging into Canvas, select Courses from the left menu and select the course where you would like to embed a ProQuest document. Note that you will need course editing privileges to proceed. 

  1. For an existing module, select the + sign at the right to add a content item. If you don’t have a module, you can add one with the + Module button.  

User-added image 

 

  1. From the Add dropdown, select External Tool.  

  1. From the list of External Tools that appears in the popup, select the ProQuest external tool. The name of this tool is variable and is set by the Canvas administrator. 

  1. A frame will open and display the home page of the ProQuest platform configured for your Canvas account. 

  1. You can search and browse within this frame to find the document you wish to link to. 

  1. Once identified, the document display page will have a Select this document button near the top of the page. Use this button to select the document you’d like to embed in your module. 

 

User-added image 

 

  1. This will return you to the Add Item form in Canvas. Scroll down and enter a meaningful Page Name. 

  1. Click the Add Item button to complete the addition of the link. Click the new link. It should open a new frame directly to the document page identified above, without requiring authentication to ProQuest. 

 

Embedding a ProQuest document within a Canvas assignment 

 

  1. While editing an assignment, find the Submission Type menu below the rich text editor. In the associated dropdown menu, select External Tool. 

  1. Select the Find button and a Configure External Tool pop-up menu will be displayed.  

  1. Choose the ProQuest external tool. The name of this tool is variable and is set by the Canvas administrator. A frame will open and display the home page of the ProQuest platform associated with this tool. 

  1. You can search and browse within this frame to find the document you wish to link to. 

  1. Once identified, the document display page will have a Select this document button near the top of the page. Use this button to select the document you’d like to embed in your assignment. 

  1. This will return you to the Configure External Tool form. Finish the process with the Select button. 

  1. Save your assignment to view a preview of your assignment and to verify that the process was successful. 

 

Adding a link to a ProQuest document using the assignment page’s rich text editor 

 

  1. Select the text you would like to convert into a document link. 

  1. Select the PQ icon in the toolbar of the rich text editor. 

User-added image 

  1. A frame will open and display the home page of the ProQuest platform associated with this tool. 

  1. You can search and browse within this frame to find the document you wish to link to. 

  1. Once identified, the document display page will have a Select this document button near the top of the page. Use this button to select the document you’d like to embed in your assignment. 

  1. You should now have a working link to a ProQuest document within your assignment description. 

  1. Save your assignment to view a preview of your assignment. Click the link to verify that the process was successful.