About

This guide describes how to upgrade the Kaltura LMS integration for Brightspace from LTI 1.1 to LTI 1.3.

Prerequisites

• Administrator access to the Brightspace account that is integrated with Kaltura
• Kaltura Application Framework (KAF) instance of type 'D2L' (minimal KAF version v5.108.10x)

Step 1 - Backup your KAF Configuration

1. Login to your KAF Configuration Management page (https://{your_KAF_base_URL}/admin).
2. Under Server Tools, click on Backup Configuration.



3. Click Save Backup.



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

4. Click Yes, Save.

5. 

   Once the backup is complete, you'll see a confirmation message: Configuration file was saved successfully.

   The backup page will display the 'last configuration save date', which reflects the date when the configuration settings were last modified, not the date the backup was performed.

Step 2 - Register the Kaltura tool in Brightspace

1. Log into your Brightspace instance using an Admin account.
2. In your Brightspace instance, click the gear icon on top right corner of the page (admin tools button), and select Manage Extensibility from the dropdown.



3. In Manage Extensibility page click the LTI Advantage tab, then click the Register Tool button.



The Register a Tool page displays.

4. Click the Standard radio button to display the tool registration fields. For the steps that follow, please refer to this image:



Enabled should be checked. If it isn't, click on the slide button to enable the tool.

5. Fill in the following fields:

• Name - give a general name to the tool. E.g: “Kaltura KAF LTI 1.3 integration”.
• Description - optional.
• Domain - Set to your KAF base URL https://{your_KAF_base_URL} e.g., “https://12345.kaf.kaltura.com”
• Redirect URIs - Set to https://{your_KAF_base_URL}/hosted/index/oauth2-launch. e.g., “https://12345.kaf.kaltura.com/hosted/index/oauth2-launch”
• OpenID Connect Login URL - Set to 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 - Set to https://{your_KAF_base_URL}/hosted/index/lti-advantage-key-set. e.g., “https://12345.kaf.kaltura.com/hosted/index/lti-advantage-key-set”
• Extensions - check the items listed below.
• Assignment and Grade Services
• Deep Linking
• Names and Role Provisioning Services
• Roles - Check the Send Institution Role
• Click the Register button.

The following alert displays.

6. Click Done

Step 3 - Update your instance to LTI 1.3

1. In Brightspace, navigate to the Administration LTI Advantage page by going to Admin Tools > Manage Extensibility > LTI Advantage (refer to steps 1 - 3 in the Register the Kaltura Tool in Brightspace section.)
2. Click on the name of the tool your created.
3. In the page to edit the tool, scroll down to the Brightspace Registration Details.
4. In a separate browser tab or window, log into your D2L KAF Configuration Management page (https://{your_KAF_base_URL}/admin).
5. Navigate to the Hosted module (https://{your_KAF_base_URL}/admin/config/tab/hosted).
6. Perform the following steps using the information listed under the Brightspace Registration Details:
   1. Set authMethod to lti1.3
      This will expose the fields listed in steps a – f.
   2. Set the lti13PlatformOidcAuthUrl value to the value listed for the OpenID Connect Authentication Endpoint.
      (for example, https://{your_D2L_Domain}/d2l/lti/authenticate)
   3. Set the lti13AuthTokenURL value to the value listed for the Brightspace OAuth2 Access Token URL.
      (for example, https://auth.brightespace.com/core/connect/token)
   4. Set the lti13KeysURL value to the value listed for the Brightspace Keyset URL.
      (for example, https://{your_D2L_domain}/d2l/.well-known/jwks)
   5. Set the lti13ClientId to the value listed for the Client Id
   6. In the lti13ServicePrivateKey section click the “Generate key pair here” link. This will generate the private and public keys.
   7. In the Certificate Generator frame click the Use button to have the key pairs saved to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
7. Scroll to the bottom of the Hosted module settings and click Save.
   

Step 4 - Add the LTI 1.3 tools 

1. In Brightspace, navigate to the  Administration LTI Advantage page by going to - Admin Tools > Manage Extensibility > LTI Advantage (refer to steps 1 - 3 in the Register the Kaltura Tool in Brightspace section.)
2. Click on the name of the tool your created and navigate to the bottom of the page.
3. Click on the View Deployments button.
4. Click on the New Deployment button.
5. Enabled should be checked. If it is not, click on the slide button to enable the tool.
6. Fill in the configuration values as follows:
7. Tool – Select the tool registered in the Register the Kaltura Tool in Brightspace section.
8. Name – enter a name for the tool set (for example, Kaltura LTI 1.3 Tools)
9. Description – optional
10. Extensions – check all three check boxes:
    • Assignment and Grade Services
    • Deep Linking
    • Names and Role Provisioning Services
11. Security Settings – check the following boxes, and their child boxes:
    • Org Unit Information
    • User Information
    • Link Information
    • Classlist including users not know to tool
12. Configuration Settings – check the following box:
    • Auto Create Grade Items
13. Make the tool available to – Select your org unit, and add All descendants.
    
14. Click the Create Deployment button. The following confirmation alert displays:
    
15. Click View Links to move to the next steps.

Step 5 - Configure the Kaltura user ID value

The default Kaltura User ID value will be your Brightspace User ID.  

With the Kaltura LMS integration, user ID records are passed from the LMS to Kaltura in the LTI Launch.  A Kaltura admin can configure settings in KAF which will determine which claim:property pair to use from the launch as the Kaltura User ID. 

With the implementation of LTI 1.3, Kaltura has added fields in the Hosted module to support the user ID assignment in Kaltura.

lti13UserIdClaim - the LTI Claim from which the user ID should be taken from

lti13UserIdClaimProperty - the property from the claim that the user ID should be taken from

When using LTI 1.1 as the authentication method (KAF>Hosted>authmethod=lti) for Kaltura, admins used the KAF Hosted module's ltiUserIdAttribute field to set the value for which LTI attribute to use for the user ID value.   

LTI 1.1 default value:

• ltiUserIdAttribute =  ext_d2l_username 

When using LTI 1.3 as the authentication method KAF>Hosted>authmethod=lti1.3 for Kaltura, admins used the KAF Hosted module's lti13UserIdClaim and lti13UserIdClaimProperty field to set the value for which LTI attribute to use for the user ID value.

LTI 1.3 default values:

• ltiUserIdAtrribute = blank
• lti13UserIdClaim = http://www.brightspace.com
• lti13UserIdProperty = username

To view and configure these settings using the default values:

1. Login to your KAF Configuration Management page
   (https://{your_KAF_base_URL}/admin)
2. Navigate to the Hosted Module  
   (https://{your_KAF_base_URL}/admin/config/tab/hosted)
3. Scroll down on the page to the ltiUserIdAttribute setting.
4. If the value for ltiUserIDAttribute is set to ext_d2l_username then proceed to step 6.
   Otherwise please read the following Kaltura Knowledge Center article before proceeding.  Configuring the Kaltura User ID Value to Use with Your LMS Integration.  
5. Set ltiUserIdAttribute = blank
6. Set lti13UserIdClaim = http://www.brightspace.com
7. Set lti13UserIdProperty = username
8. Scroll to the bottom of the Hosted module settings and click Save.

Step 6 - Add the Kaltura tools / links

1. In Brightspace, click the gear icon on top right (admin tools button), and click on External Learning Tools.
   
2. On the LTI Advantage page click on the tool you created, scroll to the bottom of the page, and click on View Deployments. This is where you will see the tool Deployment Id, and a View Links link. Click on the View Links link, a new browser tab opens.
    
3. Click on the “New Link" button, and fill in the configuration for each of the Kaltura tools you would like to create:
   

Browse, Search, and Embed (BSE) - Quick Link

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

1. Clicking the New Link button will display the Create Link page.
2. Enabled should be checked. If it isn't, click on the slide button to enable the tool.
3. Fill in the following information:
   1. Name – the name that users will see for the tool: Embed Kaltura Media
   2. URL - https://{your_KAF_Base_URL}/d2l/index/launch/target/browseandembed
      (for example, https://12345.kaf.kaltura.com/d2l/index/launch/target/browseandembed)
   3. Description – optional
   4. Type – select Deep Linking Quicklink, set Width 1125, Height 600
   5. Substitution Parameters - optional
   6. Custom Parameters – options
4. Click Save.
   

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

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

1. Clicking the New Link button will display the Create Link page.
2. Enabled should be checked. If it is not, click on the slide button to enable the tool.
3. Fill in the following information:
   1. Name – the name that users will see for the tool: Embed Kaltura Media
   2. URL - https://{your_KAF_Base_URL}/d2l/index/launch/target/browseandembed
      (e.g. https://12345.kaf.kaltura.com/d2l/index/launch/target/browseandembed)
   3. Description – optional
   4. Type – select Deep Linking Insert Stuff
   5. Substitution Parameters - optional
   6. Custom Parameters – options
4. Click Save.
   

My Media

Use these steps to add Kaltura's My Media tool to Brightspace.

1. Clicking the New Link button will display the Create Link page.
2. Enabled should be checked. If it is not, click on the slide button to enable the tool.
3. Fill in the following information:
   1. Name – the name that users will see for the tool: My Media
   2. URL - https://{your_KAF_Base_URL}/d2l/index/launch/target/my-media
      (for example, https://12345.kaf.kaltura.com/d2l/index/launch/target/my-media)
   3. Description – optional
   4. Type – select Basic Launch
   5. Substitution Parameters - optional
   6. Custom Parameters – options
4. Click Save.
   

Media Gallery

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

1. Clicking the New Link button will display the Create Link page.
2. Enabled should be checked. If it isn't, click on the slide button to enable the tool.
3. Fill in the following information:
   1. Name – the name that users will see for the tool: Course Media Gallery.
   2. URL - https://{your_KAF_Base_URL}/d2l/index/launch/target/course-gallery
      (for example, https://12345.kaf.kaltura.com/d2l/index/launch/target/course-gallery)
   3. Description – optional
   4. Type – select Basic Launch
   5. Substitution Parameters - optional
   6. Custom Parameters – options
4. Click Save

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

1. Log into Brightspace as the administrator of the org unit you want to add the My Media link to and go to the org unit home page.
2. Hover over the navigation bar in order for the Actions for Navbar button to appear, and click on Edit This Navbar.
   
3. In the Edit Navbar page, click on Add Links.
   
4. In the Add Links window, click on Create Custom Link.
5. In the Create Custom Link window:
   1. Name - the name that users will see for the navbar link: My Media
   2. Click on Insert Quicklink. 
   3. In the Insert Quicklink window, click on External Learning Tools.
      
   4. In the Insert Quicklink window, search for My Media and click on it. The URL for the My Media tool for your LTI Advantage Deployment will be added to the URL setting in the Create Custom Link window.
      
   5. On the Create Custom Link page under Behavior, select the iframe behavior for My Media. Kaltura recommends selecting Same window.
   6. Click Create.
6. Click Add.
7. In the Edit Navbar window click Save and Close. The My Media link is now added to the Org Unit Navbar.

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

Adding the Course Media Gallery tool can be done either by the admin in the course template, or by the individual course admin.

1. Login to Brightspace as the administrator of the org unit you want to add the link to and go to the org unit home page.
2. Hover over the navigation bar in order for the Actions for Navbar button to appear and click on the Manage All Course Navbars option.
   
3. Select the Course Navbar that you would like to add the Course Media Gallery link to.   The Edit Navbar window opens.
4. In the Edit Navbar window, click on the Add Links button.
5. In the Add Links window, click on Create Custom Link.
6. In the Create Custom Link window:
   1. Name - the name that users will see for the navbar link: “Course Media Gallery”
   2. Click on Insert Quicklink 
   3. In the Insert Quicklink window, click on External Learning Tools.
   4. In the Insert Quicklink window, search for Course Media Gallery and click on it. The URL for the Course Media Gallery tool for your LTI Advantage Deployment will be added to the URL setting in the Create Custom Link window.
      
   5. On the Create Custom Link page under Behavior, select the iframe behavior for the Course Media Gallery.  Kaltura recommends selecting Same window.

   6. Click Create.

7. Click Add.

8. In the Edit Navbar window click Save and Close. The Course Media Gallery link is now added to the Course Navbar.
   

Step 9 - Remove LTI 1.1 Tools 

1. Test that all the LTI 1.3 tools/links that you have added are working properly.
2. Remove any navigation bar links for the LTI 1.1 My Media and Media Gallery quick links.
3. Change the visibility to the external tool links for the Kaltura tools to Off. 
   1. Go to Admin Tools.
   2. Click on External Learning Tools.
   3. Click on Manage Tool Links (Legacy). 
   4. Click on the title for each of the Kaltura LTI 1.1 tools (e.g., Embed Kaltura Media, insert stuff, quicklinks).
   5. Uncheck the setting Allow users to view this link.