Kaltura LTI Tool for Sakai Deployment Guide

This guide describes how to add the Kaltura LTI Tool to your Sakai environment.

Please refer to the official and latest product release notes for last-minute updates. Technical support may be obtained directly from: Kaltura Customer Care.

Contact Us: Please send your documentation-related comments and feedback or report mistakes to knowledge@kaltura.com. We are committed to improving our documentation and your feedback is important to us.

[/collapsed]

[collapsed title="Audience"]

Audience

This guide is intended for Sakai and Kaltura administrators.

[/collapsed]

[collapsed title="Kaltura LTI Tool for Sakai Installation Overview and Requirements"]

Kaltura LTI Tool for Sakai Installation Overview and Requirements

The Kaltura LTI Tool for Sakai is implemented as a Sakai External Tool and is added manually by a Sakai administrator. Please refer to the Sakai Community Documentation on how to manually configure an external tool on your Sakai environment.

[/collapsed]

[collapsed title="Prerequisites"]

Prerequisites

  • A Kaltura account:
    • Partner id (PID) and Admin Secret for your Kaltura account. Alternatively, you can find this information in KMC under
      Settings > Integration Settings.
    • A Kaltura Application Framework instance URL, for example: 12345678.kaf.kaltura.com

[/collapsed]

[collapsed title="Kaltura LTI Tool for Sakai Deployment Instructions"]

Kaltura LTI Tool for Sakai Deployment Instructions

This section describes how to deploy the Kaltura LTI Tool for Sakai.

Deploying My Media

To deploy My Media

  1. Login to the Sakai environment as an admin user.
  2. Click on the Sites button in the upper right corner of the screen. 
  3. On the Sites tab, click on Administration Workspace. 
  4. Click on External Tools in the left side menu of the screen. 
  5. Click on Install LTI 1.x Tool on the right of the screen. 
  6. Enter text in the mandatory fields as follows:
    Field NameEntry
    Tool Title (Above the tool)My media
    Button Text (Text in tool menu)My media tool
    Launch URLhttps://KAF-base-URL/hosted/index/my-media
    Launch KeyEnter your Partner ID
    Launch SecretEnter your admin secret
  7. Under "Privacy Settings", check "Send User Names to External Tool" and "Send Email Addresses to External Tool".
  8. Under "Services", check "Provide Roster to External Tool" and "Allow External Tool to store setting data".
  9. Under "Indicate the following types of Content Item/Deep Link Selection launches...", check "Allow the tool to be launched as a link (this is typically true for most tools)".
  10. Under "If you select LTI 1.3 Support, your configuration information should be immediately...", check "Tool supports LTI 1.3".  
  11. Click Save. A message displays confirming that the external tool has been added to the system. The My Media tool is listed in the list of Installed Tools and a new navigation menu item is available in the course menu.

[/collapsed]

[collapsed title="Deploying the Media Gallery"]

Deploying the Media Gallery 

To deploy the Media Gallery

  1. Login to the Sakai environment as an admin user. 
  2. Click on the Sites button in the upper right corner of the screen. 
  3. On the Sites tab, click on Administration Workspace. 
  4. Click on External Tools in the left side menu of the screen. 
  5. Click on Install LTI 1.x Tool on the right of the screen.
  6. Enter text in the mandatory fields as follows:
    Field NameEntry
    Tool Title (Above the tool)Media gallery
    Button Text (Text in tool menu)Media gallery tool
    Launch URLhttps://KAF-base-URL/hosted/index/course-gallery
    Launch KeyEnter your Partner ID
    Launch SecretEnter your admin secret
  7. Under "Privacy Settings", check "Send User Names to External Tool" and "Send Email Addresses to External Tool".
  8. Under "Services", check "Provide Roster to External Tool" and "Allow External Tool to store setting data".
  9. Under "Indicate the following types of Content Item/Deep Link Selection launches...", check "Allow the tool to be launched as a link (this is typically true for most tools)".
  10. Under "If you select LTI 1.3 Support, your configuration information should be immediately...", check "Tool supports LTI 1.3".  
  11. Click Save. A message displays confirming that the external tool has been added to the system. The Media gallery tool is listed in the list of Installed Tools and a new navigation menu item is available in the course menu.

[/collapsed]

[collapsed title="Adding Tools to Course/Site"]

Adding Tools to Course/Site

To add tools to a course/site

  1. Navigate to desired course/site. (In this example we use a site.)
  2. Click Site Info in the left side menu of the screen.
  3. On the Manage Tools tab, scroll down to the bottom of the list and click the arrow to expand External Tools drop-down.
  4. Check Media gallery and My media. 
  5. Click Continue. A message displays asking you to to confirm your selection.
  6. Click Finish. The two tools (My media and Media gallery) are now added to the site. 

