Kaltura Application Framework (KAF) for Learning Tools Interoperability (LTI) Setup Guide

Printer-friendly version

This guide describes how to setup the Kaltura Video integration within your LMS with the Kaltura Application Framework (KAF) settings. Information on how to control user roles and permissions using the Kaltura Application Framework (KAF) Admin Console is also provided.

The following topics are descriibed:

Prerequisites

The following items are required to setup the Kaltura Application Framework (KAF) as a tool provider within your LMS.

  • Access to a LTI compliant LMS environment with site administrator role.
  • A Kaltura account - Please contact your Kaltura representative for your Kaltura account details.
    • * KAF LTI Integration on your LMS environment. For installation/integration instructions, see …
    • KAF Admin Console – please ask your Kaltura representative for credentials to access your KAF Admin Console instance.

Back to Top

Understanding the Setup Process

The KAF LTI Integration offers an out-of-the-box solution that enables users to view, record, upload, publish, search, and share video directly from their LMS 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 Generic KAF LTI Integration 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. KAF is hosted and served directly from the Kaltura cloud servers and once integrated into your LMS 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 KAF.

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 LMS integration. 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 your Kaltura representative.

The following KAF modules are required for configuring the Kaltura Application Framework (KAF) LTI integration and are described in this guide:

Global

Modules

Modules/Channels

Modules/Entry Types

Modules/Custom/Core/KAF

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*

Addcontent

enabled

Yes*

Userreports

enabled

Yes*

Publish

enabled

Yes*

Browseandembed

enabled

Yes*

Ltigeneric

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

Configuration Management: Global

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

To modify KAF configuration modules

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

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

Application

Field

Description

instanceId

Unique string to identify that installation of the LMS. This value can be set during installation only.

privacyContext

String used to be set as privacy context on root category. This value can be set during installation only.

userRoleProfile

Metadata Profile ID for user's role per KAF installation instance

title

What is your LMS website title? The website title is displayed in the browser's title bar and usually is displayed in search engine results. Page titles consist of the name of the currently loaded media and the website title. For example, if a page has a video called 'My Video' and 'LMS' is the website title, the page title is: 'My Video – LMS

footer

What is your LMS footer text?

language

Which language should KAF use? Note: Language files are in /locale/kms/{LANG}/default.po. See here for the list of supported KAF localization languages.

Fr = French

Jp= Japanese

SR= Serbian

Pt-Br Portuguese Brazlian

En = English

Es- Spanish

D2L = custom language for LMS

En_Custom = custom language

Ar = Arabic

De = German

Da - Danish

Ca-es -Catalan

enableLike

Enable the 'Like' feature for entries. This should be configured in the Hosted module.

enableWebcam

Enable or Disable the Webcam upload.

enableEntryTitles

Include the media title in the URL of the media page when browsing the site and sharing a link to the media.

allowEditPublished

Enable editing of published entries. This should be configured in the Hosted module.

allowDeletePublished

Enable deletion of published entries. This should be configured in the Hosted module.

enableEntryDelete

Enable deleting the media from the LMS. This should be configured in the Hosted module.

enableViews

Enable showing number of views per entry. This should be configured in the Hosted module.

showPageTitles

Show page titles. This should be configured in the Hosted module.

enableUnlisted

Enable setting entries as unlisted. An unlisted entry can be viewed by anyone with the link to the entry page. Unlisted media can be accessed by anyone with a direct link to the media page and will not be displayed in search results. This is not relevant for KAF applications.

timezone

Which timezone should The LMS use to present times and dates.

assetConsolidationEnabled

Enable assets (js/css) consolidation and minification.

Channels

Field

Description

entriesPageSize

How many entries can be displayed on each channel/course page? (The default is 15)

pagerType

Which kind of paging mechanism should be used in the channel/course page?

Client

Field

Description

serviceUrl

The URL of the service for API calls. Modify the URL if you use the Kaltura On-Prem Edition.

CDNUrl

The CDN regular URL Used for Player and html5lib. Leave empty for default.

