Upgrade the Kaltura LMS Extensions integration in Brightspace from LTI 1.1 to LTI 1.3

Content updated: 05/19/2022


About

This guide explains how to upgrade the Kaltura LMS Extensions integration in Brightspace from LTI 1.1 to LTI 1.3.

As of August 8, 2022, with the release of KAF version 5.108.10x, KAF instances configured for LTI 1.3 can continue to launch existing embed codes added through the LTI 1.1 Kaltura Browse, Search, and Embed tool when the same KAF instance is used.

Prerequisites

  • Administrator access to the Brightspace account integrated with Kaltura
  • A Kaltura Application Framework (KAF) instance of type D2L, version 5.108.10x or later

Step 1 - Back up your KAF configuration

  1. Sign in to your KAF Configuration Management console at https://{your_KAF_base_URL}/admin.
  2. Under Server Tools, click Backup Configuration.

  3. Click Save Backup.

    4. A confirmation message displays: Are you sure you want to save current configuration? Remember that previous backups will be deleted.

  4. Click Yes, and then click Save.

    5. Once the backup is complete, the following confirmation message displays: Configuration file was saved successfully.

The backup page displays the last configuration save date. This is the date on which the configuration settings were last modified, not the date on which the backup was performed.

Step 2 - Register the Kaltura tool in Brightspace

  1. Sign in to your Brightspace instance with an administrator account.
  2. Click the Admin Tools gear icon in the upper-right corner, and then select Manage Extensibility.

  3. On the Manage Extensibility page, select the LTI Advantage tab, and then click Register Tool.

    4. The Register a Tool page displays.

  4. Select Standard to display the tool registration fields.

    5. Make sure Enabled is selected. If it isn't, enable the tool.

  5. Complete the following fields:
    • Name - Enter a general name for the tool, for example, Kaltura KAF LTI 1.3 integration.
    • Description - Optional.
    • Domain - Enter your KAF base URL: https://{your_KAF_base_URL}. For example, https://12345.kaf.kaltura.com.
    • Redirect URIs - Enter https://{your_KAF_base_URL}/hosted/index/oauth2-launch. For example, https://12345.kaf.kaltura.com/hosted/index/oauth2-launch.
    • OpenID Connect Login URL - Enter https://{your_KAF_base_URL}/hosted/index/oidc-init. For example, https://12345.kaf.kaltura.com/hosted/index/oidc-init.
    • Target Link URI - Leave this field blank.
    • Keyset URL - Enter https://{your_KAF_base_URL}/hosted/index/lti-advantage-key-set. For example, https://12345.kaf.kaltura.com/hosted/index/lti-advantage-key-set.
    • Extensions - Select the following:
      • Assignment and Grade Services
      • Deep Linking
      • Names and Role Provisioning Services
    • Roles - Select Send Institution Role.
  6. Click Register.

    7. The following confirmation message displays.

  7. Click Done.

Step 3 - Update your instance to LTI 1.3

  1. In Brightspace, navigate to Admin Tools > Manage Extensibility > LTI Advantage. Refer to steps 1–3 in Register the Kaltura tool in Brightspace.
  2. Click the name of the tool you created.
  3. On the tool editing page, scroll down to Brightspace Registration Details.
  4. In a separate browser tab or window, sign in to your D2L KAF Configuration Management console at https://{your_KAF_base_URL}/admin.
  5. Navigate to the Hosted module at https://{your_KAF_base_URL}/admin/config/tab/hosted.
  6. Use the information under Brightspace Registration Details to configure the following settings:
    1. Set authMethod to lti1.3. This exposes the LTI 1.3 configuration fields.
    2. Set lti13PlatformOidcAuthUrl to the value listed for OpenID Connect Authentication Endpoint. For example, https://{your_D2L_Domain}/d2l/lti/authenticate.
    3. Set lti13AuthTokenUrl to the value listed for Brightspace OAuth2 Access Token URL. For example, https://auth.brightspace.com/core/connect/token.
    4. Set lti13KeysUrl to the value listed for Brightspace Keyset URL. For example, https://{your_D2L_domain}/d2l/.well-known/jwks.
    5. Set lti13ClientId to the value listed for Client Id.
    6. Under lti13ServicePrivateKey, click Generate key pair here. This generates the private and public keys.
    7. In the Certificate Generator window, click Use to save the key pair to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
  7. Scroll to the bottom of the Hosted module and click Save.

D2L Brightspace LTI migration: Upgrade legacy links to LTI Advantage (1.3)

Once your instance is updated to LTI 1.3, consider migrating any existing LTI 1.1 links to ensure compatibility. The recommended migration methods are:

  • Migrate button - Use the Manage Tool Links (Legacy) tab in Brightspace to migrate links manually to LTI 1.3.
  • LTI Migration API - Automate the migration process with the LTI Migration API for large-scale changes.
  • Course Import - Reimport courses to apply the updated LTI 1.3 links across multiple courses.
  • Course Copy - Copy course content with updated LTI 1.3 links into new course offerings.

