Articles in this section

Brightspace User Integration (LTI 1.3)

Last updated Follow

Overview:

The Course Evaluations & Surveys D2L Brightspace Integration has two major setup steps, performed in the following order:

1.     Brightspace Data Integration - NOTE: If your organization already has a Brightspace Data Integration configured and is only updating the User Integration from LTI 1.1 to LTI 1.3, then you do not need to set up the Data Integration again.  Customers who are setting up the Brightspace integration for the first time will need to configure the Brightspace Data Integration first and then return to the the steps in this article to configure the Brightspace User Integration. 

2.     Brightspace User Integration - follow the steps below after configuring the Brightspace Data Integration


Important Notes:

  • This update to utilize LTI 1.3 only affects the Brightspace User Integration, while the setup steps for the Brightspace Data Integration remain unchanged. 

  • Updating the Brightspace User Integration to utilize LTI 1.3 is not required for the Brightspace Integration with CES. Customers can remain on the LTI 1.1 version of the integration and there is no change with integration functionality utilizing LTI 1.3.

  • Customers will have the choice to utilize LTI 1.3 or LTI 1.1, however, it is recommended as best practice to update the Brightspace User Integration to utilize LTI 1.3.

  • Customers will have the option to revert back to LTI 1.1 from LTI 1.3 if they choose.

 

Summary:

The Brightspace User Integration deploys External Tools to Brightspace, which provide dynamic LTI links in Brightspace and allow users direct access to CES with a single click. Currently the LTI links in Brightspace utilize LTI 1.1 technology.

LTI 1.3 offers added security and is a desired method at some institutions, which is why we developed the Brightspace User Integration to utilize LTI 1.3 technology.

A new Help Center article will be created titled “Brightspace User Integration Utilizing LTI 1.3”, while the existing “Brightspace User Integration” article will remain available for customers that choose to use LTI 1.1.

The below is the main difference between the two articles and will be added as the first step in the “Brightspace User Integration Utilizing LTI 1.3” article. The user experience will remain the same as mentioned in the LTI 1.1 article.

 

1)  How to register LTI 1.3 (LTI Advantage) tool in Brightspace:

  1. Log into your Brightspace instance as a Brightspace Administrator.
  2. Click on the Settings icon for Admin Tools and choose Manage Extensibility.
  3. Choose the LTI Advantage tab and click on the Register Tool.
  4. Choose the Standard option for registering your tool.
  5. Enter the following information in the Register a Tool form:

·       Name: CES

·       Description: CES