You can change the Kaltura Server CDN URL used by the Kaltura HTML5 player and player embeds. The default value is http://cdnapi.kaltura.com. To update your CDN URL, add the URL in this field.

Note: When configuring a KMS site to HTTPS, also change the CDN URL to https://cdnapisec.kaltura.com.

SecuredCDNUrl

The CDN secured URL. Used for Player and html5lib. Leave empty for default.

partnerId

Copy your Kaltura account's Partner ID from the Kaltura Management Console (KMC): KMC->Settings->Integration Settings.

secret

Copy your Kaltura account's user secret from KMC->Settings->Integration Settings (http://www.kaltura.com/index.php/kmc/kmc4#account|integration). Kaltura uses your user secret to create secure sessions to access the Kaltura API.

adminSecret

Copy your Kaltura account's administrator secret from KMC->Settings->Integration Settings (http://www.kaltura.com/index.php/kmc/kmc4#account|integration). KAF uses your administrator secret when you need an 'admin' session, which allows more actions than a user secret session.

verifySSL

Set to No, if you want to use SSL with a self-signed certificate.

Debug

Field

Description

logLevel

Debug level of the KAF Log File (logs/kms.log)

kalturaDebug

Enable debug log of requests to the Kaltura API (logs/apidebug.log)

kalturaStats

Enable stats log of requests to the Kaltura API (logs/api.log)

emailErrors

Enable sending emails in case of errors

Gallery

Field

Description

pageSize

How many entries can be displayed on each gallery page? (The default is 10.)

pageSizeWide

How many entries can be displayed on each gallery page in the Wide gallery view (for example, search results, playlists)? (The default is 24.)

pageCount

How many page links can be displayed in the gallery pager? (Dots represent page links that are not displayed.)

pagerType

Which kind of paging mechanism should be used in the gallery page?

sortMediaBy

By default, how should media in the gallery be sorted?

globalSearchSortMediaBy

By default, how should media in the global search be sorted?

thumbnailRotator

Enable thumbnail image rotation on mouse over in galleries

categoryDefaultView

Default view for categories. You can define optional view modes for media items inside Galleries. Choose from Grid, Collapsed view or Detailed view.

categoryExplicitDateFormat

Explicit date format.

Metadata

Field

Description

descriptionRequired

Require users to fill in the 'Description' field when uploading or editing media?

tagsRequired

Require users to fill in the 'Tags' field when uploading or editing media?

readMoreEnabled

Enable/disable read more for entry description - shortening to 500 characters. Notice: channel and category description is always shortend.

metaDataInReadMore

If enabled metadata is hidden until clicking on 'read more...' works for all descriptions - entry/channel/category

basicNameFieldHelperText

Tooltip comment for the Name field when uploading or editing an entry.

basicDescriptionFieldHelperText

Tooltip comment for the Description field when uploading or editing an entry.

basicTagsFieldHelperText

Tooltip comment for the Tags field when uploading or editing an entry.

showDescriptionInTooltipMeta

Choose whether to display field's description as a tooltip

Moderation

Field

Description

reasonSex

Please provide the reasons The LMS users can choose for flagging media. (If none are provided, the default Kaltura reasons will be used)

reasonViolence

Please provide the reasons The LMS users can choose for flagging media. (If none are provided, the default Kaltura reasons will be used)

reasonHarmful

Please provide the reasons The LMS users can choose for flagging media. (If none are provided, the default Kaltura reasons will be used)

reasonSpam

Please provide the reasons The LMS a reasons will be used)

Player

Kaltura Application Framework LTI instances are automatically created using the Kaltura v2 Player.

Module

Fields

Description

Player

playerId

What is the player ID (uiConf ID) of the player that plays the embedded video?

playerBarHeightPixels

The height (in pixels) of the player ui which is not part of the actual video (for example - the bottom bar)

playerVideoRatioPercent

The ratio (in percent) of the video inside the player. Standard values: 16:9 = 56.25 , 4:3 = 75 , 16:10 = 62.5

playerEditId

What is the player ID (uiConf ID) of the player that edits entries?

autoPlayOnLoad

