Custom/Core Modules/KAF

Custom/Core Modules/KAF

[collapsed title="Browseandembed"]

Browseandembed

The Browseandembed 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

Sakai: This tool is available within the CK editor wherever it is available.

The BSE Feature for Administrator’s Guide includes a comprehensive desctiption on how to configure the Browseandembed module.

For additional information for users, see The Kaltura Browse Search and Embed BSE Feature.

 

Fields

Description

enabled

Enable the Browseandembed module.

returnUrlMethod

Which method to use for the return url action. Get or Post.

allowEmbedFromMultipleCourses

Defines how many categories to include when embedding media. 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

This field enables the new Browse and Embed UI and functionality.Select v3 for the latest version.

v2

The following parameters are for configuring the Browseandembed module for KAF versions previous to 5.82.

BSEPlayerID

The default player for embedded media. If left empty the KAF main player will be used. Media types other than video will load with players set in the dedicated modules (e.g. audioEntry, imageEntry, Quiz, Kwebcast).

minimalBSERole

Minimal KMS/KAF 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.

contentItemReturnUrlAttr

The LTI attribute that holds the content-item return URL.

sendCimLineItem

v3

The following parameters are for configuring the Browseand embed module for KAF version 5.82 and forward.

EmbedSettingsButton

Select ‘Show  to present the Embed Settings button, allowing users to change the embed settings before embedding media.

BSEPlayerId

The default player for embedded media. If left empty, the KAF main player will be used. Media types other than video will load with players set in the dedicated modules (e.g. audioEntry, imageEntry, Quiz, kwebcast).

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.

contentItemReturnUrlAttr

The LTI attribute that holds the content-item return url.

sendCimLineItem

embedSettings

Enter the player's information to be used for embedding. If only one player per type is available, it will be set as the default for that type. If more than one play is available, the first in the list will be the default.

playerDisplayName

Player Display Name

playerId

Player ID

entryType

The media type this player is relevant for.

  • Video
  • Quiz
  • Audio
  • Image

isTypeDefault

Check the box to set this player as the default player type.

embedSizes

Select embed size.

embedSizeCustom

Use “width”x”height” in pixels to add a new embed sizes. If left empty the default will be used.

Click 'Add Embed Size Custom' to add the custom size. Click X to delet the custom size embed.

[/collapsed]

[collapsed title="Hosted"]

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. Enable publish to a list of categories - from the menu, media, and upload. Disable this if you do not have access to the list of categories.

authMethod

LTI. This should not be disabled.

sharedRepositoryCategoryId

Enable Shared Repository.

ltiRolesMapping

Map each LTI role to a MediaSpace role.

ltiRole

Enter the LTI role.

kmsRole

kmsContextualRole

allowedSharedRepository

Please click the link above to enable shared repository.

ltiUserIdAttribute

The LTI attribute to take the User ID from. If not specified, user_id will be used.

ltiOutcomeServiceURL

The LTI attribute to get the service API URL and application name.

ltiReturnUrlType

The type of the returned URL.

ltiContextIdAttribute

The LTI attribute the get the Context Id from.

ltiContextIdAttribute

If set to Yes, the relevant parameter that will be sent via KAF instances is the'Instance ID'.

enableNativeControlsOnIpad

This field adds the necessary parameters to the player for iPad compatibility.

showInContextInCourseGallery

Select ‘Enabled:Default-No’ or 'Enabled:Default-Yes' to allow managers to show all media embedded via BSE in the Media Gallery. Media Gallery managers can change this setting from the Media Gallery settings page. This feature is only available with both v2ui and eSearch enabled.

Note: IVQ content embedded in context will not be affected by this feature and will not appear in the Media Gallery unless published to it directly.

[/collapsed]

[collapsed title="D2L"]

D2L

Field

Description

enabled

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


[/collapsed]

[collapsed title="Ltigrading"]

Ltigrading

Field

Description

enabled

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

[/collapsed]

[collapsed title="Moodle"]

Moodle

Field

Description

enabled

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

[/collapsed]

[collapsed title="Canvas"]

Canvas

Field

Description

enabled

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

[/collapsed]

[collapsed title="Sakai"]

Sakai

Field

Description

enabled

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

 

 

 

 

 

 

[/collapsed]

[collapsed title="Teams"]

Teams

FieldDescription
enabledEnables the Teams module. This setting is preconfigured and should not be changed.
userAttributeConfiguration

Select the attribute Teams should use as the user name. The choices are:

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Hostedrelated"]

Hostedrelated

When enabled this module displays the entry viewed from a channel (course) on the sidebar. You can see entries from the same channel. Only one module’s sidebar is shown in KAF.

 

Field

Description

enabled

Enables the Hostedrelated module.

limit

How many related media items can be displayed?

[/collapsed]

[collapsed title="Blackboardultra"]

Blackboardultra

Field

Description

enabled

Enables the Blackboard Ultra module. This setting is preconfigured and should not be changed.


[/collapsed]

In This Article