Kaltura Video App for Canvas Deployment Guide

This guide describes how to add the Kaltura Video App for Canvas to your Instructure Canvas 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 Canvas and Kaltura administrators.

[/collapsed]

[collapsed title="Kaltura Video App for Canvas Installation Overview and Requirements"]

Kaltura Video App for Canvas Installation Overview and Requirements

The Kaltura Video App for Canvas is implemented as a Canvas External Tool and is added manually by a Canvas administrator. Please refer to the Canvas Instructor Guide on how to manually configure an external tool on your Canvas 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
    • App configuration files (xmls): The deployment process requires the following two configuration files for your Kaltura Video App for Canvas:
      • MyMedia.xml
      • MediaGalleryAndBSE.xml

This configuration files are used to connect your Canvas environment to your Kaltura account and Kaltura Application Framework (KAF) instance. To create these xml files go to the following URL with your KAF instance: http://123456.kaf.kaltura.com/canvas/config/create-xml-for-instance.

[/collapsed]

[collapsed title="Kaltura Video App for Canvas Deployment Instructions"]

Kaltura Video App for Canvas Deployment Instructions

This section describes how to deploy the Kaltura Video App for Canvas.

Deploying My Media

To deploy My Media

  1. In your Canvas environment, go to Settings and click Apps:
  2. Click View App Configurations to open the list of external apps:
  3. The External Apps list is displayed.
  4. Click Add New App to open the Edit External Tool Dialog.
  5. In the Edit External Tool Dialog, under Configuration Type Select “Paste XML”.
  6. Enter the following information:

    #

    Field

    Value

    1

    Name

    Name (only affects the list of installed tools)

    2

    Consumer Key

    You Kaltura account Partner Id

    3

    Shared Secret

    Your account administrator secret

    4

    Paste XML Here

    Paste the content of MyMedia.xml provided to you by your Kaltura representative.

  7. Click Submit. The My Media tool will be listed in the list of external tools and a new navigation menu item will be added to the course menu.

[/collapsed]

[collapsed title="Deploying the Media Gallery and the Embed Kaltura Video Text-Editor Button"]

Deploying the Media Gallery and the Embed Kaltura Video Text-Editor Button

To deploy the Media Gallery – There are two options:

Option 1:

  1. In your Canvas environment, go to Settings and click Apps:
  2. Click View App Configurations to open the list of external apps:
  3. The External Apps list is displayed.
  4. Click Add New App to open the Edit External Tool Dialog.
  5. In the Edit External Tool Dialog, under Configuration Type Select “Paste XML”
  6. Enter the following information:

    #

    Field

    Value

    Example

    1

    Name

    Name

    “Media Gallery + BSE”

    2

    Consumer Key

    Your Kaltura account Partner ID

    123456789

    3

    Shared Secret

    Your account administrator secret

    6TS618TVBE48JAPE4H9CJQKEJSMEYXUD'

    4

    Paste XML Here

    Paste the content of MediaGalleryAndBSE.xml provided to you by your Kaltura representative.

    See MediaGalleryAndBSE.xml.

  7. Click Submit. The Media Gallery tool will be listed in the list of external tools and a new navigation menu item will be added to the course menu.

Option 2:

  1. In your Canvas environment, go to Settings and click Apps:
  2. Search for the Kaltura app.

Select “Add App” and enter the following information:

#

Field

Value

Example

1

Name

Name

Kaltura Video App

2

Consumer Key

Your Kaltura account Partner ID

123456789

3

Shared Secret

Your account administrator secret

6TS618TVBE48JAPE4H9CJQKEJSMEYXUD'

4

KAF Host Name

Your Kaltura Application Framework URL

123456.kaf.kaltura.com

5

Course Menu Label

The name that will appear in the course navigation

Media Gallery

6

Add Kaltura to Rich-Text Editor

Check if you want to add Kaltura to the rich-text editor

Checked

Kaltura is using API keys to retrieve information about course permissions to provide the "Publish to a Media Gallery from My Media" feature. If you would like to use a scoped key instead of a regular API key, please use the following steps.

