Add OLI Torus course to Canvas class

Canvas: Integrate Torus with Canvas, and add a link to your Canvas class

Configure Torus: Adding OLI Torus as a Canvas external tool

This set of instructions is meant for BOTH the Canvas admin and the instructor, to add OLI Torus links to a Canvas class.
The first half of the document is for the Canvas admin to add and register Torus as an LTI external tool.
The second half of the document is for the instructor (or the admin) to add a Torus link to a Canvas class, so Torus content can be delivered to students.

NOTE: If you install OLI Torus in your Canvas sandbox, you'll need to repeat the process for your production environment; it cannot be transferred between Canvas instances.

STEP 1. Create an LTI 1.3 Developer Key


Canvas requires elevated privileges to configure LTI 1.3 Developer Keys and Apps. Canvas administrators should have the necessary privileges. If you don't see the options mentioned belo w, you may not have proper privileges or your canvas instance may be an older version which does not support LTI 1.3. In either case, you should check with your LMS administrator.


  1. In Canvas using the left main menu, select Admin > [Admin Account Name] > Developer Keys
  2. Click + Developer Key > + LTI Key
    + developer key > + LTI key
  3. Fill in Key Name field, such as "OLI Torus"
  4. Fill in Redirect URIs field: https://proton.oli.cmu.edu/lti/launch
  5. Change Method to Enter URL and paste: https://proton.oli.cmu.edu/lti/developer_key.json
  6. Click Save button.
  7. Enable the newly created LTI Key by setting it to "ON".
  8. Copy the Client ID into a notes/text document for use in an upcoming step. It's the value found in the Details column, and will look like this.

Adding Torus as global External Tool will enable Torus to be used by any course in the LMS and will only require a single registration request.

  1. Navigate to your Canvas admin panel Admin > [account name] > Settings > Apps > +App
  2. Select Configuration Type "By Client ID" and insert the Client ID we kept from the previous steps. Click "Submit". When prompted to install the tool, select "Install".
  3. We must configure this specific deployment with Torus. To do this, we must get the Deployment ID by Selecting the "gear" menu > Deployment ID. Copy the Deployment ID into your notes/text document for an upcoming step.

STEP 3. Securely register Canvas with OLI with registration form

Instead of sending your sensitive app values to OLI via using unsecure methods like email or chat, you can submit that information in a secure form. Add a link to a Canvas course to access the Registration form. It can be a test course or a real course where Torus is expected to be used.
  1. Navigate to your course and click Modules > + Module and add a new Module.
  2. In the module bar click the plus symbol to add an item.
  3. Select External Tool in the dropdown menu and select OLI Torus from the list.
  4. NOTE: Check the "Load in a new tab" box and click Add Item.
  5. Click the new OLI Torus Item link, then click the Load OLI Torus in a new window button to reach the Registration Form.
  6. Fill in your institution name (full name please), your institution's URL, and the email address of your Canvas admin (or an email the Canvas team can access; this email is not published, it's just for OLI in case of emergencies).
  7. Select Canvas in the last field, and review the URLs that are prepopulated. Add the Deployment ID from your noted/text document. Leave "Line items service domain" empty, and click Register.
  8. OLI will review and approve your Registration request.
This is the recommended placement, because it will result in OLI Torus also being visible on the Canvas class Home page. If you prefer to add OLI Torus as a Module, skip to STEP 2. To avoid confusion, add your OLI Torus course link in only one place, Assignments or Modules.
  1. Click Assignments > +Assignment
  2. Add a title. This is what students will see when they click on Assignments in the Canvas class.
  3. Scroll down to Submission Type, select External Tool, and click Find.
  4. Choose OLI Torus from the list and click Load in a new tab.
  5. Click Save and Publish or Save. If necessary, publish the OLI Torus assignment by clicking the “not published” icon on the right side of the page.
  1. Click Modules in the Nav menu, then Create a new module
  2. Give the Module a name, such as OLI Torus Course (or base the title on your Torus content, such as Wellstart or General Chemistry) and click Add Module.
  3. In the new Module, click the Plus (+) sign and select External Tool.
  4. Select OLI Torus from the list, update the title if you like, click Load in a new tab and click Add Item.
  5. Publish the OLI Torus module by clicking the “unpublished” icon on the right end of the OLI Torus module.
  6. Click through to Load OLI Torus in a new window and configure your OLI Torus course (next steps below).

STEP 3: Set up your OLI Torus materials

Now that Torus is an assignment or module in your Canvas class, you must connect the link to some OLI Torus material, and configure it for use with your students.
  1. Click the OLI Torus link you just added.
  2. A new tab will open, allowing you to configure your OLI Torus materials. Click Start.
  3. Follow the prompts:
    1. Select source. Use the search feature to find the desired content, if necessary.
    2. Course name, Course section number (can be a catalog number / CRN, for example), and modality for how class meets.
    3. Course details – start and end dates and times.
Note: Once a link to OLI Torus is configured, placing additional links in different places in the Canvas course will go to the same OLI Torus course.
Students will only access the OLI Torus course from the link(s) in Canvas set up by the instructor. They have no OLI Torus Account ID or Password.

That’s it! Subsequent clicks by you and your students will take you to the Torus section you configured.

FAQs
What if I need to unlink my course because it is the wrong course?
Contact OLI Support at oli-help@cmu.edu to unlink your course.