[/collapsed]

[collapsed title="Deploying the Browse Search and Embed (BSE) Tool"]

Deploying the Browse Search and Embed (BSE) Tool

To deploy the Browse Search and Embed (BSE) tool

  1. Login to the Sakai environment as an admin user. 
  2. Click on the Sites button in the upper right corner of the screen. 
  3. On the Sites tab, click on Administration Workspace. 
  4. Click on External Tools in the left side menu of the screen. 
  5. Click on Install LTI 1.x Tool on the right of the screen.
  6. Enter text in the mandatory fields as follows:
    Field NameEntry
    Tool Title (Above the tool)BSE
    Button Text (Text in tool menu)BSE tool
    Launch URLhttps://KAF-base-URL/hosted/index/browseandembed
    Launch KeyEnter your Partner ID
    Launch SecretEnter your admin secret
  7. Under "Privacy Settings", check "Send User Names to External Tool" and "Send Email Addresses to External Tool".
  8. Under "Services", check "Provide Roster to External Tool" and "Allow External Tool to store setting data".
  9. Under "Indicate the following types of Content Item/Deep Link Selection launches...", check "Allow the tool to be used from the rich content editor to select content (the tool must support the IMS Content-Item or Deep-Link message)".
  10. Under "If you select LTI 1.3 Support, your configuration information should be immediately...", check "Tool supports LTI 1.3".  
  11. Click Save. A message displays confirming that the external tool has been added to the system. The BSE tool is listed in the list of Installed Tools and a new navigation menu item is available in the course menu.

[/collapsed]

[collapsed title="Using Browse Search and Embed (BSE)"]

Using Browse Search and Embed (BSE)

To use Browse Search and Embed (BSE)

  1. Navigate to desired course/site. (In this example we use a site.)
  2. Navigate to any place that has a ckeditor in it (Announcements, Assignments, etc.). (In this example we click Announcements in the left side menu of the screen.)
  3. On the Add tab, in the ckeditor box, click on Insert Contentitem.
  4. In the "Select Content Item" window, click on BSE.

    The BSE Page displays. 

[/collapsed]

[collapsed title="Deploying the Interactive Video Quiz (IVQ) Tool"]

Deploying the Interactive Video Quiz (IVQ) Tool 

To deploy the Interactive Video Quiz (IVQ) tool

  1. Login to the Sakai environment as an admin user. 
  2. Click on the Sites button in the upper right corner of the screen. 
  3. On the Sites tab, click on Administration Workspace. 
  4. Click on External Tools in the left side menu of the screen. 
  5. Click on Install LTI 1.x Tool on the right of the screen.
  6. Enter text in the mandatory fields as follows:
    Field NameEntry
    Tool Title (Above the tool)IVQ
    Button Text (Text in tool menu)IVQ tool
    Launch URLhttps://KAF-base-URL/hosted/index/browseandembed?type=quiz
    Launch KeyEnter your Partner ID
    Launch SecretEnter your admin secret
  7. Under "Privacy Settings", check "Send User Names to External Tool" and "Send Email Addresses to External Tool".
  8. Under "Services", check "Allow External Tool to return grades".
  9. Under "Indicate the following types of Content Item/Deep Link Selection launches...", check "Allow external tool to configure itself (the tool must support the IMS Content-Item or Deep-Link message".
  10. Under "If you select LTI 1.3 Support, your configuration information should be immediately...", check "Tool supports LTI 1.3".  
  11. Click Save. A message displays confirming that the external tool has been added to the system. The IVQ tool is listed in the list of Installed Tools and a new navigation menu item is available in the course menu.

[/collapsed]

[collapsed title="Using the Kaltura LTI Tool for Sakai Alongside the Kaltura Video Tool for Sakai"]

Using the Kaltura LTI Tool for Sakai Alongside the Kaltura Video Tool for Sakai

You can use the Kaltura LTI Tool for Sakai alongside the Kaltura Video Tool for Sakai. You must ensure that both instances (the LTI Tool and the Video Tool) are pointing to the same Root category. This allows content to be shared between courses using the LTI Tool and the Video Tool.

When using SIS or other authentication method, we recommend checking that the user IDs and course IDs are the same for both integrations. This can be done as follows:

  1. Turn on both tools on a sample course.
  2. Upload a new video in either one of the media galleries on the sample course.
  3. Go to the KMC, find the two new videos and check that:
    1. Owners on both videos are the same.
    2. Category on both videos are the same.





In This Article