Configuration Management: Modules - KMS Management Console/KAF Admin

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.

[collapsed title="Accessibility"]

Accessibility

Field

Description

enabled

Enable the Accessibility Module.

showContrastButton

Show a button that allows users to toggle contrast on site pages

[/collapsed]

[collapsed title="Addcontent"]

Addcontent

Field

Description

enabled

Enable the Addcontent Module.

[/collapsed]

[collapsed title="Attachments"]

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.

showOnlyAttachmentType

Enabling this will cause transcript files (created by APIs for example) to not show in the attachments tab.

allowAnonymous

Enabling this will allow anonymous users to view and download attachments.

[/collapsed]

[collapsed title="Captions"]

Captions

Field

Description

enabled

Enable the Captions Module.

thumbnailRotator

Enable thumbnail image rotation on mouseover in the 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)

allowToggleDisplayOnPlayer

Select "Yes" to allow the user to decide whether to display the caption on the player.

allowEditCaptions

Select "Yes" to enable the Caption Editor button in the Captions tab.

maxCharsPerLine

Editor: Max char per caption line.

preventSaveOnOverlap

Editor: do not allow saving changes if there is time overlapping.

[/collapsed]

[collapsed title="Channelplaylists"]

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 channel 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.

FieldDescription

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

  

[/collapsed]

[collapsed title="Cielo24 "]

Cielo24

cielo24- searchable captions™ and Kaltura have partnered to provide Kaltura clients with full caption, index and transcription services.

FieldDefinitionDescriptionVariable

userName

The username of your cielo24 account.

This is provided directly from cielo24 or provisioned through “auto-provisioning”.  If you do not have a username or password, please reach out to your Kaltura rep or cielo24 at sales@cielo24.com.

 

password

The password of your cielo24 account. 

This will be provided along with the cielo24 username. If you are using an apiKey, you do not require a password.  Please see userName description for details around procuring a password.

 

apiKey

API Key for secure ( instead of password)

This is used as an alternative to the password (above).  Also provided by cielo24.

 

serverUrl

cielo24 Server URL.

https://api.cielo24.com

https://api.cielo24.com

logo

cielo24 Logo

Hide or show the cielo24 logo on Order Captions screen.

Show

Hide

orderCaptionScreenText

Display info text on Order Caption screen.

There this 100 character limit. This feature can be used to communicate simple messages to users on the order captions panel, typically instructive or descriptive.

 

AllowOrdering

Select User Roles to set who is able to request captions.

Users who are logged in with an enabled permission role, will have the “Order Captions” button available.

 

allowOrderingSpeakerName

Select User Roles to enable adding speaker identification

Users who are logged in with an enabled permission role, will to add Speaker name identification to caption order requests

 

requireRequestsAuthorization

If enabled, caption requests must be approved before processing. 

Captions submissions are not sent into moderation prior to processing. The request will require “Approval” or “Rejection” from an administrator role.  While approving the request, the moderator also has the capability to adjust request parameters for fidelity and turnaround time prior to approving.

Yes

No

requireAuthMechanicalFidelity

If enabled, mechanical caption requests must be approved before processing begins.

 

If disabled and requireRequestsAuthorization is enabled, mechanical caption requests will be processed automatically without approval.

 

 

 

Yes

No

allowAuthorize

Users enabled will be able to authorize and delete caption requests. 

This setting is tied directly to requireRequestsAuthorization and requireAuthMechanicalFidelity configurations.

 

allowEdit

Users enabled will be able to edit completed caption using the Customer Edit Tool.

For permitted User Roles ‘edit captions’ will be available from the ‘Actions’ drop down of the media entry. Please find instructions for using the customer edit tool here.

 

 

allowView

Users enabled will be able to view all caption requests for an entry.

For permitted User Roles ‘view captions’ will be available from the ‘Actions’ drop down of the media entry.

 

language

Language set will be default language for all caption requests.

 

 

languageOverride

Select User Roles enabled to adjust the source language of caption requests.

This provides the ability for users to select native foreign language processing i.e. (Spanish audio into Spanish captions/transcripts)

 

additionalLanguage

Select User Roles enabled to request foreign language translation when ordering captions. 

cielo24 supports English into 15 supported languages, as well any of the listed languages into English. Custom translation will need to be requested directly from cielo24 by contacting support@cielo24.com. Translation requests will automatically perform native transcription first, and then translation from native transcription to requested language. For example, if ‘Request Foreign Language Translation’ is enabled and you select a language to translate (e.g. Source Media Language = English and Target Translation Language = Hebrew) the request will process in two parts automatically A) Native Transcription (return English captions) B) Foreign Translation (return Hebrew captions).

 

