Kaltura Video App for Brightspace by D2L Deployment Guide

Printer-friendly version

This guide is intended for Kaltura and Brightspace by D2L administrators.

The following topics are described:

The information in this guide supersedes the information in the Kaltura Video Extension for Brightspace by D2L Installation Guide.

Kaltura Video Extension for Brightspace by D2L Installation Overview and Requirements

.

23

Prerequisites

The following are prerequisites for the Kaltura Brightspace by D2L Kaltura Video Extension

  • Brightspace by D2L version 10.7 or above
  • A Kaltura account:
    • Partner id (“pid”), e.g., 12345678
    • Admin secret, e.g., f79359d3227f45be73c181489888afc5
    • A Kaltura Application Framework (KAF) instance URL, for example, 12345678.kaf.kaltura.com containing the following modules: Browseandembed, D2l, Hosted, Hostedrelated

Back to Top

Before Starting the Installation Process

You should receive the following:

  • Launch point base URL that will be used further in the process.
  • Administration application login page URL.

Contact your Kaltura representative to create a KAF instance for your Brightspace by D2L environment.

Back to Top

Enable CIM in your Brightspace Environment

The Content-Item Message (CIM) extension is required for some of the Kaltura features. Additional information about CIM and Brightspace may be found here.

The CIM extension must be turned on for the Kaltura BSE (Browse Serach and Embed) Tool to work properly. 

To enable the CIM extension

  1. Locate the Admin Tool and navigate to the Config Variable Browser.
  2. In the Config Variable Browser, search for “contentitem”.
  3. Click on the field “d2l.Tools.Lti.ContentItemMessaging.IsEnabled (Org)” and change the org value to “On”.
  4. Click Save.

Back to Top

Kaltura Video Extension for BrightSpace by D2L Deployment Instructions

This section describes how to  create the Tool Provider so that you can deploy the Kaltura Video Extension for Brightspace by D2L.

Creating a Tool Provider

The Tool Provider allows you to enter the Kaltura key and secret one time for all the Kaltura tools.

