Kaltura Video Tool for Blackboard Ultra Upgrading from LTI 1.1 to LTI 1.3

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

Before You Begin

As of August 8, 2022, with the release of KAF version 5.108.10x, Kaltura has added the capability for KAFs configured for LTI 1.3 to continue supporting the launch of old embed codes added using the Kaltura Browse Search and Embed tool which supported LTI 1.1 with the same KAF.

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, then 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

• Access to your organizations Blackboard Developer Portal
• Administrator access to the Blackboard account that is integrated with Kaltura.
• Administrator access to the Kaltura Management console for the account that is integrated with the Blackboard instance.
• Administrator access to the Kaltura Application Framework (KAF) instance of type 'BlackboardUltra' (minimal KAF version v5.108.10x) that is integrated with the Blackboard instance.
  • The KAF instance should contain the following modules:
    • Bbultra module
    • Browseandembed module
    • Hosted module
    • Hostedrelated module
    • LTIgrading module

The Blackboard Ultra LTI 1.1 to LTI 1.3/Advantage Migration Tool

Blackboard Ultra includes a migration tool which will automatically migrate your Kaltura LTI 1.1 tools to LTI 1.3/Advantage tools.   Steps for using the migration tool for this update can be found in section 3 of this guide.

Deployment Instructions

This section describes how to deploy the Kaltura Video Extension for Blackboard using Application Registration and Deployment settings provided by Blackboard which will allow you to upgrade and deploy the Kaltura external tools that have been implement in Blackboard using LTI 1.1 to LTI 1.3.   The following sections provide the steps to:

1. Register the Kaltura Application in the Blackboard Developer Portal.
2. Enable and configure LTI 1.3 support within your KAF (Kaltura Application Framework) instance and upgrade the Kaltura LTI tools in Blackboard Ultra from LTI 1.1 to LTI 1.3.

Section 1:  Registering the Kaltura Application

To implement the Kaltura LMS Integration with Blackboard using LTI 1.3 you will need to first Register the Application in the Blackboard Developer Portal.   This process provides you with the ID, key, secrets, and URLs needed to support the LTI 1.3 implementation.

To execute the steps in this section you will need to have an account on the Blackboard Developer Portal and have a Production Group to assign the application to.   For more information on Blackboard Developer Portal Groups please go to https://docs.blackboard.com/rest-apis/learn/admin/production-groups. 

1. Login to your Blackboard Developer Portal account at https://developer.blackboard.com. 
2. On the My Applications page, click on the "+" button to create a new application.
   
3. On the Register a New Application page enter the following:
   1. Application Name – Kaltura recommends you use an application name that is unique for the KAF you are using for the integration. 
   2. Description – add descriptive information for the new application.
   3. Domain(s) – set to your KAF URL. e.g. bb-lti13-2964661-test1.kaf.kaltura.com.  Do NOT include https:// or a / at the end.

      In order to use the Blackboard Ultra LTI 1.1 to LTI 1.3 migration tool (Section 3) you must use the Provider Domain value used by your LTI 1.1 Kaltura Tool Provider for the Domain value.

   4. Group – select the production group to assign the application to.
   5. Click on the switch to the right of “My Integration supports LTI 1.3” to expose the LTI 1.3 settings.
      Fill in the fields as follows:
      Login Initiation URL = https://{your_KAF_URL}/hosted/index/oidc-init
      Tool Redirect URL = https://{your_KAF_URL}/hosted/index/oauth2-launch
      Tool JWKS URL = https://{your_KAF_URL}/hosted/index/lti-advantage-key-set
      Signing Algorithm = RS256
   6. Click Register Application  
      The settings for your registered application will be displayed.  
4. Copy the settings and store in a safe and secure location.
5. Keep this page open to use the settings for the next section of the implementation.

Section 2: Setting the LTI 1.3 Configuration in Your KAF Instance

In this section you will configure your KAF to support LTI 1.3 and connect with your Blackboard instance.

