Kaltura Video Plugin V4 for Moodle Setup Guide

This guide describes how to setup the Kaltura Video Package for Moodle. Instructions are provided for setting up the package behavior and how to control user roles and permissions using the Kaltura Application Framework (KAF) Admin Console.

[/collapsed]

[collapsed title="Prerequisites"]

Prerequisites

The following items are required to setup the Kaltura Video Package for Moodle:

•    Access to a Moodle environment with site administrator role.

•    A Kaltura account - Please contact your Kaltura representative for your Kaltura account details.

•    Installation of Kaltura Video Package for Moodle on your Moodle environment. For installation instructions, see Kaltura Video Package V4 for Moodle Installation and Upgrade Guide.

•    KAF Admin Console – please ask your Kaltura representative for credentials to access your KAF Admin Console instance.

[/collapsed]

[collapsed title="Before You Begin"]

Before You Begin

You will need to create a Moodle root category in the KMC, if not already created for you by your Kaltura representative.

To create the Moodle root category in the KMC

  1. Log into the KMC.
  2. Select the CONTENT tab and then select the CATEGORIES tab. The Categories Window displays.
  3. Click the Add Category button.The New Category Window displays.
  4. Type a Name for the new category and select the position of the root category.
  5. Click the Apply button. The Metadata Window displays.
  6. Type a Description, Tags, and a Reference ID for the new category. 
  7. In the Category/AdditionalInfo section below Detail, click the Add button.
  8. Type Key and Value entries.
  9. Click the Save button. Your new category now shows in the list of categories on the Categories Window.

Mandatory Configuration

After installing the Kaltura Video Package for Moodle, you will need to specify the root category you created under the Categories module.

Module

Fields

Description

Categories

RootCategory

Select the category you created in the KMC.

The root category should not be changed after the plugin is configured. It is okay to change the name of the root category in the KMC. It will automatically update in the KAF Admin Console.

Be certain that the sharedRepositoryCategoryId field is updated in the Hosted module. If it is not updated, the following message is displayed. 

Press "Click here to update" to update the Shared Repository. This step is only required one time after installation or migration of the Kaltura Video Package for Moodle.

[/collapsed]

[collapsed title="Understanding the Setup Process"]

Understanding the Setup Process

The Kaltura Video Package for Moodle offers an out-of-the-box solution that enables users to view, record, upload, publish, search, and share video directly from their Moodle environment. This translates into time and money saved for your organization, improved student engagement, creativity and learning results, as well as ease of use for students, faculty and teaching assistants.

The Kaltura Application Framework (KAF) Admin Console

The Kaltura Video Package for Moodle is implemented on top of the Kaltura Application Framework (KAF), a feature rich framework that allows flexible and streamlined integration of Kaltura’s video solutions and products into 3rd party applications such as Moodle. KAF is hosted and served directly from the Kaltura cloud servers and once integrated into your Moodle environment, presents different video components and workflows to users. 

At the backend, the Kaltura Application Framework provides a flexible and extensible administration panel, called “KAF Admin Console”. The KAF Admin Console offers full control over the user experience and when interacting with videos inside Moodle. Nearly all configuration aspects of the Kaltura Video Package for Moodle are configured through the KAF Admin Console.

You can find a link to your KAF Admin Console from within your Moodle site, by going to Site Administration > Plugins > Local plugins > Kaltura package Libraries and clicking the URL at top of the page.

KAF Modules

Your KAF instance is composed of multiple KAF modules, such as “Application”, “Player”, and “Auth”. Each module controls a different aspect of your Kaltura Video Package for Moodle instance. A KAF module is composed of a set of configuration fields. All KAF modules are listed on the left menu in your KAF Admin Console instance.

Your KAF Admin Console may display modules and configuration fields that are not listed in this guide, some of which may be disabled. It is important that you do not modify the configuration of the disabled modules (and not enable them) without consulting with your Kaltura representative.

KAF Administration: Actions and Configurable Fields

Your KAF account comes pre-configured with the following settings. Items marked with * should not be changed.

General Settings

Module

Fields

Description

Application

InstanceId, privacyContext, userRoleProfile

Internal constant identifiers of your KAF instance. Please note that privacyContext should be empty.

Auth

sslSettings

All site (set to None if SSL is not used)

Debug

serviceUrl

https://www.kaltura.com (set to http://www.kaltura.com if SSL is not used)

VerifySLL

Yes (set to No if SSL is not used)

Security

allowLoadInIframe

Yes*

SharedRepositoriesenabledYes (set to No if you want to disable the Shared Repository which is used for cross-site shared functionality)

Addcontent

enabled

Yes*

Userreports

enabled

Yes*

Publish

enabled

Yes*

Browseandembed

enabled

Yes*

Moodle

enabled

Yes*

Hosted

enabled

Yes*

enableLike

Yes/No

enableViews

Yes/No

allowEditPublished

