Upgrade Kaltura LMS Video integration for Sakai from LTI 1.1 to LTI 1.3


About

This article explains how to upgrade the Kaltura LMS Video integration in Sakai from LTI 1.1 to LTI 1.3.

The upgrade is performed by updating each existing Sakai external tool from LTI 1.1 to LTI 1.3, then configuring the matching LTI 1.3 settings in Kaltura.

Existing media and embedded content created using LTI 1.1 will continue to work after the upgrade.

Watch the video below for a quick walkthrough of upgrading the Kaltura LMS Video integration in Sakai from LTI 1.1 to LTI 1.3. Comprehensive step-by-step instructions are provided below.

Prerequisites

  • Kaltura administrator access
  • Sakai administrator access
  • A Kaltura Application Framework (KAF) instance URL of type "Sakailti".

Throughout these instructions you will be asked to enter your specific KAF domain whenever you see {your_KAF_domain}.  If you have implemented an alias or Vanity Domain for your KAF domain, that is the domain that you should enter.

Step 1 – Back up your configuration

  1. Log into your Configuration Management console (https://{your_KAF_domain}/admin).
  2. Under Server Tools, click Backup Configuration.
  3. On the 'Backup Configuration' page, click Save Backup.
  4. A confirmation message displays.

  5. Click Yes, Save then click OK.
  6. Once the backup is complete, you'll see a confirmation message.

    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.

Leave your browser tab open, then open a new browser tab for Sakai and complete the steps below.

Step 2 – Upgrade the Sakai external tools to LTI 1.3

  1. Log in to Sakai as an administrator.
  2. Click Sites in the upper-right corner of the page.
  3. On the 'Sites' page, click Administration Workspace.
  4. In the left navigation menu, scroll down and click External Tools.
  5. The 'Installed Tools' page displays.
  6. On the Installed Tools page, you will see many tools. We are going to focus on the four Kaltura tools that should be currently installed for LTI 1.1:

  • My Media
  • Media Gallery
  • Embed Kaltura Media 
  • Kaltura Video Quiz

  • 6. Locate the tool you want to upgrade (for example, My Media) and click Edit in the Actions column for this tool.
  • The External Tool page for that tool displays.

  • 7. Scroll down to the setting that says: Sakai supports either LTI 1.1 or LTI 1.3 ... and select Tool supports LTI 1.3.
  • Additional LTI 1.3 settings display.

  • 8. Complete the fields as follows:
    • LTI 1.3 Tool Keyset / JWS URL - enter https://{your_KAF_domain}/hosted/index/lti-advantage-key-set
    • LTI 1.3 Tool OpenID Connect / Initialization Endpoint - enter https://{your_KAF_domain}/hosted/index/oidc-init
    • LTI 1.3 Tool Redirect Endpoint(s) - enter https://{your_KAF_domain}/hosted/index/oauth2-launch

    The fields should look like this:

    After the fields are configured, the section These values can be provided to an LTI tool... displays.

    You will use these values later when configuring the My Media tool in KAF.

    There's no need to make a note of these values now. You can view these settings again by clicking the tool name on the Installed Tools page when you need them.

  • 9. Click Save.
  • Repeat these steps for each remaining Kaltura tool:
    • Media Gallery
    • Embed Kaltura Media
    • Kaltura Video Quiz

    Step 3 – Enable LTI 1.3 in KAF

    1. Click to open your browser tab that has the Configuration Management console.
    2. Navigate to the Hosted module: https://{your_KAF_domain}/admin/config/tab/hosted
    3. The 'Hosted' page opens.

    4. Scroll down to the authMethod field and select lti1.3 from the dropdown.
    5. Additional LTI 1.3 configuration fields display. You will fill those in in the next step.

    6. Scroll to the bottom of the page and click Save.

    Step 4 – Configure the My Media tool in KAF

    The My Media external tool is configured first and creates the shared LTI 1.3 key pair used by the integration.

    Keep your Sakai and your Configuration Management console tabs open side-by-side in your browser to make copying and pasting between systems easier.

    1. In Sakai, navigate to the Installed Tools page and click the title of the My Media external tool.
    2. The View Installed Tool page opens.

    3. Scroll down to view the values you will copy into the Hosted module.
    4. In another browser tab, navigate to the Hosted module in your Configuration Management console (https://{your_KAF_domain}/admin/config/tab/hosted).
    5. Scroll to the LTI 1.3 configuration fields and paste in the values from Sakai as follows:
    • lti13PlatformOidcAuthUrl - paste in value from LTI 1.3 LMS OIDC Endpoint URL
    • lti13AuthTokenUrl - paste in value from LTI 1.3 LMS OAuth Token URL
    • lti13KeysUrl - paste in value from LTI 1.3 LMS Keyset URL
    • lti13ClientId - paste in value from LTI 1.3 Client ID

  • 5. In the lti13ServicePrivateKey section, click generate key pair here.
  • This generates the keys.

  • 6. In the 'Certificate Generator' window, click Use to have the key pairs saved to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
  • 7. Scroll to the bottom of the 'Hosted' page and click Save.
  • Step 5 - Configure the remaining tools

    1. In Sakai, go to the Installed Tools page and click the title of the next tool you want to configure (e.g. Media Gallery) to view its details.
    2. The 'View Installed Tool' page opens for that tool.

    3. Scroll down to the values that you will copy in the next steps.
    4. In the Hosted module, scroll down to the ltiAdditionalIntegrations section and click the +Add "ltiAdditionalIntegrations" button.
    5. A new LTI 1.3 configuration section displays.

    6. Copy the values from the Sakai 'View Installed Tool' page and paste them into the new configuration section:
    • lti13PlatformOidcAuthUrl - paste in value from LTI 1.3 LMS OIDC Endpoint URL
    • lti13AuthTokenUrl - paste in value from LTI 1.3 LMS OAuth Token URL
    • lti13KeysUrl - paste in value from LTI 1.3 LMS Keyset URL
    • lti13ClientId - paste in value from LTI 1.3 Client ID

  • 5. Scroll to the bottom of the page and click Save.
  • The page refreshes after saving.

  • 6. Repeat these steps for the remaining tools:
    • Embed Kaltura Media
    • Kaltura Video Quiz

    This completes the upgrade of the Kaltura LMS Video integration from LTI 1.1 to LTI 1.3.


    Was this article helpful?
    Thank you for your feedback!
    User Icon

    Thank you! Your comment has been submitted.

    In this article
    Related articles
    • None