When KAF loads, should the video that is loaded in the player begin playing automatically? Notes: (1) Autoplay is triggered when KAF starts and each time a new page loads, such as when switching from My Playlists to a gallery page. (2) The player always begins playing automatically when a user clicks a video in a gallery, regardless of whether autoPlayOnLoad is enabled.

 

playback

Which Playback method should KAF use? Kaltura Auto' is the default playback option for a new KAF instance.

KAF administrators can select additional playback options. From Player > playback, select any of the following options:

  • Auto - Kaltura server chooses between HTTP Progressive Download and Akamai’s HTTP Adaptive Streaming, based on entry duration and available flavors. Auto gives you the best video delivery and playback quality for your entry.
  • HTTP Progressive Download – Allows you to pause the video playback and wait for the content to download. Typically used where viewers have very limited bandwidth and might experience more buffering than adaptive bitrate.
  • HTTP Streaming (HDS) - HTTP streaming based on Adobe technology. Allows adaptive bitrate so the player can adjust the video quality on the fly based on network and CPU conditions.
  • HTTP Streaming (Akamai HD) – HTTP streaming based on Akamai’s technology. Allows adaptive bitrate so the player can adjust the video quality on the fly based on network and CPU conditions, formally called Akamai HD.
  • RTMP Streaming – RTMP streaming based on Adobe technology. Allows adaptive bitrate so the player can adjust the video quality on the fly based on network and CPU conditions.
  • Secure Transport (RTMPE) - RTMP encrypted using Adobe's security mechanism which wraps the RTMP session in a lighter-weight encryption layer.

 

playerModerationId

What is the player ID (uiConf ID) of the player shown in moderation pages?

Widgets

Field

Description

ksuId

What is the uiConf ID of the Kaltura Simple Uploader (KSU)? KAF uses KSU to upload videos, images, and audio files.

krecordId

What is the  uiConf ID of the kRecord widget? KAF uses kRecord to record and upload video from a webcam.

rtmpUrl

What is the URL of your RTMP Server? The URL is required for Webcam recording.

krecordDefaults

Configure recording details. Select Yes, to expose additional fields to configure the webcam widget quality.

emailErrors

Enable sending emails in case of errors.

Search

Field

Description

entriesPageSize

How many entries to show in search results.

inVideoPageSize

How many in-entry search results to show.

MediaCollaboration

Field

Description

mediaCollaborationEnabled

Enable MediaCollaboration module.

changeOwnerEnabled

This field is available when the MediaCollaboration module is enabled. The change owner feature has a special configuration for the co-editor/co-publisher and can be set to enable or disable the co-editor or co-publisher without any dependencies.

To add a user as co-editor or co-publisher, the user must log in to KAF prior to using this feature.

Enable this module to change the media owner and edit co-editors and co-publishers.

If configuration is set to 'no' after it was set to 'yes' and in the interim, entries were added with co-editors and co-publishers, all co-editors and co-publishers will lose their ability to view, edit or publish those entries.

Configuration Management: Modules

  1. Some fields are displayed only when you select a specific value for a different field.
  2. Field group names are in bold. The group's configurable fields follow the group name.

Addcontent

Field

Description

enabled

Enable the Addcontent module.

Attachments

Enable this module to:

  • allow media owners to attach files of any type to their media,
  • Enable media viewers to download the file before, during or after viewing.

Field

Description

enabled

Enable the Attachments module.

Captions

Field

Description

enabled

Enable the Captions module.

captionsKsuId

What is the uiConf ID of the Kaltura Simple Uploader (KSU) used for captions? KAF uses KSU to upload .SRT and .DFXP caption files.

thumbnailRotator

Enable thumbnail image rotation on mouse over in captions search results

entriesPageSize

How many entries are displayed as captions search results on each page? (The default is 10)

captionsPageSize

How many caption lines are displayed for each entry in search results? (The default is 5)

Clipper

Enable this module to create a Clip button in the Edit Media page. The Create Clip feature allows media owners to create clips directly from the Edit Media page.

Field

Description

enabled

Enable the Clipper module.

showClipAttribution