Create a Scoped Key

  1. Log into Canvas to create the new key.
  2. Provide the key with the following permissions (These are the scopes that Kaltura tools use.):
    1. url:GET|/api/v1/courses
    2. url:GET|/api/v1/courses/:id
  3. Grab the app ID and key.
  4. Enter the information in the KAF Admin 'Canvas' module.
    1. Set "useScopedKey" to Yes.
    2. Fill in the customAppId.
    3. Fill in the customAppKey.

[/collapsed]

[collapsed title="Kaltura Video App for Canvas Sample Configuration Files (XMLs)"]

Kaltura Video App for Canvas Sample Configuration Files (XMLs)

This section provides sample XML configuration files for My Media, Media Gallery, and BSE.

The actual xml files you receive from your Kaltura representative may slightly differ from the files presented in this section.

MyMedia.xml

<xml version="1.0" encoding="UTF-8”?> <cartridge_basiclti_link xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0" xmlns:blti = "http://www.imsglobal.org/xsd/imsbasiclti_v1p0" xmlns:lticm ="http://www.imsglobal.org/xsd/imslticm_v1p0" xmlns:lticp ="http://www.imsglobal.org/xsd/imslticp_v1p0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd"> <blti:title>My Media Sample</blti:title> <blti:description>My Media Sample</blti:description> <blti:icon>http://hostname/canvaslti/kaltura%20sun.png</blti:icon> <blti:launch_url>https://canvas.kaltura.com/hosted/index/my-media</blti:launch_url> <blti:extensions platform="canvas.instructure.com"> <lticm:property name="tool_id">0000000</lticm:property> <lticm:property name="privacy_level">public</lticm:property> <lticm:property name="domain">kaltura.com</lticm:property> <lticm:options name="course_navigation"> <lticm:property name="url">https://123456789.kaf.kaltura.com/canvas/index/launch/target/my-media</lticm:property> <lticm:property name="icon_url"> http://hostname/canvaslti/kaltura%20sun.png</lticm:property> <lticm:property name="text">My Media - Sample</lticm:property> <lticm:property name="enabled">true</lticm:property> </lticm:options> </blti:extensions> <cartridge_bundle identifierref="BLTI001_Bundle"/> <cartridge_icon identifierref="BLTI001_Icon"/> </cartridge_basiclti_link> 

MediaGalleryAndBSE.xml

<xml version="1.0" encoding="UTF-8”?> <cartridge_basiclti_link xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0" xmlns:blti = "http://www.imsglobal.org/xsd/imsbasiclti_v1p0" xmlns:lticm ="http://www.imsglobal.org/xsd/imslticm_v1p0" xmlns:lticp ="http://www.imsglobal.org/xsd/imslticp_v1p0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd"> <blti:title>Course Gallery and BSE Sample XML</blti:title> <blti:description>Course Gallery Sample XML</blti:description> <blti:icon> http://hostname/canvaslti/kaltura%20sun.png</blti:icon> <blti:launch_url> https://123456789.kaf.kaltura.com/canvas/index/launch/target/course-gallery </blti:launch_url> <blti:extensions platform="canvas.instructure.com"> <lticm:property name="tool_id">00000000</lticm:property> <lticm:property name="privacy_level">public</lticm:property> <lticm:property name="domain">kaltura.com</lticm:property> <lticm:options name="editor_button"> <lticm:property name="url">https://123456789.kaf.kaltura.com/browseandembed/index/browseandembed</lticm:property> <lticm:property name="icon_url"> http://hostname/canvaslti/kaltura%20sun.png </lticm:property> <lticm:property name="text">Embed Kaltura Media</lticm:property> <lticm:property name="selection_width">1100</lticm:property> <lticm:property name="selection_height">600</lticm:property> <lticm:property name="enabled">true</lticm:property> </lticm:options> <lticm:options name="course_navigation"> <lticm:property name="url">https://123456789.kaf.kaltura.com/canvas/index/launch/target/course-gallery</lticm:property> <lticm:property name="icon_url"> http://hostname/canvaslti/kaltura%20sun.png</lticm:property> <lticm:property name="text">Course Gallery - Sample</lticm:property> <lticm:property name="enabled">true</lticm:property> </lticm:options> </blti:extensions> <cartridge_bundle identifierref="BLTI001_Bundle"/> <cartridge_icon identifierref="BLTI001_Icon"/> </cartridge_basiclti_link> 
In This Article