This guide is for schools without specific data residency requirements. For compliance with Canadian data residency requirements please see the Canadian version of this guide.
In D2L, it is recommended you install LTI tools at the organization level rather than on a per-course basis (you can still grant access to individual courses, departments, and schools using this approach). This article will walk you through the organization-level installation process.
You might also find the following help article useful: Using the Hypothesis LMS app for D2L.
Who is this guide for?
- This guide is for individuals who want to install Hypothesis in D2L at the organization level.
- Are you having trouble getting Hypothesis installed in D2L? Please contact us and send us the information of your D2L admin or your IT department. We’ll work with them to get Hypothesis installed.
Before you install Hypothesis you may wish to review the LTI parameters we use. You can find them here.
1. Generate Hypothesis Credentials
These instructions assume that you have already spoken with a member of our Education Team and been provided with a link to the page where you can generate Hypothesis credentials.
If you have not yet received a link, please fill out this form and a someone from our Education Team will get in touch with you about the next steps.
In the form to generate credentials, fill out the following:
- LMS Domain:
- This is the basic web address instructors and students use to access your LMS (e.g., lms.yourschool.edu)
- Can be any valid email address that belongs to you
Note: Ignore the two Canvas-specific fields. Those are relevant only for use in Canvas LMS.
Click the Generate Credentials button.
You will be shown a screen that contains your new Hypothesis Consumer Key and Shared Secret.
Don’t close this tab/window! You will need to copy and paste these credentials later in the install process.
2. Installing the app in D2L
Create a New Tool Provider
From the Admin Menu, go to External Learning Tools:
Select the Manage Tool Providers tab and click the New Tool Provider button.
Fill out the New Tool Provider Settings.
- Launch Point:
- Select Inherit Global (1.1)
- OAuth Signature Method:
- Select HMAC-SHA1
- Copy and paste from the Shared Secret field from the credentials you generated in step 1
Next, check the box for Use custom tool consumer information instead of default.
Some more form fields will appear:
- Paste the Consumer Key from the credentials you generated in step 1
- Name and Description:
- Can be anything, but should be sensible (i.e., “Hypothesis” and “Collaborative annotation tool”)
- Contact Email:
- Enter any working email address that belongs to a D2L administrator
Under Visibility check the box for Allow users to use this tool provider:
For Security Settings, ensure the following boxes are checked:
- Send tool consumer information to tool provider (allows Hypothesis to associate a private group with your institution)
- Send context information to tool provider (allows Hypothesis to associate a private group with a course)
- Send LTI user ID and LTI role list to tool provider (allows Hypothesis to create unique accounts with appropriate privelges for students and instructors)
- Send user name to tool provider (allows Hypothesis generate a human-readable display name)
For more information on how the Hypothesis LMS app uses LTI parameters, see our wiki.
Make the tool provider available
Finally, click the Add Org Unit button to make the tool provider available to the desired org unit(s). Be sure to select the option to make tool available to All descendants unless you are restricting Hypothesis to the top level org unit only.
Click the Save and Close (or Save) button.
Instructors will now be able to create Hypothesis-enabled readings in their course sites.