fidelity

Set value is default fidelity for caption requests

Choose the default accuracy options (Professional, Premium, Mechanical)

Professional (99%)

Premium (94 to 96%)

Mechanical (70 to 80%)

fidelityOverride

Select User Roles enabled to change the requested fidelity of caption requests.

Allows users to select the various accuracy options (Professional, Premium, Mechanical)

 

fidelityChoices

Enabled options will be available fidelity choices when ordering captions

Configures the fidelity options permitted users are able to choose from when selecting  accuracy levels.

Professional (99%)

Premium (94 to 96%)

Mechanical (70 to 80%)

turnaroundTime

Default value for turnaround time of caption requests

Choose the default turnaround time for English transcription requests.

Standard (7 days)

Standard (48 hours)

Priority (24 hours)

Critical (6 hours)

Critical (3 hours)

Custom

turnaroundTimeChoices

Enabled options will be available turnaround time choices when ordering captions

Configures the turnaround options permitted users are able to choose from when changing processing times.

Standard (7 days)

Standard (48 hours)

Priority (24 hours)

Critical (6 hours)

Critical (3 hours)

Custom

turnaroundTimeOverride

Select User Roles enabled to choose turnaround time value when ordering captions

Allows users to select the various turnaround options (24 hours, 48 hours, 7 days, etc.)

 

format

File format of returned caption file to KMC

Default is DFXP.

DFXP

SRT

showMediaDataAsTags

Allow media data to appear as tags on entries that have been processed

cielo24 provides media data (keywords, topic, entities, speaker names, etc.) about a given media file. By enabling this setting these outputs are displayed at Tags.

 

progressiveReturn

Select User Roles enabled to set progressive return

Progressive return is the interim delivery of all three fidelities (accuracies) cielo24 provides.  Media will initially be processed at the Machine output and data will be populated within Mechanical SLA, followed by the Premium fidelity, ending in the Professional quality.

 

progressiveReturnDefault

If enabled progressive return will be turned on my default

Videos selected at Professional fidelity will be processed with Progressive Return (see progressiveReturn description) workflow by default.

Yes

No

allowNotes

Select User Roles enabled to add special notes to transcriptionists when ordering captions for a specific entry

Notes serve as a resource for cielo24’s transcription team to aid with difficult technical terminology, domain information, and names.

 

glossary

This text will be shown as notes to transcriptionists for ALL caption requests from your account

Glossaries can be added on an account level to provide a rolodex of terminology, genres, names, etc  to cielo24’s transcription team.

 

privateCustomerEditTool

 

If set to 'Yes' then the Customer Edit tool is only accessible from within KMS, if set to 'No' the link to the tool can be shared publicly and accessed without authentication.

 

publicCustomerEditLifetime

 

Public Customer Edit tool access expires after given # of minutes (set to -1 for infinity)

 

maxCaptionRequestWindow

Used to determine the filter for data retrieved and presented in the captions table.

Advanced Setting - maximum date range for Caption Requests (Note: this limits data requested to the timeframe selected; no data beyond this window will be loaded)

 

cielo24ProfileId

Custom metadata profile ID for cielo24

This will be set automatically when the plugin is enabled.

 

 

 

 

 

 

