Adding Harmonize to Brightspace with LTI 1.3

Overview

The instructions below describe how to add Harmonize to your Brightspace 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 Brightspace requires an administrator role with permission to manage LTI Advantage registrations and deployments. See this Brightspace support article for details.

Dynamic Registration

The simplest way to add Harmonize to Brightspace is by performing a dynamic registration. If you are unable to use this feature, see the instructions for Standard Registration below.

• Click on the gear icon in the top right of your Brightspace screen and click on the Organization Related - Manage Extensibility link.
• Select the LTI Advantage tab and click the Register Tool button.

• Select the Dynamic option, enter the LTI Advantage Tool URL provided by Harmonize Support, check the Configure Deployment checkbox and click Register.

• Back on the Manage Extensibility page, click on the Disabled filter and click on the Harmonize tool link.

• On the Edit Tool page, click the Enabled switch and check the Send Institution Role checkbox and click the Save button at the bottom of the page.

• Click the View Deployments link at the bottom of the Edit Harmonize page.

• Click on the Harmonize link in the Deployments table.

• On the Edit Deployment page, make the following changes and click Save:
  • Make sure the following options in Security Settings are checked.
    • Org Unit Information
    • User Information and all options underneath it
    • Link Information and all options underneath it
    • Classlist including users not known to this deployment
  • Ensure that the correct Org Unit has been selected for the deployment.
    • Pay close attention to whether the selected Org Unit includes all descendants.
  • Click on the View Links link at the bottom of the page.

• Click on the Harmonize link in the Links table.

• Fill in the following fields on the Edit Link page and click Save and Close.
  • Description - Discussion & Classroom Tools
  • Width - 800
  • Height - 800

• Harmonize is now fully installed and ready to use in your courses.

Standard Registration

• Click on the gear icon in the top right of your Brightspace screen and click on the Organization Related - Manage Extensibility link.
• Select the LTI Advantage tab and click the Register Tool button.

• Select the Standard option and enter the following values provided by Harmonize Support:

• Enabled - True
• Name - Harmonize
• Description - Discussion & Classroom Tools
• Domain - Enter Provider Domain value
• Redirect URLs - Enter Redirect URIs value
• OpenID Connect Login URL - Enter OpenID Connect Login URL value
• Target Link URI - Enter Target Link URI value
• Keyset URL - Enter Keyset URL value
• Extensions
  • Assignment and Grade Services - Checked
  • Deep Linking - Checked
  • Names and Role Provisioning Services - Checked
• Roles
  • Send Institution Role - Checked
• Substitution Parameters
  • Add 1
    • prevContexts = $Context.id.history
• Customer Parameters
  • Add 4
    • allow_nonassignment_selection = true
    • timezone = $Person.address.timezone
    • sourceUserId = $Person.sourcedId
    • ltiGroupContextIds = $Membership.course.groupIds

• Click Register.

• In the Brightspace Registration Details dialog that appears, copy the following values and provide them to Harmonize Support:
  • OpenID Connect Authentication Endpoint
  • Brightspace Keyset URL
  • Client Id

• Within the dialog, click on the View Deployments link.
  • If you closed the dialog before clicking on the link, click on the gear icon in the top left and click on Organization Related - External Learning Tools.
• Select the LTI Advantage tab and click on the New Deployment button.

• Fill in the following values on the form.

• Enabled - True
• Tool - Harmonize
• Name - Harmonize
• Description - Discussion & Classroom Tools
• Extensions
  • Assignment and Grade Services - Checked
  • Deep Linking - Checked
  • Names and Role Provisioning Services - Checked
• Security Settings
  • Org Unit Information - Checked
  • User Information and all under - Checked
  • Link Information and all under - Checked
  • Classlist including users not known to this deployment - Checked
• Make Tool Available To - Select the Org Units you would like to make the tool available in
• Click Create Deployment and click View Links in the dialog that appears.
• Click the New Link button.

• Fill in the following values provided by Harmonize Support:

• Enabled - True
• Name - Harmonize
• URL - Enter Tool Provider URL value
• Description - Discussion & Classroom Tools
• Type - Deep Linking Quicklink
• Width - 800
• Height - 800

• Click Save and Close
• Harmonize is now fully installed and ready to use in your courses.

Next Steps

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