Skip to main content

D2L Brightspace LTI Integration

This guide covers integrating the HiTA app into your D2L Brightspace instance. Installing the HiTA app allows HiTA to be accessed directly from within a D2L Brightspace course.

Tool Registration​

On HiTA​

HiTA app interface showing user icon in lower left corner

In your browser navigate to the HiTA app and open the developer dashboard by clicking your user icon in the lower left and selecting the Organization Dashboard option.

Organization dashboard with LMS option in navbar

In the Organization Dashboard, click the LMS option from the navbar and choose the LTI Setup option.

D2L LTI registration setup page with registration details

Take note of the registration details on this page. We will make use of them soon. Keep this tab open for now and proceed to D2L.

On D2L​

Login as a D2L administrator and open the Manage Extensibility page.

D2L settings menu with Manage Extensibility option
Begin by opening the settings menu and going to the Extensibility page.

Open the LTI Advantage tab then click Register Tool.

LTI Advantage tab with Register Tool button

Select the Standard option and click Register.

Tool registration form with Standard option selected

Fill out the form with the details from the HiTA LTI Setup page:

  • Name: HiTA
  • Description: HiTA LTI
  • Domain: https://app.hita.ai
  • Redirect URLs: https://app.hita.ai/api/auth/lti/d2l/redirect
  • OpenId Connect Login URL: https://app.hita.ai/api/auth/lti/d2l/init
  • Target Link URI: https://app.hita.ai/api/auth/lti/d2l/login

Under Substitution Parameters, add the following:

  • Name: user_id
  • Value: $User.id

Under Custom Parameters, add the following:

  • Name: organization_id
  • Value: <org id value from HiTA LTI Setup page>
LTI tool registration form with HiTA configuration details filled in

Once the new LTI 1.3 tool is registered, Brightspace will expose a set of configurations that are needed to complete the registration on the HiTA side. Save these details for the next step.

LTI tool registration details and configurations exposed by Brightspace

Tool Deployment​

Next we need to create a deployment of the LTI app.

On D2L​

Click the External Learning Tools tab under Settings.

D2L settings with External Learning Tools tab
Once the LTI registration is done, create an external learning tool.
  1. Click New Deployment and fill out the form with the details from the HiTA LTI Setup page.
New Deployment form for external learning tool
  1. Select the HiTA registration tool from the dropdown.
Tool selection dropdown with HiTA registration tool selected

  1. Provide a name for the deployment.

  2. Ensure all the following boxes are selected under the security settings:

Security settings with required checkboxes selected

You should see the same Substitution Parameters and Custom Parameters that you added in the D2L Registration Tool page.

Deployment parameters showing substitution and custom parameters
  1. Click Add Org Units and Filter by Organization type and select your organization and under options select This org unit and all descendants.
Add Org Units dialog with organization filter and descendant options
  1. Click Create Deployment.

You should see the Brightspace Deployment Id now.

Deployment page showing the Brightspace Deployment ID

On HiTA​

  1. Copy the Deployment Id from D2L and paste it into the HiTA LTI Setup page. You will also need to copy over the Brightspace Registration details that you took note of from the D2L Registration Tool page.
HiTA LTI Setup page with D2L settings and Save D2L Settings button
  1. Click Save D2L Settings.

The last step is creating the links that can be added in the D2L courses to launch HiTA.

On D2L​

  1. Under the same External Learning Tools page, click the new deployment name that you created.
  2. Scroll to the bottom of the page and click View Links.
External Learning Tools page with View Links option
  1. Click New Link.
Links page with New Link button
  1. Input the Name: HiTA
  2. Input the URL: https://app.hita.ai/api/auth/lti/d2l/init
  3. Select Basic Launch as the launch type.
  4. Click Save.
Create Link form with HiTA configuration and Basic Launch type

Once the link is created and shared at the Deployment level it is available to be added by instructors in all of the courses that the deployment was shared with above.