[

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Chapters"]

Chapters

Note: The minimum player version required for this module to work is v2.26. The Chapters module is mandatory for the Kalturacapture module but can also work independently, without it.

Field

Description

enabled

Enable the Chapters Module.

enableFullDeck

Enables the ability to upload a document / presentation file as slides.

For additional information about chapter see the article The Kaltura Player- Editing/Deleting Chapters and Slides.

[/collapsed]

[collapsed title="Clipper"]

Clipper

The Clipper module has been deprecated. See the Editor module for clipping and trimming capabilities.

[/collapsed]

[collapsed title="Comments"]

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Contentpolicy"]

Contentpolicy

Field

Description

enabled

Enable the Contentpolicy Module.

contentPolicyText

Content policy for my media entries and channels. Use [b]foo[/b] - for bold, [i]foo[/i] - for italic. Full list here.

[/collapsed]

[collapsed title="Cssupload"]

Cssupload

Upload CSS files to your KMS site.

Field

Description

enabled

Enable the Cssupload Module.

upload bootstrap

Upload an alternative bootstrap.min.css file to the one in use by KMS. Only useable for Bootstrap based themes.

upload additional

Upload an additional css file to KMS to include additional classes not defined as part of the standard Bootstrap CSS file.

[/collapsed]

[collapsed title="Customdata"]

Customdata

Field

Description

enabled

Enable the Customdata Module.

profileId

What is the ID of the custom metadata? Copy the custom data schema ID from KMC > Settings > Custom Data (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata).

dateFormat

What is the format of the date for the datepicker

requiredFields

Which custom data fields are required when uploading or editing media? Use custom data System Names from KMC > Settings > Custom Data (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata).

privateFields

Which custom data fields are not displayed in MediaSpace? Use custom data system names from KMC > Settings > Custom Data (http://www.kaltura.com/index.php/kmc/kmc4#account|metadata). Note: Private custom data fields are not hidden when the media owner accesses the media from My Media.

hiddenFiltersFields

Which custom data fields will not be available as a search filters. Check the fields you want to exclude in your search.

showInSearchResults

Allow custom data to be searchable

[/collapsed]

[collapsed title="Customfavicon"]

Customfavicon

MediaSpace Administrators can set a custom favicon, which is a small, iconic image that represents your website. Favicons are most often found in the address bar of your web browser, but they can also be used in lists of bookmarks in web browsers and feed aggregators. The KMS Admin can upload an image file through the faviconName field in this module. Supported file formats are: PNG, GIF, and JPG. It is recommended that the image be a square and no larger than 32 x 32..

 

Field

Description

enabled

Enable the Customfavicon Module.

faviconName

Click Upload and select an image file.

favviconURL

Click Reset to reset to the default file.

[/collapsed]

[collapsed title="Disclaimer"]

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.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Downloadmedia"]

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

[/collapsed]

[collapsed title="Editor"]

Editor

The Editor Module activates the Kaltura Video Editing Tools. When the Editor Module is accessed from the KMS/KAF admin for the first time (before saving the configuration), the following parameter’s values are copied from the Clipper Module to the Editor Module: 

  • showClipAttribution - Should a clipped entry page contain an attribution to the original entry.
  • clipperprofileID- What is the uiConf ID of the Clipper App.
  • Clipper Module - enabled Yes or No.

Field

Description

Enabled

Enable the Editor module.

enableClipping

Should users be allowed to use the editor to clip entries? The values from the KMS/KAF Clipper module are consolidated into the Kaltura Video Editing Tools and not configured in the Editor module.
If set to No, the “Save a Copy” option will be disabled in KEdit.

enableTrimming

Should users be allowed to use the editor to trim entries?
If set to No, the “Save” option will be disabled in the Kaltura Video Editing Tools.

showClipAttribution

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

If set to Yes, then Clipped media will contain a “Created from…” attribute

 

clipperProfileId

Metadata profile ID for clipping permissions. Allows media owners and co-editors to decide whether the media can be clipped by other users.

keaPlayerId

What is the player ID of the player used in Kaltura Video Editing Tools? Leave empty to use the default. Leave this field empty to use the default.

keaDocumnetationURL

What is the link to the custom Kaltura Video Editing Tools documentation. Leave empty to use the default.

keaPreviewPlayerId

What is the player ID of the preview player used in Kaltura Video Editing Tools? Leave empty to use the default.

keaCustomCss

Use to upload a new custom language CSS file for the Kaltura Video Editing Tools interface.

downloadLocales

Download a zip file which contains all texts for all built-in locales. These can be used to create custom languages.

uploadCustomLanguage

 

languageCode

Select the language code. Note that the selected language code should match an existing localized version of the application.

localeFile

Upload your customized .json file.

[/collapsed]

[collapsed title="Emailnotifications"]

Emailnotifications

Click on the dedicated page link in this screen to get to the page where you can enable the different email notification events and define the email templates for each. See the section on Setting Email Notifications and Channel Subscriptions for more information.

Field

Description

enabled

Enable the Emailnotifications module.

[/collapsed]

[collapsed title="Embed"]

Embed

Field

Description

enabled

Enable the Embed module.

secureEmbed

Use secure embed. MediaSpace entitlements are enforced on media that is embedded in external sites. When embedding restricted or private media to your sites and blogs, you will be prompted to authenticate (if not already authenticated). If a user is authorized to watch the media according to the entitlements defined in MediaSpace, the media will play. Otherwise, a message will be displayed that they are not authorized to watch the media.

When secure Embed is enabled the following fields (in italics) are displayed

For additional information about this feature, see the article: Enhanced Settings for Secure Embed in KMS/KAF.

autoRedirect

Select True to automatically-redirect the user to the SSO login page in case the user is not authenticated with MediaSpace (If the user is globally authenticated, they will be auto-authenticated by MediaSpace then redirected back to the page with the video). Select False to display a message to the user so that the user can manually select when/whether to re-authenticate.

autoRedirectIframe

When autoRedirectIframe is disabled (default), the redirect for authentication will use the top browser window. When autoRedirectIframe is enabled, the redirect will occur in the iframe

autoRedirectIframe

When autoRedirectIframe is disabled (default), the redirect for authentication will use the top browser window. When autoRedirectIframe is enabled, the redirect will occur in the iframe.

autoRedirectMessageHTML

HTML text to display while the user is auto redirected to the login page.

notAuthenticatedHTML

HTML text (may include links) to display inside the iFrame if autoRedirect is set to False

notAuthorizedHTML

HTML text (may include links) to display inside the iFrame in case Kaltura Entitlement authorization fails

noCategoryEmbedAccessHTML

HTML text (may include links) to display inside the Embed tab of an entry page accessed not via a category/channel/gallery, when requireCategoryContext=Yes

noCategoryPlayAccessHTML

HTML text (may include links) to display inside the iFrame, in case category-level embed grab and play are disabled for the category/gallery from where embed was originally grabbed, and/or when requireCategoryContext=Yes and a (legacy) secured embed is missing a category context.

overrideCSSURL

URL to an alternate CSS, to allow a customer to customize the iFrame design to fit corporate style guide

categoryLevelEmbed

Allow KMS category/channel (or KAF course gallery) managers to prevent grabbing and playing embed content from a specific category. Depends on CategoryEmbed/ChannelEmbed modules. For more information see here.

requireCategoryContext

Set to Yes, in conjunction with categoryLevelEmbed=Yes, to make sure embeds are only grabbed from category/gallery contexts. Grabbing an embed from a regular (context-less) entry page will not be allowed. NOTE: Setting this to Yes will cause secured embeds that lack a category context to stop authorizing playback

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

embedResponsiveness

Enable/Disable 'Responsive Sizing' option in the embed view. 

embedAllowed

Use 'Ctrl' to select multiple roles. 

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Entrydesign"]

Entrydesign

Use to customize the KMS entry's display.

Field

Description

enabled

Enable the Entrydesign module.

entryDesignRole

Roles or specific users that are allowed to design entries.

players

Fill in the player ID and the player display name you want to allow users to use in the entry page. If left blank, the site’s default player is used.

+Add “Players”

playerDisplayName

Enter the Player Display Name.

playerId

Enter the Player ID.

entryType

Select an entry type from the drop down menu.
 

 showEmbedPlayerOption

  • Force Entrydesign Player in Embed Code - Owner/co-editor will not see “Set as Embed Player” button. Players designated in the Embed module will be overridden. If selected, designated Entrydesign player will be used in the embed code of the Share area.
  • Use Embed Module Players - This is the default option which disables this feature. Owner/co-editor will not see “Set as Embed Player” button. The embed code in the share area will use the settings designated in the Embed module.
  • User Selects - Owner/co-editor will see “Set as Embed Player” button. Players designated in the Embed module will be overridden. When selected, this player will also be used in the embed code of the Share area.

allowedElements

Which elements should be customizable in the entry page display.

allowCSS

Set to yes to allow the entry owner to use CSS to change the look and feel of the page.

allowLogoChange

Set to yes to allow the entry owner to set a new logo for KMS when viewing the entry.

 

[/collapsed]

[collapsed title="Facebook"]

Facebook

Add the open-graph metadata to the view media page to support embedding videos in a Facebook feed by simply copy and pasting the URL of the media page.

To use this feature ‘allowAnonymous’ in ‘auth’ module must be enabled as well and 'Default Entitlement Enforcement' on the partner should be disabled

Field

Description

enabled

Enable the Facebook Module.

fPlayerId

What is the player ID (uiConf ID) of the player that plays videos on Facebook?

useHighestQuality

Use the best quality flavor that can be played in Facebook.


[/collapsed]

[collapsed title="Headermenu"]

Headermenu

Field

Description

enabled

Enable the Headermenu Module.

menu

Define the items that are displayed on the top right in the header menu.

type

Type can be My Media, My Playlists, URL, Menu, or My Channels.

label

For a URL, enter the URL label. For a Menu, enter the label.

link

Enter a URL. A URL that starts with http:// opens in a new window.

items

A menu item consists of a label (text) and a link (URL).

sameWindow

Select whether link should open in new window (target = _blank) or same window. Applied only to external links (absolute URLs)

linkLoaction

Choose the location of where each added link will appear. Added links can be displayed in the header itself (as they did before) or in the user drop down menu that is part of the header (for example, “My Media”, “My Playlists, etc.). To define the location of your menu items of type URL, configure the linkLocation for each menu of type URL.


[/collapsed]

[collapsed title="History"]

History

Field

Description

enabled

Enable the History Module.

resumePlayback

Enable the "Resume Playback" feature. This feature will enable an indicator bar below the thumbnail of videos, showing the progress of the user in it.

resumeplaybackOptions

 

videoEndPercent

Reaching this percentage of the video or higher will count as ‘finished watching’ the video

videoEndSeconds

Reaching this amount of seconds before the end of the video or lower will count as ‘finished watching’ the video

barColorBackground

The color of the progress bar background

barColorDone

The color of the finished progress bar

emptyHistory

Fill in the message the users will see when reaching an empty History page.

deleteAllText

Fill in the message the users will see when clicking on the clear all history button.

showUnlisted

Show/hide 'unlisted' entries from the users history.

supportSecureEmbed

Allow videos in a secure embed to be added to the user’s history.

addToHistoryTrigger

Choose the way videos are added to the user’s history. Play - videos will be added with a play click. View - videos will be added by landing on the video page. (Entries of type image will always be triggered by view event)

dateFormat

Date format. Only j, d, D, l, n, m, M, F, y, Y format characters are supported due to datepicker widget limitations

[/collapsed]

[collapsed title="Home"]

Home

Use this module to configure your MediaSpace home page/landing page.

Field

Description

enabled

Enable the Home Module.

thumbnailRotator

Enable thumbnail image rotation on mouseover in homepage

carouselEnabled

Show the carousel

carouselInterval

interval (in miliseconds) between carousel transitions

carouselStyle

Select carousel style.

carousel

 

type

Select content for the Carousel:

carouselBg

carousel background color

lists

To add playlists to your home page. You can use playlists that have been configured in the KMC.

type

Select content for the list:

Most Recent, Most Viewed, Most Liked, Most Commented or Custom Playlist

Name

Enter the list name to display.

Choose “custom” to enter a KMC playlistid

 

 

Example: Configure the carousel display

To configure the carousel display

  1. Select an option from “type” drop down menu.
  2. Click Save.

To add a custom playlist

  1. Select Custom Playlist from the Type drop down menu.
  2. Enter the playlistId. The playlistId can be obtained from the KMC.
  3. Click Save.

 

[/collapsed]

[collapsed title="Hotspots"]

Hotspots

The minimum Kaltura Player version required to use Hotspots is 2.75.

If there are players used in the KMS/KAF instance that do not meet the minimum player requirement, an alert is displayed listing those players with their UIconf IDs.

The ability to Save the Hotspots module's cofiguration is available only after upgrading the legacy players.

Field

Description

enabled

Enable the Hotspots Module.

[/collapsed]

[collapsed title="Importchannel"]

Importchannel

Channel/Media Gallery Managers have the ability to import content from other Channels/Media Galleries they manage.

 

Field

Description

enabled

Enable the Importchannel Module.

[/collapsed]

[collapsed title="Kalturacapture"]

Kalturacapture

Field

Description

enabled

Enable the Kalturacapture Module.

AllowDownloadingClient

Allow end users to download the Kaltura Capture dektop application from KMS/KAF.

AddNewLabel

Set the Add New menu label for Kaltura Capture.

allowedRoles

Select roles or specific users that will be able to create Kaltura Captures. If a role is selected, any role above it will also be able to create media using Kaltura Capture.

entryURL

What URL to show the user after the captured media is uploaded. Leave unchanged.

[/collapsed]

[collapsed title="Kmsapi"]

Kmsapi

Use this module to enable the KMS Go application on your mobile device.

For more information about the KMS Go mobile app, see the articles about Kaltura MediaSpace Go (KMS Go) on the Knowledge Center.

Field

Description

enabled

Enable the Kmsapi module.

IOSAppId

The Apple Application ID that will be used when smart banners on iOS Safari will be displayed.

iOSBundleId

The Apple application id that will be used when smart banners on IOS Safari will be displayed.

AndroidAppId

The Android Application ID that will be used when smart banners on Android mobile browsers will be displayed.

deepLinkSubDomain

The iOS/Andorid branded application subdomain. Used for deep-linking

storeAppName

The name of the branded mobile application

appStoreAppId

(iOS) Your app's App Store ID, used to send users to the App Store when the app isn't installed

storeAppLogoUrl

The URL for the branded application logo. Image dimensions: 64x64 pixels. Keep empty to use default

Home_Playlists

Define the playlists for the native home screen. You can add and delete playlists using this field.

DELETE or +Add Home_Playlists

 

type

Select the type of playlist from the drop down menu.

name

Enter the playlist name that will be displayed.

channelId

(Channel Playlists only) Enter the custom channel id for Channel Playlists

playlistID

(Custom Playlists only) Enter the custom playlist id.

detailsView

(Custom Playlists only) When set to 'No', the default view of playlist (Thumbnail view) will be used.

playerAutoPlayOnLoad

When entry page loads, should the video begin playing automatically?

mobileSessionLifeTime

The length of a mobile KMS user session (in seconds). Note that every KMS SaaS version deployment will force a new session (on the appColorR  of the value input here).

appColorR

The R value for RGB that is used as the custom brand color of the application. Input a number between 0-255. Note: RGB.alpha fields cannot be partially filled out.

appColorG

The G value for RGB that is used as the custom brand color of the app. Input a number between 0-255. Note: RGB alpha fields cannot be partially filled out.

appColorB

The B value for RGB that is used as the custom brand color of the app. Input a number between 0-255.

Note: RGB alpha fields cannot be partially filled out.

splashImageUrl

Set an image URL for the KMS app splash screen. Use an image size of 192x131. The URL must be a secured URL (begin with https://).

downloadEnabled

Enable to allow downloading media for offline viewing.

downloadQuality

Chooses the rendition/flavor of the video to be available for users to download for offline playback. High will download the highest quality possible (in terms of dimensions and bitrate) and low the lowest.

smartBannerEnabled

Enable smart banner for Android and iOS applications

dontShowLoginInMyPage

Don't show login button in my page.

uploadEnabled

Enable displaying the upload functionality.

showMySubscriptionSection

Enable displaying the list of channels the user is subscribed to, on top of the home screen.

showEntriesInMySubscriptionSection

Display list of all the entries under subscribed channels instead of subscribed channels

playlistContinuousPlay

Select whether the playlist entries should play automatically one after the other.

allowPushNotifications

Allow push notifications.

pushNotificationsDefaultToken

Use push notification default Firebase token

hideInspireMe

Selects whether to hide the inspire me section

hidePublisherName

Selects whether to hide the entry's publisher name

iosTermsOfUse

Add the terms of use that will be displayed to the user on IOS devices.
Note: For translation fill this field with 'terms_of_use_ios' and translate via PO file

androidTermsOfUse

Add the terms of use that will be displayed to the user on Android devices.
Note: For translation fill this field with 'terms_of_use_android' and translate via PO file

spotlightSearchEnabled

Enable spotlight Search from outside the application on IOS

[/collapsed]

[collapsed title="oembed"]

Oembed

The oEmbed Endpoint in KMS is now able to accept the entry page URL as input and not only the copied link from the 'share / oEmbed' tab.

In addition to this type of URL:

https://[MediaSpace URL]/id/[entry ID]?width=400&height=285&playerId=12345678

this type of URL may be used:

https://[MediaSpace URL]/media/[Entry Name]/[Entry ID].

This improves the flexibility with oEmbed-supported destinations.

Field

Description

enabled

Enable the Oembed Module.

type

Which type of oEmbed code should be displayed?  'Short' is the common type. For example: http://url.for.mediaspace/id/xyz, where xyz is the media asset ID (entry ID). 'Short' links are valid URLs. A 'Short' link entered in a browser loads MediaSpace with the video loaded in the player. 'Full' is much longer than 'Short.' Use 'Full' when your oEmbed 'consumer' cannot convert a link embed code to a full oEmbed request.

enableCustomization

When a user selects 'oEmbed' for the 'Select Embed Type' option, should the options for selecting a player skin and player size be displayed? Note: If you enable customization, your oEmbed must be able to accept the oEmbed link format that is created.

playerId

What player ID (uiConf ID) should be used to display the embedded video? Note: If you are not sure, enter 'default' (without quotes) or leave the playerId field empty. MediaSpace will use the value of the first embedSkin config.

height

What is the height (in pixels) of the oEmbed player? Enter only the number.

width

What is the width (in pixels) of the oEmbed player? Enter only the number.

[/collapsed]

[collapsed title="Publish"]

Publish

Field

Description

enabled

Enable the Publish Module.

defaultPublishStatusOnUpload

Define the default privacy for each newly uploaded media. Prior to this change, each newly uploaded media's status was set to "Private" as the default. Now, MediaSpace administrators can configure every newly uploaded media to be set as "Unlisted" by default, and allow the media owner to change the privacy mode. To configure this option, set the required value for defaultPublishStatusOnUpload. Note that this configuration is applicable only if Unlisted mode is enabled on your MediaSpace instance. You can check if it is enabled under Application > enableUnlisted.

manPublish

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.

[/collapsed]

[collapsed title="REACH"]

REACH

REACH offers two different service options, human captioning and ASR machine transcription, which can be used separately or together. Captions ordered directly within the Kaltura interface are automatically delivered and can be edited for quick review and modification.

 

Field

Description

Values

enabled

Enable the REACH Module.

 

reachProfileId

ID of the REACH profile to use with Kaltura MediaSpace or KAF.The Reach profile includes the credit, and other parameters such as: moderation flow, file types etc.

At least one profile must be selected.

orderScreenText

Text to show on the order task form: 1000 characters max.

 

unitFieldName

Select a label for the 'Unit' field . If left empty "Unit" will be used.

 

availableServices

Allow users to select the following services.

Combinations of all available services, features are TAT.

For example:

HUMAN, CAPTIONS, THIRTY_MINUTES

HUMAN, CAPTIONS, SIX_HOURS

HUMAN, CAPTIONS, FORTY_EIGHT_HOURS

HUMAN, CAPTIONS, BEST_EFFORT

HUMAN, CAPTIONS, TWENTY_FOUR_HOURS

HUMAN, TRANSLATION, TWENTY_FOUR_HOURS

HUMAN, TRANSLATION, IMMEDIATE

HUMAN, TRANSLATION, THREE_HOURS

HUMAN, TRANSLATION, SIX_HOURS

MACHINE, TRANSLATION, SIX_HOURS

MACHINE, TRANSLATION, BEST_EFFORT

MACHINE, CAPTIONS, THREE_HOURS

MACHINE, CAPTIONS, SIX_HOURS

MACHINE, CAPTIONS, THIRTY_MINUTES

viewEntryRequestsRole

Select the role required to access the entry task requests screen.

privateOnlyRole

adminRole

unmoderatedAdmin Role

Co-Editor

Owner

orderer

Select who can order tasks.

Specific Roles

Specific Users

orderRole

The minimal role required to order tasks.

privateOnly Role

admin Role

unmoderatedAdmin Role

Co-Editor

Owner

serviceTypeDefault

Select the default service type.

Machine

Human

serviceFeatureDefault

Select the default service feature

Captions

Translation

Alignment

Audio Description

sourceLanguageDefault

Select the default source language.

See Source Media Languages.

turnaroundTimeDefault

Select the default turnaround time.

 

serviceSelectionRole

The minimal role required for service selection.

privateOnly Role

admin Role

unmoderatedAdmin Role

Specific Users

featureSelectionRole

The minimal role required for feature selection.

privateOnly Role

admin Role

unmoderatedAdmin Role

Specific Users

TatSelectionRole

The minimal role required for TAT selection.

privateOnly Role

admin Role

unmoderatedAdmin Role

Specific Users

speakerSelectionRole

The minimal role required for speaker selection.

privateOnly Role

admin Role

unmoderatedAdmin Role

 

dashboardAccessRole

The minimal role required to aprove task requests.

Specific Users

admin Role

unmoderatedAdmin Role

requestApprovalRole

The minimal role required to approve task requests.

Specific Users

admin Role

unmoderatedAdmin Role

notifiedUsers

Select specific users who will receive email notifications about items pending moderation. To customize notifications, go to email notifications configuration.

Enter the user name.  Existing users may be found using the autocomplete feature: type in the first three characters of the user’s name.

trustedUsers

Select users who do not need approvals for their requests.

 

categoryRuleOrderRole

 

Channel Manager

Channel Owner

captionEditRole

 

privateOnly Role

admin Role

unmoderatedAdmin Role

Co-Editor

Owner

allowProfilePermissions

Allow individual profile configurations.

Select Yes and then configure values for each profile according the the values in this article.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

[/collapsed]

[collapsed title="Recorder"]

Recorder

Field

Description

enabled

Enable the Recorder Module.

allowedRole

Select the users allowed to use this tool

maxRecordingTime

Set the maximum allowed recording time in seconds. (leave empty to remove limit)

browserNotSupportedText

Select the text to display when a user reaches the tool from a none supported browser. Use HTML to add links ( tag)

ConversionProfileId

Fill in a custom conversion profile ID for recordings. Leave the field empty to use the default conversion profile

playerId

Enter the id of the player that will be used to view recorded media before upload. The Player version must be v3.

[/collapsed]

[collapsed title="Related"]

Related

Field

Description

enabled

Enable the Related Module.

limit

How many related videos can be displayed?

[/collapsed]

[collapsed title="ReplaceMedia"]

ReplaceMedia

Media owners can replace their media, while keeping metadata, URL and analytics in place. The same functionality as in the KMC is available in KMS and is configurable in the Replacemedia module.

Only video entries may be replaced. Any time-based metadata on the entry will be kept in place and may be out of sync with the new media, The metatdata should be manually adjusted.

 

Field

 

enabled

Enable the Replacemedia module.

[/collapsed]

[collapsed title="SAML"]

Saml

Please see the Kaltura MediaSpace™ SAML Integration Guide for the setup configuration.

[/collapsed]

[collapsed title="Samlgroupsync"]

Samlgroupync

Please see the  Kaltura SAML Group Sync Administrator's Guide for the setup configuration.

[/collapsed]

[collapsed title="Scheduling"]

Scheduling

Use the Scheduling module to

  • Set Entry's publish schedule to categories or channels.
  • Sort and filter entries by scheduling range in my-media.

Field

Description

enabled

Enable the Scheduling module.

dateFormat

Define the date format for the time presented.

[/collapsed]

[collapsed title="Sidemymedia"]

Sidemymedia

enabled

Enable the Sidemymedia module.

limit

How many Sidemymedia items can be displayed?

[/collapsed]

[collapsed title="Sideplaylists"]

Sideplaylists

Field

Description

enabled

Enable the Sideplaylists module.

limit

How many items can be displayed in a side playlist?

items

Define playlists to display on the right side next to the player.

label

Enter the playlist label.

id

Enter the ID of the playlist to display.

[/collapsed]

[collapsed title="Ssogroupsync"]

Ssogroupsync

Please see the  Kaltura SSO Group Sync Administrator's Guide for the setup configuration. 

[/collapsed]

[collapsed title="Staticpages"]

Staticpages

You can add static/content pages to your MediaSpace site. Static pages can be used, for example, to create help pages, privacy policies etc. From the KMS Admin, enable the Staticpages module. After you enable the module, you can add multiple pages to your site. Each page should include:

 

Field

Description

Module Info

description

Create custom static pages in KMS.

styling

It is best to use Bootstrap css classes in the markup.

custom styling

Use inline styles, or consider using the cssupload Module.

enabled

Enable the Staticpages module.

title

The title of your page to display as the page header

pageSlug

What is the unique semantic slug for your page? (e.g. www.yourvideoportal/<slug>) The unique identifier for the page to be accessed as a URL. For example, if you provide 'privacy' as a slug, you can add links to your static page as [MediaSpace URL]/privacy. You can add these links in Navigation or Headermenu modules or anywhere you want to include links to your pages within the MediaSpace site.

permission

Select the minimum role allowed that can access this page. Set as anonymousRole to keep this page public. Use the “guest override” field to allow anonymous users to access to static pages even if anonymous is turned of in KMS. 

 

content

What is the content of this page? You can use HTML markup and Bootstrap.

[/collapsed]

[collapsed title="Styling"]

Styling

The Styling Module allows you to customize the look and feel of your site. The new style can be created from the linked page, and previewed and shared with other admins before applying the changes to the site.

This module requires the V2ui module to be enabled.

 

Field

Description

enabled

Enable the Styling Module.

fonts

Select +Add"fonts" These fonts will be available in custom CSS and in the Font selectbox on the styling page

familyName

Font family name that will be used in CSS and will be appended to the Font selectbox on the styling page

fallbackFonts

Font families and font types which should be used as a fallback when desired font family is not ready or doesn't exist (comma-separated list, like in CSS specifications).

Specifying generic font type (like serif or monospace) is mandatory.

Example: 'Helvetica Neue',Arial,sans-serif

type

Font assets source type:

  • System font - use world-wide supported font by name

  • Import from URL - use external font service (like Google Fonts)

  • Upload files - upload your own font asset files

isCssApplied

Click Reset to clear. This field indicates wheather a style created in this module is applied on KMS or not.


[/collapsed]

[collapsed title="Thumbnails"]

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)

[/collapsed]

[collapsed title="Userreports"]

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

[/collapsed]

[collapsed title="V2ui"]

V2ui

When you enable the V2ui Module, the new theme/UI for your KMS (or KAF) is applied. The theme is implemented as a set of CSS and JS files. Please note that some KMS features will only be available in the new theme. For additional information and FAQs, see Kaltura MediaSpace New UI - Frequently Asked Questions (FAQ).

Field

Description

enabled

Enable the V2ui Module.

[/collapsed]

In This Article