Set to No if you want to prevent users from editing entries after they have been published to a course Media Gallery or embedded using the Browse, Search and Embed module.

allowDeletePublished

Set to No if you want to prevent users from deleting entries after they have been published to a course Media Gallery or embedded using the Browse, Search and Embed module.

enableEntryDelete

Set to No to completely prevent users from deleting entries

manPublish

Yes* (Unless publish plugin was integrated).

authMethod

Lti

Configuring Modules

Some fields are displayed only when you select a specific value for a different field.The group's configurable fields follow the group name.

To modify KAF configuration modules

  • In the KAF Admin window select the Manage Configuration tab.

NOTE: Related KAF modules: Application, Auth, Client, Security, Categories, Addcontent, Publish, Browseandembed, Moodle, Hosted

The following KAF modules are required for configuring the Kaltura Video Package for Moodle and are described in this guide:

Configuration Management: Global Modules

Configuration Management: Configuration Modules

Configuration Management: Channel Modules

Configuration Management: Entry Type Modules

Modules/Custom/Core/KAF

[/collapsed]

[collapsed title="Roles and Permissions"]

Roles and Permissions

See Common Use Cases of Role Configuration for recommendations for common role configurations in the Kaltura Video Package for Moodle.

Introduction to Role Mapping

The Kaltura Video Package for Moodle implements role mapping from Moodle roles to Kaltura roles via LIS roles. Each role that is assigned to a user in Moodle is mapped to one of the roles defined in the LIS standard. When a user is assigned with a role in a Moodle site – Student or Teacher for example –Moodle translates this role to an LIS role which is then sent to KAF. On KAF’s side, a dedicated module provides flexible mapping between LIS roles and Kaltura roles, allowing a granular control over the behavior of the different Kaltura Video Package components in Moodle.

This process is described in the following workflow.

  1. Users are assigned a LMS course-level role after being assigned to a course.
  2. The LMS sends the corresponding LIS role to Kaltura.
  3. KAF Grants Permissions according to mapping.

Assign a Moodle Course Level Role

Users are assigned a Moodle role when added to courses via the Enroll Users dialog.

Moodle Sends the Corresponding LIS Role to Kaltura

When a user accesses a Course level Kaltura module, such as Media Gallery or the Browse, Search, and Embed, Moodle sends the corresponding LIS role to Kaltura, according to the following mapping:

Moodle Course Level Role

LIS Role

StudentLearner 
TeacherInstructor

Outside the context of a course, Moodle sends Learner for all logged in users. Please refer to Common Use Cases of Role Configuration for instructions on how to send the instructor role outside the context of a course to support different access control configurations. 

KAF Grants Permission According to the Mapping

On the KAF Admin Console side, each LIS role can be mapped back to Kaltura roles. KAF grants different permissions according to the mapping provided in the Hosted module in the KAF Admin Console:


As displayed, each LIS role is mapped in Kaltura to two roles – an Applicative Role (kmsRole) and a Contextual Role (kmsContextualRole). These roles correspond to different cases/scenarios in the Kaltura Application Framework Generic LTI Integration. Setting these roles changes the permissions a user has in the following scenarios:

  • Applicative role (KMSRole) - Defines the user roles and permissions in Kaltura widgets that are out of course context (for example: My Media)
    • anonymousRole – Not relevant to the Kaltura Application Framework Generic LTI Integration and should not be used.
    • viewerRole – The user will not have access to My Media, and will not be able to upload new content to either My Media, Media Gallery or using the Embed Kaltura Media text-editor button.
    • privateOnlyRole – The user will have access to My Media and will have the ability to create new content.
    • adminRole, unmoderatedAdminRole – Not relevant to the Kaltura Application Framework Generic LTI Integration and should not be used.
  • Contextual role (KMScontextualrole) - Defines the user roles and permission in Kaltura widgets when in a course (site) context (for example: Media Gallery)
    • Member: The user will be able to view content in Media Galleries of courses to which the user is enrolled, but will not be able to contribute (publish) to the galleries.
    • Contributor: The user has Member permissions with the ability to publish content to the Media Gallery.
    • Moderator: The user has Contributor permissions with the ability to moderate content added to the Media Gallery.
    • Manager: The user has Moderator permissions with the ability edit the Media Gallery settings, and view the course gallery analytics.

 From the Kaltura module’s perspective, the permissions are as follows:

  • My Media
    • Applicative role: If viewerRole, the user will not have access to My Media and will not be able to upload new content. If privateOnlyRole the user will be able to have its own My Media repository to where he can upload his own private content.
    • Contextual role: does not impact My Media.
  • Media Gallery
    • Applicative role: If the user has a contextual role that allows publishing/adding content to the Media Gallery (see the following table), and the user has an Applicative role of privateOnlyRole, the user will be able to upload new content or contribute content from its own private My Media repository.
    • Contextual role: Determines the role of the user inside the Media Gallery (note – users can access a course Media Gallery after they have access to the course page in the LMS, regardless of their Kaltura role.

Role

Permissions

Member

If the user has Member contextual role, the user will be treated as a “viewer only” in the Media Gallery, and will only be able to view content, and will not be able to contribute content to the Gallery (regardless of the user’s Applicative role).

Contributor

Users with Contributor role can view Media Gallery entries and upload and contribute entries from My Media (if applicative role is privateOnlyRole). Students are usually assigned Member or Contributor contextual roles.

Moderator

Moderator role allows the users to moderate content published to a Media Gallery (and to contribute new content). Teaching Assistants usually have Moderator contextual roles.

Manager

A Manager role provides full access to the Media Gallery, including the ability to moderate content, edit the Media Gallery’s settings and metadata, and access the Media Gallery Analytics. Instructors usually have Manager contextual roles

  • Browse, Search and Embed (rich-text editor button)
    • Applicative role: If viewerRole, the user will not have access to My Media and will not be able to create new content. If privateOnlyRole the user will be able to have their own My Media repository to where they can upload their private content.
    • Contextual role: does not impact Embed Kaltura Video.

Summary of Default Moodle > LIS > Kaltura Roles Mapping

Moodle RoleLIS RolesDefault Kaltura Applicative role (kmsRole)Default Kaltura contextual role (kmsContextualRole)Comment
StudentLearnerprivateOnlyRoleCONTRIBUTORApplicable only inside course context
TeacherInstructorprivateOnlyRoleMANAGERApplicable only inside course context
AdministratorAdministratorprivateOnlyRoleMANAGERApplicable across the entire site
Logged in userLearnerprivateOnlyRoleCONTRIBUTORApplicable outside the context of courses

Common Use Cases of Role Configuration

This section provides recommendations for common role configuration in the Kaltura Video Package for Moodle. 

The following use cases are described:

  • Allowing Students to Upload Content
  • Allowing Faculty Only to Upload and Create New Content
  • Creating a Teachers Only Shared Repository

Allowing Students to Upload Content

Description: Allow all Moodle users to author new content (upload, webcam recording, screencast recording, etc.) and publish to courses, Media Galleries, regardless of their contextual role.

Moodle Side Configuration

No special configuration is required on the Moodle side for this case. Assign all students to the Moodle Student role and teachers to the Moodle Teacher Role.

All course-level roles that have any course-level management privilege will be mapped to the LTI Learner role.

KAF Side Configuration

In your KAF instance, configure the following mapping under the Hosted module:

ItiRole

kmsRole

kmsContextualRole

Learner

privateOnlyRole

CONTRIBUTOR

Instructor

privateOnlyRole

MANAGER

Allowing Faculty Only to Upload and Create New Content

Allow only faculty members to create and upload new media. Students should not have access to My Media and should not be able to contribute to any course Media Gallery.

If students are prevented from uploading content, they will not be allowed to submit video assignments. 

Moodle Side Configuration

To accomplish this configuration, the My Media link should be hidden to all logged in users but Teachers by creating a System-level role designed only for showing the My Media link to Teachers.

It is important to hide the My Media link. If students are able to access the My Media link, an “Access Denied” message will be displayed as they are prevented from accessing My Media by the KAF-side configuration (see below).

To hide My Media for all logged in users:

  1. Log into Moodle as an Administrator.
  2. Go to Administration > Site Administration > Users > Permissions > Define Roles.
  3. Click on Edit Authenticated User Role (the gear icon in the Authenticated user row).
  4. The role edit page displays. Uncheck "View My Media page"

    This hides the My Media link to all logged in users.
    An "Access Denied" message is displayed when opening My Media if you fail to hide the My Media page to Students. 

To expose My Media to Teachers only

  1. Log into Moodle as an Administrator.
  2. Go to Administration > Site Administration > Users > Permissions > Define Roles.
  3. Click Add a new role.
  4. Choose "Teacher" in Use role or achetype and click Continue.
  5. Click Edit Teacher User Role (the gear icon in the Authenticated user row).
  6. In the "Short name" box, provide the new role with a descriptive name; e.g., 'Teacher - My Media Access".
  7. In the "Context types where this role may be assigned" check System.
  8. Click "Create this role".
  9. Click Edit to edit the new role.
  10. Check "View My Media page".
  11. Assign this new system role to all Teachers that require access to My Media. 

KAF Side Configuration

In your KAF instance, configure the following mapping under the Hosted module:

ItiRole

kmsRole

kmsContextualRole

Learner

viewRole

MEMBER

Instructor

privateOnlyRole

MANAGER

Creating a Teachers Only Shared Repository

Creating a cross-site, shared repository accessible to Teachers only. Only Teachers will have the capability to share common files among multiple courses.

Moodle-side Configuration

The Moodle configuration required is described in Allowing Faculty Only to Upload Content. 

KAF side Configuration

Turn off the shared repository for the Learner LTI role.

In This Article