1. Login to your BlackboardUltra KAF Configuration Management page.  (https://{your_KAF_URL}/admin).
2. Navigate to the Hosted Module.
3. In the Hosted Module set authMethod to “lti1.3”.
   This will expose the fields listed in steps 4.
4. Fill in the following fields using the values from Section 1, step 4.
   1. lti13PlatformOidcAuthUrl = OIDC auth request endpoint
   2. lti13AuthTokenUrl = Auth token endpoint
   3. lti13KeysUrl =  Public keyset URL
   4. lti13ClientId = Application ID
5. For the "lti13ServicePrivateKey", click the 'generate key pair here' link. This will generate the keys.
   
6. In the Certificate Generator frame click Use to have the key pairs saved to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
   
7. In the ltiRolesMapping section, scroll to ltiRole = None. 
8. Set the kmsRole to privateOnlyRole.
   
9. Scroll to the bottom of the Hosted module settings and click Save.

Section 3: Adding the LTI 1.3 Tool Provider in Blackboard 

In this section you will create the LTI Advantage Tool Provider in Blackboard and use the Blackboard LTI migration tool to update your Kaltura LTI 1.1 tools to LTI Advantage.

1. Login to your Blackboard instance with an Account Admin user account.
2. Navigate to Administrator Tools > Integrations > LTI Tool Providers
3. In the LTI Tool Providers Page click on Register LTI1.3/Advantage Tool
   
4. In the Client ID field insert the same Application ID used for the lti13ClientId in step 4d in the previous section.
   
5. Click Submit.
   The following popup box will appear.
   
6. Click OK to continue.
   The Tool Status page will display with fields populated with the settings of the LTI 1.1 Kaltura Tool Provider
7. Confirm the settings, and update as needed:
   Important:  Make sure 
   1. Client ID – application id value for your registered application
   2. Name – name for your registered application
   3. Description – description for your registered application
   4. Deployment ID – deployment id for your LTI 1.3 tool
   5. Initiate Login URL – login initiation URL for your registered application
   6. Tool Redirect – tool redirect URL for your registered application
   7. Domains – your KAF domain (do not include “https://” or the trailing “/”)
   8. Tool Status – set to Approved
   9. Tool Provider Custom Parameters
      1. Add the following two parameters:
         lis_user_username=@X@user.id@X@
         lis_course_id=@X@course.id@X@
   10. User Fields to Send
       1. Role in Course – checked
       2. Name – checked
       3. Email Address – checked
   11. Allow grade service access – set to Yes
   12. Allow Membership Service Access – set to Yes
8. Click Submit.
   You receive a Success message.
   The LTI 1.1 Tool Provider and the Kaltura tool placements have now been upgrade to LTI 1.3/Advantage

Section 4: Confirm the Configuration of the Kaltura Tool Placements

In this section you will confirm the configuration of the Tool Placements for the following Kaltura tools:

• My Media
• Media Gallery
• Browse Search and Embed
• Interactive Video Quiz

Each tool is independent of the others, and you may select to use any one of them or all of them.

Start by performing the following steps:

1. Login to your Blackboard instance with an Account Admin user account.
2. Navigate to Administrator Tools > Integrations > LTI Tool Providers.
3. On the LTI Tool Providers page locate the Tool Provider you migrated to LTI 1.3.
4. Hover over the name for the Tool Provider to expose the icon for the options menu and click on the icon to display the list of options.
5. Click on Manage Placements
6. Hover over the name of a placement to expose the icon for the options menu and click on the option to edit.
7. Review the settings described in each subsection to confirm that the  placement for the Kaltura tool is configured properly.

Section 4a: Kaltura My Media Placement

1. Label – the name of the tool.  This will be the name displayed to users and can be any value.  (ex. My Media)
2. Description – enter a description for the tool
3. Handle – the internal ID for the tool. (ex. KalturaMyMedia)
4.  Availability – to make the tool available to users set to Yes
5. Type – select System Tool
6. Icon
   1. Save the Kaltura icon to a location on your computer.
      
   2. Click the browse button to browse to the location you saved the icon to.
   3. Select the icon file and add to the placement
7. Target Link URI - Fill in your KAF URL concatenated with the following URL: /bbultra/index/launch/target/my-media
   Ex. https://123456.kaf.kaltura.com/bbultra/index/launch/target/my-media
8. Click Cancel if no changes have been made or Submit to save any changes.

Section 4b: Kaltura Media Gallery Placement

1. Label – the name of the tool.  This will be the name displayed to users and can be any value.  (ex. Media Gallery)
2. Description – enter a description for the tool
3. Handle – the internal ID for the tool. (ex. KalturaMediaGallery)
4. Availability – to make the tool available to users set to Yes
5. Type – select Course Tool
   1. Check Allow student access
6. Icon
   1. Save the Kaltura icon to a location on your computer
      
   2. Click the browse button to browse to the location you saved the icon to.
   3. Select the icon file and add to the placement
7. Target Link URI - Fill in your KAF URL concatenated with the following URL: /hosted/index/course-gallery
   Ex. https://123456.kaf.kaltura.com/hosted/index/course-gallery
8. Click Cancel if no changes have been made or Submit to save any changes.

Section 4c: Kaltura Browse Search and Embed Placement

1. Label – the name of the tool.  This will be the name displayed to users and can be any value.  (ex. Kaltura Embed Media)
2. Description – enter a description for the tool
3. Handle – the internal ID for the tool.  (ex. KalturaBSE)
4. Availability – to make the tool available to users set to Yes
5. Type – select Deep Linking content tool
   1. Check Allow student access
6. Icon
   1. Save the Kaltura icon to a location on your computer
      
   2. Click the browse button to browse to the location you save the icon to.
   3. Select the icon file and add to the placement
7. Target Link URI - Fill in your KAF URL concatenated with the following URL:  /browseandembed/index/browseandembed
   Ex. https://123456.kaf.kaltura.com/browseandembed/index/browseandembed
8. Click Cancel if no changes have been made or Submit to save any changes.

Section 4d. Kaltura Interactive Video Quiz Placement

1. Label – the name of the tool.  This will be the name displayed to users  and can be any value.  (ex. Kaltura Video Quiz)
2. Description – enter a description for the tool
3. Handle – the internal ID for the tool. (ex. KalturaVideoQuiz)
4. Availability – to make the tool available to users set to Yes
5. Type – select Deep Linking content tool
   1. Check Allow student access
6. Icon
   1. Save the Kaltura icon to a location on your computer
      
   2. Click the browse button to browse to the location you save the icon to.
   3. Select the icon file and add to the placement
7. Target Link URI - Fill in your KAF URL concatenated with the following URL: /browseandembed/index/browseandembed?type=quiz   Ex. https://123456.kaf.kaltuar.com/browseandembed/index/browseandembed?type=quiz
8. Click Cancel if no changes have been made or Submit to save any changes.

Section 5: Confirm the REST API Integration Configuration for Kaltura

The REST API Integration allows you to use the Blackboard REST API to publish content from My-Media to Media Galleries and to import content from one Media Gallery to another.

For more information on how to implement the REST API Integration using a User Account with a Custom System Role, please refer to Section 5 Option 1 of the Kaltura Video Tool for Blackboard Deployment Guide - LTI 1.3. 

Use the following steps to confirm the REST API Integration 

1. Login to your Blackboard instance with an Account Admin user account.
2. Navigate to Administrator Tools > Integrations > REST API Integrations.
   
3. On the REST API Integrations page locate the Kaltura for Blackboard integration.
4. Hover over the name to expose the icon for the options menu and click on the option to edit.
5. Review the settings listed below to confirm that the REST API Integration for Kaltura is configured properly.
   1. Application ID - Use the Kaltura Application ID: 8d68a3e5-4643-4152-bded-6bca9eb39312
   2. Learn User - set to the Blackboard user that will be used
   3. End User Access - set to YES.
   4. Authorize To Act As User - set to Service Default (No).
      
6. Click Cancel if no changes have been made or Submit to save any changes.

Section 6: Configure the Kaltura User ID Value

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

With the Kaltura LMS integration, user ID records are passed from the LMS to Kaltura in the LTI Launch.  Kaltura admins can use the Kaltura Application Framework (KAF) Hosted module's "ltiUserIdAttribute" field to set the value for which LTI attribute to use for the user ID value.

When using LTI 1.1 as the authentication method (KAF>Hosted>authmethod=lti) for Kaltura,  the default value for the ltiUserIdAttribute is lis_person_sourcedid. 

IMPORTANT!  If the value for ltiUserIdAttribute in your KAF instance is not set to lis_person_sourcedid then please stop and review Configuring the Kaltura User ID Value to Use with your LMS Integration.

When using LTI 1.3 as the authentication method KAF>Hosted>authmethod=lti1.3) for Kaltura, in order for the User ID to match the value that was used previously in LTI 1.1,  Kaltura has implemented a custom parameter in Blackboard (see Section 3 step 7.9) for the LTI attribute that contains the User ID value.

To view and configure the ltiUserIdAttribute setting using the default value for the LTI 1.3 integration.

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. Set ltiUserIdAttribute = custom_lis_user_username
5. Scroll to the bottom of the Hosted module settings and click Save.