Should a clipped entry page contain an attribution to the original entry.

clipKdpUiconfId

What is the uiConf ID of the clipper kdp.

clippAppUiconfId

What is the uiConf ID of the clipp App.

clipperProfileId

The clipper custom data profile id.)

Comments

Field

Description

enabled

Enable the Comments module.

channelCommentsProfileId

Custom Metadata profile Id for channels

entryCommentsProfileId

Custom Metadata profile Id for entries

entryCommentsCountProfileId

Custom Metadata profile Id for entry comments count

commentsAllowed

Who can add comments?

pageSize

Number of comments to display

sort

Sort comments by newest or oldest first?

sortReplies

Sort replies by newest or oldest first?

allowClose

Allow content owners to disable/close comments for particular entries

showInGalleries

Enable/disable showing of comments for entries in the gallery page

showInChannels

Enable/disable showing of comments for entries in the channels page

showInChannelsOnly

Show comments on media entries to users only in the context of a channel/gallery. In this case, users will not be able to see media comments if browsing to the media from search results, my media or any other context that doesn't include the context of the channel/gallery. To enable this feature, from the KAF Admin > Comments set showInChannelsOnly to Yes.

showAddTimedCommentsCheckbox

 

Show Add comment at mm:ss checkbox.

showPrivateCommentsConfig

Show configuration for setting private comments per gallery/channel

Disclaimer

KAF administrators can enforce the Terms of Agreement text and checkbox for end-users to review and/or accept before uploading or publishing content.

Field

Description

enabled

Enable the Disclaimer module.

disclaimerProfileId

The disclaimer custom data profile id.

disclaimerField

Which custom data field is required to be checked when uploading or publishing media?.

disclaimerText

Text to show when explaining user the reason for this checkbox.

agreeText

The text to display next to the checkbox that the user accepts the terms of agreements.

displayArea

Before Upload - Terms of agreement are displayed to the user before they can contribute content. Only after the user agrees, the upload, launch screen recorder and other buttons are displayed. After checking the box, the button (or other option to upload) is enabled and the checkbox is disabled so it cannot be unchecked.

Before Publish - Terms of agreement are presented as part of metadata in the upload screen and in the edit media screen. The checkbox can be configured as a required field preventing the user from publishing media if the checkbox is not selected (This is the same behavior as when required metadata is not completed). After terms are agreed to by the user (The checkbox is selected and saved) the field turns into view only and select cannot be unchecked,

agreeRequired

This is relevant only if selected to show before publish. In this case the module displays the text of the terms of agreement and does not display a checkbox for the user to select.

Downloadmedia

Enable this module to configure downloadable versions of the media for viewers to download from the media page.

Field

Description

enabled

Enable the Downloadmedia module.

downloadRoles

Select one or more roles that can use the Downloadmedia module.

downloadFlavors

Click Add Download Flavors to configure the flavors that will be visible to the media owner to choose from. You, the admin, choose as many flavors as you want from the list of the transcoding profiles, as they appear in the KMC. You then can name the flavors as they should be displayed to the media owner. If no name is given, the flavor default name in Kaltura is used as the default name. The final list that is displayed to the media owner includes the list that was chosen by the admin, the flavors that are actually set (in the KMC) for this KAF instance and all other available flavors on the specific entry. It is advised that the KAF admin will verify with KMC admin what flavors are checked for the account beforehand.

Example of Downloadmedia Configuration

Embed

Field

Description

enabled

Enable the Embed module.

showMediaURL

Show link to media page.

emailShare

Sharing by email

allowEmbedIframeShare

Allow/Restrict sharing using 'iframe'. This configuration is only supported for non v2 supported players

embedAllowed

Select one or more roles that can use the Embed module. Use 'Ctrl' to select multiple roles. His End-users can share Kaltura unlisted and published media via Email. This is available in share tab, like media grab embed and page link. The media will be shared by the default mail client on the machine.

embedSkins

Define skins that can be used for embedded players.

name

What is the name of the skin? The skin name is displayed when the user selects an embed skin.

imgFile

What is the relative path to the image file on the server? The image file represents how the skin looks.