To Create the Tool Provider

  1. Login to Brightspace as an admin.
  2. Click on the Admin Tools gear (located on the top right of the screen) and click External Learning Tools.

    The Manage External Learning Tool Links window is displayed.
  3. On the top right click the "settings" tab.
  4. Make sure all the check boxes are checked under the 'Security Settings' section, and click 'save'.
  5. Click on Manage Tool Providers and then click New Tool Provider.

    Fill in the prerequisite Kaltura information you have, as follows:
    • Launch Point: use your KAF URL. (e.g.: https://123456.kaf.kaltura.com)
    • Secret: Use your Kaltura Admin Secret
    • Check the box for “Tool consumer information”
    • Key: Use your Kaltura Partner ID
    • Name: Choose a name for the Tool (e.g.: Kaltura)
    • Check the box for “Visibility”.
    • Check all boxes in the “Security Settings”.
    • Fill in the Org Unit you would like Kaltura to be available at. We recommend choosing the main Org unit and all sub descendants, but you can also select otherwise.

Back to Top

Deploying the Kaltura Tools

The following steps describe how to add the

plugins to your Brightspace environment.

STEP 1 – Add the Remote Plugins

  1. Locate the Admin Tool and navigate to Remote Plugins.
  2. Create (three) New Remote Plugins.

Each plugin is independent of the others, so if you do not want to use any one of them, there is no need to create the plugin.

For each plugin: set the following fields:

My Media

  1. Change the Plugin Type to “Navbar”.
  2. Name: Fill in the tool name – “Kaltura My Media”.
  3. Launch Point URL: Fill in your KAF URL concatenated with the following URL: “/d2l/index/launch/target/my-media”
    For example: https://123456.kaf.kaltura.com/d2l/index/launch/target/my-media
  4. Add the desired org units.
  5. Click Save.

Media Gallery

  1. Change the Plugin Type to “Navbar”.
  2. Name: Fill in the tool name - “Kaltura Media Gallery”.
  3. Launch Point URL: Fill in your KAF URL concatenated with the following URL: “/d2l/index/launch/target/course-gallery”
  4. For example: https://123456.kaf.kaltura.com/d2l/index/launch/target/course-gallery
  5. Add the desired org units.
  6. Click Save.

Browse Search and Embed

You can add the BSE Plugin in both the Insert Stuff and as a Quicklink.  Each addition requires its own plugin.

To add the BSE Plugin in the Insert Stuff

  1. Create a Plugin Type - “Insert stuff (CIM)”.
  2. Name: Fill in the tool name - “Insert Kaltura” or “Add Kaltura Media”.
  3. Launch Point URL: Fill in your KAF URL concatenated with the following URL “/browseandembed/index/browseandembed
    For example: https://123456.kaf.kaltura.com/browseandembed/index/browseandembed
  4. Icon URL: You can add the Kaltura logo: https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png or leave empty if you are using the Brightspace default logo.
  5. Add the desired org units.
  6. Click Save.

To add the BSE plugin as a Quicklink

  1. Create a Plugin Type - “Quicklink (CIM)”
  2. Name: Fill in the tool name - “Insert Kaltura” or “Add Kaltura Media”.
  3. Launch Point URL: Fill in your KAF URL concatenated with the following URL: “/browseandembed/index/browseandembed
    For example: https://123456.kaf.kaltura.com/browseandembed/index/browseandembed
  4. Icon URL: You can add the Kaltura logo: https://cdnsecakmi.kaltura.com/content/static/kalturalogo.png or Leave empty if you are using the Brightspace default logo.
  5. Add the desired org units.
  6. Click Save.

STEP 2 – Set the External Learning Tools

  1. Locate the Admin Tool and navigate to the External Learning Tools.

    The three new tools should be displayed - one for each plugin you created. All tools will have the “eye” icon on them, noting that they are invisible to the users.
  2. Click on each Kaltura tool and modify as follows:
    1. Check the “Visibility” check box.
    2. In the Key/Secret section, check Sign messages with key/secret with and enable Tool consumer key/secret to take the key/secret from the Tool Consumer.
    3. Under Security Settings, check “Use tool provider security settings”.
    4. Add the desired Org Units.
    5. Click Save and close.

Back to Top

Set Up My Media and Media Gallery as a Navigation Bar Link

Perform the following task first:

Add My Media to the Org Unit Navigation Bar

To add My Media to the Navigation Bar

  1. As the administrator of the org go to the org unit home page.
  2. Hover over the navigation bar and click the pencil icon on the left. The Edit Navbar window is displayed.
  3. Click Create Custom Link.
  4. In the Create Custom Link window, enter My Media as the Name.
  5. Click Insert QuickLink.
  6. Select External Learning Tools.
  7. In the Insert a Quicklink window select My Media launch and click Insert.
    The Create Custom Link window is displayed.
  8. Click Save and Close.

Add Media Gallery to the Course Navigation Bar

To add Media Gallery to the Navigation Bar

Adding the Media Gallery Tool can be done either by the admin in the course template, or by the individual course admin.

  1. As the administrator of the org go to the org unit home page.
  2. Hover over the navigation bar and click the pencil icon on the left. 

    The Edit Navbar window is displayed.
  3. Click Create Custom Link.
  4. In the Create Custom Link window, enter My Media as the Name.
  5. Click Insert Quicklink.
  6. Select External Learning Tools.
  7. In the Insert a Quicklink window select Course Media Gallery launch and click Insert.
    The Create Custom Link window is displayed.
  8. Click Save and Close.

Back to Top

Verifying Your Browse Search and Embed Deployment

This section describes how to verify the BSE deployment. According to the plugins you created you might have one or two locations where you can find the Kaltura BSE plugin.

BSE in the Brightspace Insert Stuff

To verify that the BSE is in the Brightspace Insert Stuff

  1. Navigate to a course, and create a new content item such as an Announcement or Assignment.
  2. Enter a Headline.
  3. Choose the new Insert Stuff icon.

    The Kaltura button name depends on what you chose to write on the plugin name. In this example, it is Add Kaltura Media.
  4. Select the new plugin name you created.
  5. Choose the video. See the Desire2Learn Digital Media Services - Kaltura User Manual for more information.
  6. Click Insert.
  7. Save the announcement you created.
    After the announcement is in place, navigate to it, and play the video.

BSE in the Brightspace Quicklink

 To verify that the BSE is in the Brightspace Quicklink

  1. Navigate to a course, and go to the course content.
  2. Click on the “Add Existing Activities”.
  3. Select the new plugin name you created.
    The Kaltura button name depends on what you chose to write on the plugin name. In this example it is Add Kaltura Media.
  4. Choose the video, and click select.
  5. Navigate to the bottom of the content and click on the new item you created.

    A Kaltura video should appear.

Working with Legacy D2L Kaltura Deployments and Widgets

This section is targeted to Kaltura and Brightspace by D2L existing clients who have been using the legacy Kaltura integration in the Insert Stuff.

Upgrading Legacy Kaltura Embeds to the New BSE Embeds

The legacy Kaltura button located in the Insert Stuff is part of the former integration that is maintained by D2L. Upgrading the content from the legacy Insert Stuff embeds to the new BSE is also maintained by D2L.

Using the Legacy and New Kaltura Embeds

Both new and legacy Kaltura versions of the Insert Stuff can work together side by side. You may want to gradually adapt to the new BSE. You can do so and when ready, you can disable the ability to add content with the legacy version.

Follow these steps is you choose to add new content only using the new Insert Stuff,

To continue working with legacy embeds

  1. Login to Brightspace, click the Admin Tools gear, and under Security, select the Roles and Permissions.

    The Edit Role Permissions window is displayed.
  2. Filter by Role and select the Role you want to modify.
  3. In the Filter by Tool, select Kaltura.
  4. Remove all the checkboxes, and Save.
  5. Repeat step #2 for all other roles.
    By removing all the checkboxes, users with the role you chose, will no longer be able to see the legacy Kaltura button in the Insert Stuff panel.

Troubleshooting When Upgrading to the New BSE Feature

Clients that are upgrading the existing Insert Stuff Kaltura button with the new BSE feature may encounter the following known issue described below. 

  • Getting “Access denied” after installing the BSE tool.

Most likely reason: Since you installed Kaltura in the past, before Tool Consumers/Providers were introduced in D2L, you probably have many ‘Tool Providers’ with the same name (such as 123456.kaf.kaltura.com) in the ‘Tool Providers’ section.

Having multiple Tool Providers’ with the same name may cause issues when adding the BSE, as these legacy Tool Providers do not contain the secret and key. Since we recommend setting the tools to “Sign messages with key/secret with Tool Consumer key/secret”, that may be the cause of the  ‘Access denied’ error to display, as the new tool uses a random ‘Tool Provider’ that does not contain the key/secret.


Solution: There are 2 options to resolve this issue:

    1. Remove all the legacy Tool Providers. Since the legacy tools were not set to get the key/secret from the Tool Consumer, deleting them should not interfere with My-Media and Media Gallery to continue working.
    2. Instead of setting the new external learning tool to ‘Sign messages with key/secret with Tool Consumer key/secret’, create a new plugin and set the plugin with the key/secret in advance. You will also need to fill in the secret/key in the new external tool that will be created.

Be certain to set the “Security Settings” in the external tool to “Use link security settings” and check ALL the boxes.

Other possible reasons: The Browseandembed module is not available or enabled in your KAF instance. Verify that it is enabled by logging in to the KAF admin page.

Solution: Contact Kaltura support and ask them to enable the 'Browseandembed' module in your KAF instance. 

Using the Brightspace Widgets

Using the Brightspace Widgets in a course is still possible, however, since the widgets are displayed smaller than they should be, we do not recommend using them. While the Kaltura media can function on a smaller screen, we found that adding the Kaltura My Media and Media Gallery in the Navigation Bar provides a better UI and User experience.

If you want to use the widgets, add the Kaltura plugin and in the plugin type choose “Widget”. Widgets are only relevant to My Media and Media Gallery.

 Back to Top

 

Document type: 
Product version: 
(2640 reads)