Kaltura Video Extension for Brightspace by D2L Deployment Guide - LTI 1.3

This guide describes how to add the Kaltura Video Extension for Brightspace with LTI version 1.3 to your Brightspace environment. This guide is intended for Brightspace and Kaltura administrators.

Installation Overview and Requirements

The Kaltura Video Extension for Brightspace is implemented as a set of LTI external tools. The tools are added manually through the LTI Advantage Tool Registration and Deployment functionality within Brightspace.  

Prerequisites

• A Kaltura account
• A Kaltura Application Framework (KAF) instance of type D2L
  • minimal KAF version is v5.99.46
• A Brightspace account

Deployment Instructions

This section describes how to deploy the Kaltura Video Extension for Brightspace.  The Kaltura Video Extension for Brightspace uses the LTI Advantage Tool Registration and Deployment settings in Brightspace which allows you to create and deploy the Kaltura external tools in Brightspace using LTI 1.3.   The following sections provide the steps to:

1. Register the Kaltura tool in Brightspace
2. Enable and configure LTI 1.3 support within your KAF instance
3. Deploy the Kaltura tools in Brightspace
4. Configure the Kaltura tools/links in Brightspace
5. Insert the Kaltura tool links within the Brightspace navigation bar

Step 1. Register the Kaltura Tool in Brightspace

1. Login to your Brightspace instance with an Admin user account.
2. In Brightspace, click the 'Admin Tools' (little gear on top right) 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 following steps 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. 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”
   7. Extensions - check the following items.
      i. Assignment and Grade Services
      ii. Deep Linking
      iii. Names and Role Provisioning Services
   8. Roles - Check the Send Institution Role
7. Click the “Register” button. The following alert displays:
   
8. Click "Done".

Step 2. Set the Configuration in the KAF Instance

1. In Brightspace navigate to the LTI Advantage page - 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 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.brightspace.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. 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.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

For advanced information on how to configure the Kaltura User ID value using other LTI 1.3 launch attributes please read the following Kaltura Knowledge Center article before proceeding.  Configuring the Kaltura User ID Value to Use with Your LMS Integration.

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 4. Adding the LTI Tool in Brightspace

1. In Brightspace navigate to the LTI Advantage page - 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:
      i. Assignment and Grade Services
      ii. Deep Linking
      iii. Names and Role Provisioning Services
   5. Security Settings – check the following boxes, and their child boxes
      i. Org Unit Information
      ii. User Information
      iii. Link Information
      iv. Classlist including users not know to tool
   6. Configuration Settings – check the following box:
      i. 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 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 1125, Height 600
   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. 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.