Adding Harmonize to Canvas with LTI 1.3

  • Updated

Overview

 

The instructions below describe how to add Harmonize to your Canvas instance via LTI 1.3. This is the latest LTI specification offered by IMS Global and offers a number of improvements over LTI 1.1.

 

Important Note: Adding Harmonize to Canvas via LTI 1.3 requires a Canvas Administrator user with access to the root account.

 

Creating Your LTI Key

 

  • Log into your Canvas instance as an Administrator with access to the root account.

 

  • Click on the Admin menu and select the root account.

 

  • In the navigation list, select Developer Keys.

 

Canvas Admin Developer Keys Page

 

  • Click the + Developer Key button and select + LTI Key.

 

Add Developer Key Menu LTI Key Option

 

  • Enter the following values on the Key Settings page:

 

 

  • Method - Enter URL
  • KeyName - Harmonize
  • RedirectURIs - Redirect URI provided to you from Harmonize Support
  • JSON URL - Config URL provided to you from Harmonize Support

 

  • Click Save.

 

  • On the Developer Keys page, a new row will be added named Harmonize.

 

Screenshot 2023-08-09 at 14.42.11.png

 

  • Click the ON button in the Harmonize row to toggle the LTI key from OFF (red) to ON (green).

 

Developer Keys Page Harmonize Row On Button

 

  • Copy the Client ID located in the Details column just above the Show Key button.

 

Screenshot 2023-08-09 at 14.42.11 copy.png

 

  • Send the Client ID to Harmonize Support. Your Client ID must be received by the Harmonize Support team before installation can continue.

 

Adding Harmonize to Canvas

 

Once you've received a confirmation email from the Support team, Harmonize can be installed in the Canvas root account or added to sub-accounts and individual courses.

 

In the Canvas Root Account

 

Administrators can add Harmonize in the Canvas root account. Installing at the root account makes Harmonize available as an External Tool option in all your Canvas courses.

 

  • In the Admin section of your Canvas instance, click Settings.

 

  • Select the Apps tab, click on the View App Configurations button.

 

 

  • Click the + App button.

 

 

  • In the Add App window that appears, click the Configuration Type dropdown menu and select By Client ID.

 

  • Enter your Client ID into the Client ID field and click Submit.

 

Add App Dialog

 

  • Confirm that you want to install Harmonize.

 

  • Harmonize is now available as an External Tool option in all your courses.

 

In a Sub-Account or Course

 

Harmonize can instead be added to a sub-account or an individual course by any user with edit access.

 

  • Navigate to your course or sub-account within Canvas, then go to the Settings page.

 

  • Select the Apps tab, click on the View App Configurations button.

 

 

  • Click the + App button.

 

 

  • In the Add App window that appears, click the Configuration Type dropdown menu and select By Client ID.

 

  • Enter your Client ID into the Client ID field and click Submit.

 

Add App Dialog

 

  • Confirm that you want to install Harmonize.

 

  • Harmonize is now available as an External Tool option in your selected sub-account or course.

 

Next Steps

 

Configuring Your Canvas API Integration

 

Now that Harmonize is set up in your Canvas instance, consider configuring your Canvas API integration. This integration enables additional helpful features such as Group Syncing, Section Syncing, Rubrics, and Assignment Dates.

 

Harmonize Quick Start Guide

Ready to use Harmonize? Our Quick Start Guide is a great place to begin.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request