uiConfId

What is the numerical value of the player ID to use in the embed code?

embedSizes

Define sizes that can be used for embedded players. Define the player size in the following format: {width}x{height}

large

608x402

medium

400x285

small

304x231

Sidemymedia

Field

Description

 

 

Thumbnails

Field

Description

enabled

Enable the Thumbnails module.

thumbnailsKsuId

What is the uiConf ID of the Kaltura Simple Uploader (KSU) used for thumbnails upload? KAF uses KSU to upload thumbnails files.

extensionWhitelist

define allowed extensions, example: jpg, png, jpeg, gif (one item per extension)

Userreports

Channel/Course Managers can measure and analyse the user engagement and contribution to their channels/courses. These contextual analytics allow channel/course managers to answer important questions such as: What are the most popular videos in the channel/course? Who are the members that watch the most videos and what is their drop off rate? Who are the members that contribute the most media to the channel/course?

The mediaAnalytics field should be enabled to display the Analytics page. The Analytics page is accessed from the 'Actions' drop down of the entry page. The Analytics report is identical to the analytics for the entry in the KMC.

Field

Description

enabled

Enable the Userreports module.

mediaAnalytics

Enable media analytics for media owner

num_days

Default number of days

page_size

Default page size

Configuration Management: Channel Modules

Channelmoderation

You can define whether new Media Galleries that are created should be moderated by default. In addition, LMS administrators can configure if the moderation option can be disabled by Media Gallery managers, to comply with use cases where moderation must be enforced. In the Channelmoderation module, you can set the moderationDefaultValue to define if the moderation option should be enabled or not by default when Media Galleries are created.

  • If forceModeration = None then the moderationDefaultValue comes into play and the default value is set accordingly
  • If forceModeration = Moderated or Not Moderated then this field is the stronger one and sets the default behavior.

Module

Fields

Description

Channelmoderation

enabled

Enable the Channelmoderation module.

forceModeration

Force moderation on every new Media Gallery creation.

 

moderationDefaultValue

Default value when moderation checkbox is enabled

Configuration Management: Entry Type Modules

Authoring Methods

Related KAF modules: Widgets, Screencapture, Videopresentations, Captions, MetadataCustomdata

The KAF Admin Console provides great flexibility in configuring different authoring methods users can utilize for creating new content. To date, the following methods are available (with additional methods to be added in the future):

  • Uploading media from a  local machine
  • Capturing a video from a webcam using the Kaltura Webcam Recorder (KRecord)
  • Adding a Video Presentation
  • Creating a new screencast using the Kaltura Screen Recorder (KSR)

Please refer to the KAF LTI User Guide for more details about each of these methods.

Audioentry

Field

Description

customPlayerId

What is the player ID (uiConf ID) of the player that plays audios?  Leave blank to use the default player.

playerBarHeightPixels

The height (in pixels) of the custom player ui which is not part of the actual video (for example - the bottom bar). Leave blank to use the default player value.

playerVideoRatioPercent

The ratio (in percent) of the audio inside the player. Standard values: 16:9 = 56.25 , 4:3 = 75 , 16:10 = 62.5. Leave blank to use the default player value.

embedSizes

Define sizes that can be used for embedded players. Define the player size in the following format: {width}x{height}. This setting requires a custom player. If a custom player is not specified, the audio entry uses the default video player.

Imageentry

Field

Description

imagePlayerId

What is the player ID (uiConf ID) of the player that shows images?

imageWatermarkUrl

What is the URL of the image that should be used as watermark?

Screencapture

Field

Description

enabled

Enable the Screencapture module.

ksrId

What is the widget ID (uiConf ID) of the Kaltura Screen Recorder Widget (KSR) used in The LMS?

videoBitrate

The video bitrate quality (in kbps) to use for the capture. For example 2000

advancedOptionsEnabled

Enable the option to select frames per second by the user

limitationNoteEnable

Show limitation note?

limitationNote

Configure limitation note.

Videopresentations

Field

Description

enabled

Enable the Videopresentations module

sortMediaBy

