Installing Hypothesis in Moodle – LTI 1.3 (Canada)

Upgrading an existing Hypothesis LTI 1.1 installation

If you are installing Hypothesis for the first time you can skip this section and begin at Create the Hypothesis external tool.

Moodle allows you to upgrade the existing Hypothesis LTI 1.1 tool to LTI 1.3 directly, without needing to install a new instance of the tool. To ensure that previous Hypothesis assignments made with the old tool continue to work properly, we need to know the LTI 1.1 consumer key of the previous Hypothesis tool.

Follow the steps below to copy the LTI 1.1 consumer key, and then upgrade the existing Hypothesis tool.

1. Open the “Site Administration” page, and in the “Search” field type “manage tools” and hit enter

Under Search results click the Manage tools link.

Note that the typical path to the Manage tools page will be Administration / Plugins / Activity modules / External tool / Manage tools though some Moodle sites may be configured differently.

2. From the “Manage tools” page, locate the exiting Hypothesis tool card and click the gear button in the upper-right to edit the tool’s configuration

3. Under “Tool settings” locate the “Consumer key” and copy its value to a temporary note or text file

You will need to refer to this value later in the upgrade process.

4. Click the drop-down menu for “LTI version” and change the value from “LTI 1.0/1.1” to “LTI 1.3”

5. You may now skip to step 3 in the “Create the Hypothesis external tool” section of this guide below and continue entering the remaining configuration values as directed

Create the Hypothesis external tool

1. Open the “Site Administration” page, and in the “Search” field type “manage tools” and hit enter

Under Search results click the Manage tools link.

Note that the typical path to the Manage tools page will be Administration / Plugins / Activity modules / External tool / Manage tools though some Moodle sites may be configured differently.

2. From the “Add tool” box, click the link to “configure a tool manually”

3. Fill out the “External tool configuration” page (start here if you are upgrading an existing LTI 1.1 version of the tool)

Under Tool Setting enter the following:

• Tool Name:
  • Hypothesis
• Tool URL:
  • https://lms.ca.hypothes.is/lti_launches
• LTI version:
  • LTI 1.3
• Public key type:
  • Keyset URL
• Public keyset:
  • https://lms.ca.hypothes.is/lti/1.3/jwks
• Initiate login URL:
  • https://lms.ca.hypothes.is/lti/1.3/oidc
• Redirection URI(s):

  • https://lms.ca.hypothes.is/lti/1.3/oidc
    https://lms.ca.hypothes.is/lti_launches

• Custom parameters:

  • ResourceLink.title=$ResourceLink.title
    ResourceLink.description=$ResourceLink.description
    ResourceLink.available.startDateTime=$ResourceLink.available.startDateTime
    ResourceLink.submission.endDateTime=$ResourceLink.submission.endDateTime
    ResourceLink.id.history=$ResourceLink.id.history
    Context.id.history=$Context.id.history

• Tool configuration usage:
  • Show as preconfigured tool when adding an external tool
• Default launch container:
  • New window
• (Hidden behind Show more…) Secure icon URL:
  • https://d242fdlp0qlcia.cloudfront.net/uploads/brand/HypothesisBlackboardIcon.png

Under Services enter the following:

• IMS LTI Assignment and Grade Services:
  • Use this service for grade sync only
• IMS LTI Names and Role Provisioning:
  • Do not use this service
• Tool Settings:
  • Do not use this service

Under Privacy enter the following:

• Share launcher’s name with tool:
  • Always
• Share launcher’s email with tool:
  • Always
• Accept grades from the tool:
  • As specified in Deep Linking definition or Delegate to teacher
• ✓ Force SSL

Leave the Miscellaneous section unchanged.

Click the Save changes button to save.

Submit LTI details to Hypothesis to complete registration

1. From the “Manage tools” page, locate the Hypothesis tool and click the “View configuration details” button in the upper right

2. In the “Tool configuration details” window, note the “Platform ID”, “Client ID”, and “Deployment ID” values

You will need to copy each of these values into our registration form during the steps below.

3. In a new browser tab, open our LTI 1.3 / Advantage Registration form

4. If you are upgrading an existing LTI 1.1 Hypothesis tool, check the box “Migrate from existing LTI 1.1?” and paste the previous LTI 1.1 consumer key into the text box

5. Enter the following values into the form as shown

• Email
  • Your email address, or another address that you want associated with this registration
• LMS URL
  • Enter the Platform ID value copied from the Tool configuration details window above
• LMS
  • Select Moodle from the drop-down menu
• Client ID
  • Enter the Client ID value copied from the Tool configuration details window above
• Deployment ID
  • Enter the Deployment ID value copied from the Tool configuration details window above

5. Click the “Submit” button to send your LTI info to Hypothesis

We will email the address you provided above when your registration has been processed and Hypothesis is ready to be used. We can’t wait to have you annotating!

Important note: Hypothesis will not be available to use in courses until you have received confirmation that we have processed your LTI instance.