Kaltura Video Extension for Brightspace Upgrading from LTI 1.1 to LTI 1.3

This guide describes how to upgrade the Kaltura Video Extension for Brightspace supporting LTI 1.1 to LTI 1.3. This guide is intended for Kaltura and Brightspace by D2L administrators.

Before you Begin

Backup your KAF Configuration

You should perform the following tasks before upgrading your Kaltura Video Extension for Brightspace Kaltura Application Framework (KAF) from LTI 1.1 to LTI 1.3. 

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.
4. In the Configuration Backup popup, click Yes, Save.
   The Configuration Backup displays “Configuration file was saved successfully.”
   A message displays on the Backup Configuration page listing the Last Configuration save date.
5. In the Configuration Backup popup, click OK.

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. Register the Kaltura Tool in Brightspace

1. Login to your Brightspace instance using an Admin account
2. In your Brightspace instance, click the Admin Tools (gear icon on top right corner of the page) button, and click on Manage Extensibility. 
3. In Manage Extensibility page select the “LTI Advantage” tab and click the “Register Tool” button.
   
4. The Register a Tool page will display.  Click the Standard radio button to display the Tool Registration fields.   For the steps that follow, please refer to this picture.

5. Enabled should be checked.  If it is not, click on the slide button to enable the tool.

6. Fill in the following fields:

   1. Name - give a general name to the tool. E.g: “Kaltura KAF LTI 1.3 integration”.

   2. Description - optional.

   3. Domain - Set to your KAF base URL https://{your_KAF_base_URL} e.g., “https://12345.kaf.kaltura.com”

   4. Redirect URIs - Set to https://{your_KAF_base_URL}/hosted/index/oauth2-launch. e.g., “https://12345.kaf.kaltura.com/hosted/index/oauth2-launch”

   5. OpenID Connect Login URL - Set to https://{your_KAF_base_URL}/hosted/index/oidc-init. e.g., “https://12345.kaf.kaltura.com/hosted/index/oidc-init”

   6. Target Link URI - leave this field blank

   7. 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”

   8. Extensions - check all 3 check boxes.

      1. Assignment and Grade Services

      2. Deep Linking

      3. Names and Role Provisioning Services

   9. Roles - Check the Send Institution Role

7. Click the Register button. The following alert displays.
   

8. Click Done

Step 2. Update your KAF 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 Step 1 - 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 login to 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.
      (e.g. https://{your_D2L_Domain}/d2l/lti/authenticate)
   3. Set the lti13AuthTokenURL value to the value listed for the Brightspace OAuth2 Access Token URL.
      (e.g. https://auth.brightespace.com/core/connect/token)
   4. Set the lti13KeysURL value to the value listed for the Brightspace Keyset URL.
      (e.g. 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 3. Adding the Kaltura LTI 1.3 Tools in Brightspace

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:
   1. Tool – Select the tool registered in the Register the Kaltura Tool in Brightspace section.
   2. Name – enter a name for the tool set (e.g. “Kaltura LTI 1.3 Tools”)
   3. Description – optional
   4. Extensions – check all 3 check boxes:
      1. Assignment and Grade Services
      2. Deep Linking
      3. Names and Role Provisioning Services
   5. Security Settings – check the following boxes, and their child boxes
      1. Org Unit Information
      2. User Information
      3. Link Information
      4. Classlist including users not know to tool
   6. Configuration Settings – check the following box:
      1. Auto Create Grade Items
   7. Make the tool available to – Select your org unit, and add “All descendants”
      
   8. Click the “Create Deployment” button. The following confirmation alert displays:
      
   9. Click “View Links” to move to the next steps.
      Note:  If you click “Done” by mistake, you will be able to access the links view in the next section.

Step 4. 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 5.
   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 5. Adding the Kaltura Tools/Links in Brightspace

1. In Brightspace, click the 'Admin Tools' (little gear on top right) 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:
   

Step 5a. Kaltura Tools - 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 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 Quicklink”, set Width 1600, Height 800
   5. Substitution Parameters - optional
   6. Custom Parameters – options
4. Click “Save”.
   

Step 5b. Kaltura Tools - 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".
   

Step 5c. Kaltura Tools - My Media

Use these steps to add the Kaltura 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
      (e.g. 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”.
   

Step 5d. Kaltura Tools - 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 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: “Course Media Gallery”.
   2. URL - https://{your_KAF_Base_URL}/d2l/index/launch/target/course-gallery
      (e.g. 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 6. Set up My Media and Course Media Gallery as a Navigation Bar Link in Brightspace

Add My Media to the Org Unit Navigation Bar

1. Login to 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 the Edit This Navbar option.
   
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 7. 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 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 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 8. Removing the Kaltura LTI 1.1 Tools from Brightspace

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 quicklinks.
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.

D2L Brightspace LTI Migration - migrating existing Legacy LTI links (1.1.x) to LTI Advantage (1.3)

The Kaltura LTI 1.3 integration has built in support for the authentication and launch of LTI 1.1 links.  After upgrading your Kaltura tools from LTI 1.1 to LTI 1.3, Kaltura recommends that you develop a plan to migrate the existing Legacy LTI Links (1.1.x) to LTI Advantage (1.3).

D2L supports four different methods of migrating existing Legacy LTI links (1.1.x) to LTI Advantage (1.3):

• Using the Migrate button of the Manage Tool Links (Legacy) tab to manually migrate links
• Using the LTI Migration API
• Course Import
• Course Copy

Please go to https://documentation.brightspace.com/EN/integrations/ipsis/LTI%20Advantage/lti_migration.htm for more information.