By default, how should media in the gallery be sorted?

kpwid

What is the widget ID (uiConf ID) of the Kaltura Video-Presentation Widget used in the LMS?

kvpmDocUploadId

What is the uiConf ID of the Kaltura Document Upload widget? The Kaltura Document Upload widget is used by the Kaltura Video-Presentation widget.

kvpmCreationId

What is the uiConf ID of the Kaltura Video-Presentation widget? The Video-Presentation widget enables users to synchronize video with PowerPoint presentations.

YouTube

The LMS users can add YouTube video content and metadata into The LMS. Hosted content on YouTube is played back on the Kaltura V2 player from version 2.13 and above. To update the player to the latest player version, re-save the player settings in the KMC Studio > Universal Studio tab.

Field

Description

enabled

Enable the Youtube module

previewPlayer

The player uiconf to use for the YouTube entry preview when adding a new entry. Leave blank to use the default KAFplayer.

replaceYouTubeEntryMessage

The message to display when replacing a YouTube entry.

Channelplaylists

There are three admin modules used to configure the Channel Playlists: For reference, the Channelplaylists modules are used to create and modify course playlists.

Field

Description

enabled

Enable the ChannelPlaylists module

channelPlaylistsTabName

The title of the tab which will be added to the channel (Media Gallery) and will be presented first.

entriesSource

Add media to the playlist from the cahnnel gallery itself, from My Media or from all entitled areas in the site.

From this page you can:

Enabling Course Playlists

Course Playlists (Channelplaylists) activated by default for the KAF LTI instances.

To enable Course Playlists

  1. From the Channelplaylists page change the setting in the enabled field from No to Yes.
  2. Click Save to apply the changes.

Renaming the Playlists Tab

Admin users can rename the Playlists tab that appears in Media Gallery page:

To rename the Playlists tab:

  1. From the Channelplaylists page change the setting in the CoursePlaylistsTabName field from Playlists to any value you want.
  2. Click Save to apply the changes.

PlaylistPage

The configuration page dedicated to generating a player ID is accessed from the Configuration Management page Global sub-category PlaylistPage You can generate a player ID or refer to the playlist player ID in this module if you need to use the player ID number.

Field

Description

playerId

Enter the Playlist playerId. The playerId field is initially empty and the following message is displayed: "Create a Playlist player ID (uiConf ID) for playlists dedicated view page".

Click Create to generate the player ID.

Embedplaylist

The configuration page dedicated to activating and configuring the Embed Feature is accessed from the Configuration Management page Modules sub-category Embedplaylist.

Clicking Embedplaylist opens the Embed configuration page:

From this page you can:

  • Enable the Embed Feature
  • Define who (what Role) will be able to use the Embed feature by choosing one of the options in the PlaylistEmbedAllowed.
  • Direct users to the SSO Login page by setting the value of autoRedirect to Yes.
  • Define if the redirect for authentication will be in the top of the browser window (for global authentication) or in an iFrame.
  • Create your own redirect message in autoRedirectMessageHTML.
  • Define the HTML text (may include links) to display inside the iFrame in case a user is only allowed to a subset of the playlist content due to entitlements with authorizedForSubsetHTML.
  • Define the HTML text (may include links) to display inside the iFrame if autoRedirect is set to False with notAuthenticatedHTML.
  • Define the HTML text (may include links) to display inside the iFrame in case Kaltura Entitlement authorization fails with notAuthorizedHTML.
  • Specify the URL to an alternate CSS, to allow a customer to customize the iFrame design to fit corporate style guide with overrideCSSURL.
  • View skin colors and positions, V2 player types and player sizes.

Field

Description

enabled

Enable the Embedplaylist module.

playlistEmbedAllowed

Select one or more roles that can use the Embedplaylist module. Use 'Ctrl' to select multiple roles.

embedSkins

Define skins that can be used for embedded playlists.

light_horizontal

 

dark_horizontal

 

light_vertical

 

dark_vertical

 

embedSizes

Define sizes that can be used for embedded playlists.

horizontal

 

vertical

 

Custom/Core Modules/KAF