·       Domain: your CES URL (i.e. https://myuniversity.evaluationkit.com)

·       Redirect URLs: your CES URL followed by /d2l/lti/callback (i.e. https://myuniversity.evaluationkit.com/d2l/lti/callback)

·       OpenId Connect Login URL: your CES URL followed by /d2l/lti/init (i.e. https://myuniversity.evaluationkit.com/d2l/lti/init)

·       Target Link URI: your CES URL followed by /d2l/lti/callback (i.e. https://myuniversity.evaluationkit.com/d2l/lti/callback)

·       Keyset URL: your CES URL, followed by /login/lti/jwks (i.e. https://myuniversity.evaluationkit.com/login/lti/jwks)

·       Under Extensions, choose Deep Linking and Names and Role Provisioning Services.

·       Click Register. You will get the registration details.

·       Click Done, you will be redirected back to the list of registered LTI Advantage tools.

 

2) Deploy Newly Registered Tool in Brightspace

Next, create a Deployment for the new tool that was just created, either from the Creation screen or the Edit Tool screen by clicking on View deployments.

  1. Click the New Deployment button.
  2. Choose the LTI 1.3 Tool Registration that was created in the previous step in the Tool dropdown.
  3. Choose a Name for your deployment.
  4. Select the Deep Linking and Role Provisioning Services options from the list of Extensions.
  5. Ensure the following settings are selected/configured:
    1. Org Unit Information
    2. User Information
      • Name
      • Email
      • User Id
      • Username
      • Org Defined ID
    3. Link Information
      • Title
      • Description
  6. Ensure your Deployment is shared with the correct Org Units and their appropriate descendants.
  7. Click the Create Deployment button.
  8. Brightspace will now display a unique Deployment ID. Copy this value so it can be entered into CES in the following step. Note: This value can also be accessed by clicking on the new Deployment in the View Deployments screen.
  9. Click View Links in D2L. A new tab will open.
  10. Click New Link
  11. Enter a Name for the link say “My Surveys Widget Link”.
  12. Enter your institution's CES URL, followed by d2l/lti/init. i.e: https://myuniversity.evaluationkit.com/d2l/lti/init.
  13. Select Type: Basic Launch
  14. For custom parameters, add launch_type= widget (This is required if clients want to use a widget.)
  15. Click Save & Close
  16. Return to your other D2L tab and click Done.

 

3) Configure LTI 1.3 Settings in CES

  1. Log into CES as the CES Administrator
  2. Navigate to Account > Brightspace > User Settings.
  3. Copy the value from the Client ID field in Brightspace into the Client ID field in CES
  4. Paste the Deployment ID from the previous step into the Deployment ID field in CES
  5. Copy the value from the Issuer field in Brightspace into the Issuer field in CES
  6. Copy the value from the Brightspace Keyset URL field in Brightspace into the Brightspace Keyset URL field in CES.
  7. Copy the value from the OpenID Connect Authentication Endpoint field in Brightspace into the OpenID Connect Authentication Endpoint field in CES.
  8. Click Save.

 

4) In Brightspace, go to Admin Tools > Navigation & Themes > Custom Links Tab > Create Link.

Insert the following information for the corresponding fields: 

  1. Name: My Surveys Widget LTI 1.3 link
  2. Custom Link Url: Click Insert Quicklink > Course Material List Survey Notification: > Select External Learning Tool > Select My Surveys Widget Link that was added previously (in step 2.11).

At this point the system will auto-generate a URL link to the External Learning Tool and pre-populate the URL field for you. Please copy this custom link and save it, as you will need to paste it into the 'INSERT YOUR CUSTOM LINK HERE' when adding a widget.

  1. Behavior: New window/tab
  2. Width: 1000
  3. Height: 700
  4. Browser Attributes: Check All

 

5) In Brightspace, go to Admin Tools > Homepage Management > Widgets Tab > Create Widget

  1. Name the Widget: My Surveys (or customize as you wish).
  2. Leave the description blank.
  3. Un-check the option for Render in IFrame
  4. Make widget available to: Select Top Level Org.
  5. Select Content tab in Subnavigation.

    1. Copy the below code snippet into Notepad or Text Edit.

      <<div>
  <script>
    try {
      /* REPLACE THIS
      SETTING BELOW */
      /* example: '/d21/common/dialogs/quickLink/quickLink.d21?ou={orgUnitId}
      &type=lti&rcode...'*/
      var evalkit_customlink = 'INSERT YOUR CUSTOM LINK HERE';
      var evalkit_domain = ' INSERT YOUR INSTITUTION URL example : myuniversity.evaluationkit.com';
    }
    catch (e) {
      console.log(e);
    }
  </script>
  <script
    src=" INSERT YOUR INSTITUTION URL example : //myuniversity.evaluationkit.com/js/d2l/evalkit.d2ldashboardMASTER.js"
    type="text/javascript"></script>
  <div id="evalkit_dashboard"></div>
</div>
    2. Paste the URL generated in the above step (4.c) where it says 'INSERT YOUR CUSTOM LINK HERE'.
    3. Paste your CES URL where it says "INSERT YOUR INSTITUTION URL."  For example, myuniversity.evaluationkit.com
    4. Copy all of the code snippet from Notepad or Text Edit.
    5. Click the Source Code button (</>) on the bottom of the editor and paste the code snippet below in the Source Code window and click Save.
    6. Click Save and Close Button.


6) In Brightspace, go to Admin Tools > Homepage Management

  1. Select Desired Homepage.
  2. Click Add Widget from Widgets.
  3. Select the above created widget “My Surveys”(step 5.1) from the list.
  4. Click Add.
  5. Click Save and Close.
  6. Repeat these steps for other homepages where the My Surveys Widget should display.
  7. The My Surveys Widget is now configured and set up to display on your homepages.


Optional Feature: Add a Global LTI Link to the Brightspace Top Navigation to Take Users from Brightspace to Course Evaluations & Surveys

1) In Brightspace, go to Admin Tools > External Learning Tools > Select your deployed tool

  1. Click View Links in D2L. A new tab will open.
  2. Click New Link
  3. Enter a Name for the link say “My Surveys link” (this is the name that will be used to add the link in the Navigation bar).
  4. Enter your institution's CES URL, followed by d2l/lti/init. For example: https://myuniversity.evaluationkit.com/d2l/lti/init
  5. Select Type: Basic Launch
  6. Click Save & Close

 

2) In Brightspace, go to Admin Tools > Navigation & Themes > Custom Links Tab > Create Link.

  1. Insert the following information for the corresponding fields:
    1. Name: My Surveys LTI 1.3 link
    2. Custom Link Url: Click Insert Quicklink > Course Material List Survey Notification: > Select External Learning Tool > Select My Surveys Link that was added in previous step (in step 1.3).
    3. Behavior: New window/tab
    4. Width: 1000
    5. Height: 700
    6. Browser Attributes: Check All

 

3) Go to Admin Tools > Navigation & Themes > Navbars > Select Desired Navigation Bar.

  1. Click Add Links
  2. Select My Surveys LTI 1.3 Link from the list
  3. Click Add, Click Save and Close.
Was this article helpful?
0 out of 0 found this helpful