For detailed instructions about each method, see the Brightspace integration documentation.

Step 4 - Add the LTI 1.3 tools

  1. In Brightspace, navigate to Admin Tools > Manage Extensibility > LTI Advantage. Refer to steps 1–3 in Register the Kaltura tool in Brightspace.
  2. Click the name of the tool you created, and then scroll to the bottom of the page.
  3. Click View Deployments.
  4. Click New Deployment.
  5. Make sure Enabled is selected. If it isn't, enable the tool.
  6. Complete the following configuration settings:
    • Tool - Select the tool registered in the Register the Kaltura tool in Brightspace section.
    • Name - Enter a name for the tool set, for example, Kaltura LTI 1.3 Tools.
    • Description - Optional.
    • Extensions - Select the following:
      • Assignment and Grade Services
      • Deep Linking
      • Names and Role Provisioning Services
    • Security Settings - Select the following options and their child options:
      • Org Unit Information
      • User Information
      • Link Information
      • Classlist including users not known to the tool
    • Configuration Settings - Select Auto Create Grade Items.
    • Make the tool available to - Select your org unit and All descendants.

  7. Click Create Deployment.

    8. The following confirmation message displays.

  8. Click View Links to continue.

If you click Done by mistake, you can access the links page in the next section.

Step 5 - Configure the Kaltura user ID value

By default, the Kaltura user ID is your Brightspace user ID.

With the Kaltura LMS integration, user ID records are passed from the LMS to Kaltura during the LTI launch. A Kaltura administrator can configure the KAF settings that determine which claim and property pair is used as the Kaltura user ID.

Kaltura added the following fields to the Hosted module to support user ID assignment with LTI 1.3:

  • lti13UserIdClaim - The LTI claim from which the user ID is taken.
  • lti13UserIdClaimProperty - The property within the claim from which the user ID is taken.

When using LTI 1.1 as the authentication method (KAF > Hosted > authMethod = lti), administrators use the ltiUserIdAttribute field in the KAF Hosted module to determine which LTI attribute is used as the user ID.

The default LTI 1.1 value is:

  • ltiUserIdAttribute = ext_d2l_username

If ltiUserIdAttribute in your KAF instance is not set to ext_d2l_username, review Configure the Kaltura user ID value for your LMS integration before proceeding.

When using LTI 1.3 as the authentication method (KAF > Hosted > authMethod = lti1.3), administrators use the lti13UserIdClaim and lti13UserIdClaimProperty fields in the KAF Hosted module to determine which LTI attribute is used as the user ID.

The default LTI 1.3 values are:

  • ltiUserIdAttribute = blank
  • lti13UserIdClaim = http://www.brightspace.com
  • lti13UserIdClaimProperty = username

To view and configure these settings using the default values:

  1. Sign in to your KAF Configuration Management console at https://{your_KAF_base_URL}/admin.
  2. Navigate to the Hosted module at https://{your_KAF_base_URL}/admin/config/tab/hosted.
  3. Scroll down to the ltiUserIdAttribute setting.
  4. If ltiUserIdAttribute is set to ext_d2l_username, proceed to step 6. Otherwise, review Configure the Kaltura user ID value for your LMS integration before proceeding.
  5. Clear the value of ltiUserIdAttribute.
  6. Set lti13UserIdClaim to http://www.brightspace.com.
  7. Set lti13UserIdClaimProperty to username.
  8. Scroll to the bottom of the Hosted module and click Save.

Step 6 - Add the Kaltura tools and links

  1. In Brightspace, click the Admin Tools gear icon in the upper-right corner, and then select External Learning Tools.

  2. On the LTI Advantage page, click the tool you created. Scroll to the bottom of the page, and then click View Deployments. The deployment ID and a View Links link display.
  3. Click View Links. A new browser tab opens.

  4. Click New Link, and then configure each Kaltura tool you want to create.

Browse, Search, and Embed (BSE) - Quicklink

Use these steps to add the Kaltura BSE tool as a Brightspace Quicklink.

  1. Click New Link. The Create Link page displays.
  2. Make sure Enabled is selected. If it isn't, enable the tool.
  3. Complete the following fields:
    • Name - Enter the name displayed to users: Embed Kaltura Media.
    • URL - Enter https://{your_KAF_Base_URL}/d2l/index/launch/target/browseandembed. For example, https://12345.kaf.kaltura.com/d2l/index/launch/target/browseandembed.
    • Description - Optional.
    • Type - Select Deep Linking Quicklink, set Width to 1125, and set Height to 600.
    • Substitution Parameters - Optional.
    • Custom Parameters - Optional.
  4. Click Save.