Browseandembed

The Broseandembed KAF module is used to enable and configure the Browse, Search and Embed tool in The LMS. This tool is available within the Rich-text (if installed) editor wherever it is available for example:

  • Assignments
  • Forums
  • Announcements

See The Kaltura Application Framework (KAF) LTI Integration Guide for more information.

Fields

Description

enable

Yes*

returnUrlMethod

POST*

allowEmbedFromMultipleCourses

When set to Yes, users will be able to embed videos from Media Galleries of all the courses they have access to. Set to No if you want to limit users to the Media Gallery of the current course only.

filterTypeAttribute

custom_filter_type* The LTI attribute the get the filter type from.

disableAddNewAttribute

custom_disable_add_new*. The LTI attribute the get the disable-add-new from.

enableNewBSEUI

Yes

BSEPlayerID

The default browse and embed player

minimalBSERole

Minimal KMS Role allowing browsing and embedding media

 

embedSizes

Define sizes that can be used for embedded players. Define the player size in the following format: {width}x{height}

enableAssignmentSubmission

 

This feature enables an additional pop up screen when selecting media in Browse, Search and Embed to verify if the user is submitting an assignment. If confirmed, the selected entry will be cloned under a different user name to prevent editing and deletion

assignmentSubmissionText

Determines the text that will appear on the pop up message when submitting an assignment. In case left empty, the default message will appear.

assignmentSubmissionMaxRole

This sets the highest role level which will see the pop up upon selecting an entry in Browse, Search and Embed.

Ltigeneric

Field

Description

enabled

Enables the LTI generic module. This setting is preconfigured and should not be changed

Hosted

Field

Description

enabled

Enables the Hosted module. This should not be changed

enableLike

Enable the 'Like' feature for entries.

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.

AllowUnpublishPublished

Set to No if you want to prevent users from setting entries to private 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

enableViews

Enable showing number of views per entry.

showPageTitles

Enable showing page titles

expandButton

Player expand button. Auto is on only if there are modules providing an entry sidebar.

manPublish

Yes. This should not be disabled unless publish plugin was integrated

authMethod

LTI. This should not be disabled

Quiz

Field

Description

enabled

Enables the Quiz module. 

 

 

Back to Top

Roles and Permissions

Related KAF modules: Hosted

See Common Use Cases of Role Configuration for recommendations for common role configurations in the Kaltura Application Framework Generic LTI Integration.

Introduction to Role Mapping

The Kaltura Application Framework Generic LTI Integration implements role mapping from LMS roles to Kaltura roles via LIS roles. Each role that is assigned to a user in the LMS is mapped to one of the roles defined in the LIS standard. When a user is assigned with a role in a LMS course – Instructor or Learner for example –the LMS 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 behaviour of the different Kaltura Video Package components in the LMS.

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 LMS Course-level Role

Users are assigned a LMS role when added to courses.

The LMS 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, the LMS sends the corresponding LIS role to Kaltura, according to the following mapping:

LMS Course-level role

LIS role

Learner

Learner

Instructor

Instructor

KAF Grants Permissions 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 LMS -> LIS -> Kaltura Roles Mapping

LMS

LIS role

Default Kaltura applicative role (kmsRole)

Default Kaltura contextual role (kmsContextualRole)

Learner

Learner

privateOnlyRole

CONTRIBUTOR

Instructor

Instructor

privateOnlyRole

MANAGER

Administrator

Administrator

privateOnlyRole

MANAGER

Common Use Cases of Role Configuration

This section provides recommendations for common role configuration in the Kaltura Application Framework Generic LTI Integration.

The following use cases are described:

Allowing Students to Upload Content

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

LMS Side Configuration

No special configuration is required on the LMS side for this case.

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

Description: Allowonly 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.

LMS-side Configuration

To accomplish this configuration, the My Media link should be hidden to all logged in users but 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).

KAF Side Configuration

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

ItiRole

kmsRole

kmsContextualRole

Learner

viewRole

MEMBER

Instructor

privateOnlyRole

MANAGER

 Back to Top

Document type: 
(5862 reads)