Browse, Search, and Embed (BSE) - Insert Stuff

Use these steps to add the Kaltura BSE tool to Brightspace Insert Stuff.

  1. Click New Link. The Create Link page displays.
  2. Make sure Enabled is selected. If it isn't, enable the tool.
  3. Complete the following fields:
    • Name - Enter the name displayed to users: Embed Kaltura Media.
    • URL - Enter https://{your_KAF_Base_URL}/d2l/index/launch/target/browseandembed. For example, https://12345.kaf.kaltura.com/d2l/index/launch/target/browseandembed.
    • Description - Optional.
    • Type - Select Deep Linking Insert Stuff.
    • Substitution Parameters - Optional.
    • Custom Parameters - Optional.
  4. Click Save.

My Media

Use these steps to add My Media to Brightspace.

  1. Click New Link. The Create Link page displays.
  2. Make sure Enabled is selected. If it isn't, enable the tool.
  3. Complete the following fields:
    • Name - Enter the name displayed to users: My Media.
    • URL - Enter https://{your_KAF_Base_URL}/d2l/index/launch/target/my-media. For example, https://12345.kaf.kaltura.com/d2l/index/launch/target/my-media.
    • Description - Optional.
    • Type - Select Basic Launch.
    • Substitution Parameters - Optional.
    • Custom Parameters - Optional.
  4. Click Save.

Media Gallery

Use these steps to add the Kaltura Media Gallery tool to Brightspace.

  1. Click New Link. The Create Link page displays.
  2. Make sure Enabled is selected. If it isn't, enable the tool.
  3. Complete the following fields:
    • Name - Enter the name displayed to users: Course Media Gallery.
    • URL - Enter https://{your_KAF_Base_URL}/d2l/index/launch/target/course-gallery. For example, https://12345.kaf.kaltura.com/d2l/index/launch/target/course-gallery.
    • Description - Optional.
    • Type - Select Basic Launch.
    • Substitution Parameters - Optional.
    • Custom Parameters - Optional.
  4. Click Save.

Step 7 - Set up My Media as a navigation bar link

  1. Sign in to Brightspace as the administrator of the org unit where you want to add the My Media link, and then open the org unit home page.
  2. Hover over the navigation bar to display Actions for Navbar, and then click Edit This Navbar.

  3. On the Edit Navbar page, click Add Links.

  4. In the Add Links window, click Create Custom Link.
  5. In the Create Custom Link window, enter My Media in the Name field.
  6. Click Insert Quicklink.

  7. In the Insert Quicklink window, click External Learning Tools.

  8. Search for and select My Media. The URL for the My Media tool in your LTI Advantage deployment is added to the URL setting in the Create Custom Link window.

  9. On the Create Custom Link page, under Behavior, select the iframe behavior for My Media. Kaltura recommends selecting Same window.

  10. Click Create.
  11. Click Add.
  12. In the Edit Navbar window, click Save and Close. The My Media link is added to the org unit navigation bar.

Step 8 - Add Course Media Gallery to the course navigation bar

The administrator can add the Course Media Gallery tool to a course template, or an individual course administrator can add it to a course.

  1. Sign in to Brightspace as the administrator of the org unit where you want to add the link, and then open the org unit home page.
  2. Hover over the navigation bar to display Actions for Navbar, and then click Manage All Course Navbars.

  3. Select the Course Navbar to which you want to add the Course Media Gallery link. The Edit Navbar window opens.
  4. In the Edit Navbar window, click Add Links.
  5. In the Add Links window, click Create Custom Link.
  6. In the Create Custom Link window, enter Course Media Gallery in the Name field.
  7. Click Insert Quicklink.

  8. In the Insert Quicklink window, click External Learning Tools.

  9. Search for and select Course Media Gallery. The URL for the Course Media Gallery tool in your LTI Advantage deployment is added to the URL setting in the Create Custom Link window.

  10. On the Create Custom Link page, under Behavior, select the iframe behavior for Course Media Gallery. Kaltura recommends selecting Same window.

  11. Click Create.
  12. Click Add.
  13. In the Edit Navbar window, click Save and Close. The Course Media Gallery link is added to the course navigation bar.

Step 9 - Remove the LTI 1.1 tools

  1. Test that all the LTI 1.3 tools and links you added are working properly.
  2. Remove any navigation bar links for the LTI 1.1 My Media and Media Gallery Quicklinks.
  3. Set the visibility of the Kaltura LTI 1.1 external tool links to Off:
    1. Go to Admin Tools.
    2. Click External Learning Tools.
    3. Click Manage Tool Links (Legacy).
    4. Click the title of each Kaltura LTI 1.1 tool, such as Embed Kaltura Media, Insert Stuff, or Quicklinks.
    5. Clear Allow users to view this link.
Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In this article
Related articles