Global Modules: KMS Management Console/KAF Admin

Global Modules

[/collapsed]

[collapsed title="Application"]

Application

Field

Description

instanceId

Unique string to identify that installation of the KMS/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

Not applicable for KAF.

What is your KMS 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

Not applicable for KAF.

What is your KMS footer text?

forceIECompatibilityMode

Not applicable for KAF.

Should MediaSpace force IE to use the latest engine when Compatibility Mode is enabled? By default, if compatibility mode is enabled, Internet Explorer renders the page with IE7's engine. Turning on this option forces Internet Explorer to use the latest rendereing engine. For more details, please visit this link.

theme

Not applicable for KAF.

What is the name of your custom MediaSpace theme?

languageConfiguration

Not applicable for KAF.

Choose your instance configuration. See Localization for KMS/KAF Administrators - How to Change Your Kaltura Application Language?

languageSelection

English - en
















Choose the languages you want to enable for your users. You can edit existing languages and add custom languages using the Languages module.

showLanguageFlag

Select 'Yes' to show the available languages with the flag. Select 'No' to show the first 2 letters representing the language.

language

Choose the default language for a new user. In KMS when your is changing the language from the drop down list on the UI, The language will be saved on a persistent cookie. In KAF based LMS, the language on the Kaltura elements will be set according to the local language set by the user in the LMS settings.

enableLike

Enable the 'Like' feature for entries.

enableWebcam

This is the legacy Webcam configuration. Please use the Recorder module to use the new Webcam capabilities. 

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. 

allowDeletePublished

Enable deletion of published entries.

enableEntryDelete

Enable deleting the media. 

enableViews

Enable showing number of views per entry. 

showPageTitles

Show page titles. 

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 KMS/KAF use to present times and dates?

useUserTimezone

Set to 'Yes' to show webcast and scheduling time in the user's time zone.

assetConsolidationEnabled

Enable assets (js/css) consolidation and minification. 

entryAdditionalInfoProfileId

Enter the Custom Metadata Profile Id for the entry's additional information.

showEmailInUserSuggestions

Show the user's email address in the user suggestions box?

enableLoadButton

When enabling this configuration a 'Load More' button will appear in galleries and channels to allow loading additional entries. This option replaces the endless scrolling mechanism.

weekStartDay

Which day starts the week.

dateFormat

Select how the media date should show to users all over the site.
Note: Format display refers to editing date picker style, which will be displayed as American: mm/dd/yyyy or European: dd/mm/yyyy.
Note: Scheduled entries will also show the weekday, hour, and timezone after the selected date type (e.g. Wednesday, April 11th, 2018 1:15 PM MDT).
uploadDateStyle
Select how the media upload date should show to the users. Choose "x time ago" to show "3 months ago" or "4 days ago".  Choose "On date" to show "On 4/5/2019" depending on the date format that was selected.

[/collapsed]

[collapsed title="Auth"]

Auth

The only relevant field for KAF- LMS configurations in the Auth module is the sslSettings field.

Field

Description

demoMode

Enable the demo login mode? After entering any user or password combination, the user has an admin role

showLogin

Show login / logout menu on site header.

phUser

phPwd

user ID alternate field placeholder

password alternate field placeholder

phLoginInstruction

login instructions

enableMultiAuth

Enable Multi-Authentication Methods configuration. When set to Yes the  multiAuthWelcome  and multiAuthselect Fields are displayed and  a section for each authentication method you choose to configure.

multiAuthWelcome

Enter the welcome text to show on the  login selection page.

multiAuthSelect

Enter the text to show on login selection page.

authmethods

 

method

Choose an authentication methods from the drop-down menu.

friendlyName

Enter the text to show the user on the login selection page, leave empty to use default .

helpText

Enter the ext to show when hovering over the question mark on the login selection page, leave empty to use default

authNAdapter  is displayed when enableMultiauth is set to NO>

What is the name of the PHP class for handling authentication? KalturaAuth enables the built-in User Management system (located at /admin/users). LdapAuth lets you use your organizational LDAP/AD server to authenticate users. To use your own custom class, click 'Add custom value' and enter the custom class name.

authZAdapter is displayed when enableMultiauth is set to NO>

What is the name of the PHP class for handling authorization? Authorization determines the user's role. KalturaAuth enables the built-in User Management system (located at /admin/users). LdapAuth lets you use your organizational LDAP/AD server to determine roles. To use your own custom class, click 'Add custom value' and enter the custom class name.

allowAnonymous

Can users access MediaSpace without logging in? If you select 'yes,' anonymousRole users can browse the galleries and view videos. For anonymousRole users, links/buttons for actions that require more advanced roles are displayed. When an anonymousRole user clicks a link/button that requires a more advanced role, a login screen is displayed.

anonymousGreeting

What text should be used in the header instead of an actual user name?

sessionLifetime

How long can a MediaSpace user session last? The value must be greater than 100 sec in sessionLifetime field.

sslSettings

Select your option for a secure login page (via https).

refreshDetailsOnLogin

Select 'Yes' to update the user's details on Kaltura upon login (recommended).

refreshRoleOnLogin

Select 'Yes' to update the user's role on Kaltura upon login. Select 'No' to allow KMS admin to override the user's role through Kaltura user management.

ldapServer

host

What is the address of your LDAP Server?

port

What is the port of your LDAP Server?

protocol

What protocol does your LDAP server use? (ldap or ldaps)

Protocolversion

What is the protocol version of your LDAP server? (V2 or V3)

basDn

What is the base DN of your LDAP server?

bindMethod

Which mode of operation is used for authenticating with LDAP? 'Search before bind' means that the user's DN is discovered by searching the LDAP/ad server. Direct bind means that the user's DN is constructed automatically according to the format that you specify under userDnFormat (displayed below when you select Direct Bind) and no search is performed.

directBind

 

userDnFormat

Enter the DN format of the username. Place the @@USERNAME@@ token where the username should be in the string. For example: 'cn=@@USERNAME@@,ou=somegroup,dc=example,dc=com')

emailAttribute

What is the name of the attribute on the user record that contains the user ID? If you do not want to sync email with Kaltura, do not enter an emailAttribute.

firstNameAttribute

What is the name of the attribute on the user record that contains the user's first name? If you do not want to sync the first name with Kaltura, do not enter a firstNameAttribute.

lastNameAttribut

What is the name of the attribute on the user record that contains the user's last name? If you do not want to sync the last name with Kaltura, do not enter a lastNameAttribute.

tlsCipherSuite

Advanced: control the value of LDAPTLS_CIPHER_SUITE environment variable. use with extra care!

ldapOptions - Configure the LDAP options for group searches.

groupSearch

 

byUser

memberOfAttribute

Enter the memberOf attribute to use the memberof search filter to map groups to users. Note: The memberof search filter is not enabled by default on all LDAP servers.

userSearchQueryPattern

Enter the pattern for querying the LDAP server to find a user. The @@USERNAME@@ token will be replaced with the actual user name provided in the login window.

primaryGroupIdAttribute

(Optional) Enter the attribute name for the primary group ID (usually primaryGroupId). Use this field only to authorize by primary group ID when you are using AD.

groupsMatchingOrder

Enter the order in which to match MediaSpace roles to LDAP groups. For example, if a user belongs to a group that is mapped to the admin role, enter adminRole before other roles ('adminRole,viewerRole') to find the admin role first and log in the user with the adminRole.

ldapGroups -Map your LDAP server groups to MediaSpace roles. The group value should be the value of the CN part - i.e. 'faculty', not 'CN=faculty'

adminRole

Enter LDAP group names that match the MediaSpace adminRole.

viewerRole

Enter LDAP group names that match the MediaSpace viewerRole.

privateOnlyRole

Enter LDAP group names that match the MediaSpace privateOnlyRole.

unmoderatedAdminRole

Enter LDAP group names that match the MediaSpace unmoderatedAdminRole.

matchByPrimaryGroupId

 

sso

secret

Enter a custom secret, or enter 'default' to use the Kaltura Admin Secret associated with your Kaltura account.

loginUrl

What is the URL for the SSO gateway login page? Note: The 'ref' parameter is added automatically.

logoutUrl

What is the URL to which a user is redirected after logging out of MediaSpace? Usually, you enter your organization's login page.

headerAuth - To configure KMS login through Header Authentication fill in the relevant fields in this section.

headerName

Set the name of the HTTP header that contains the user ID of the authenticated user.

logoutURL

If 'allowAnonymous' value is set to 'No', you can specify a URL (instead of an 'unauthorized' page) to which the user is redirected when logged out.

forgotPassword

link

The 'link' options are: [1] Empty the value if you do not want a 'Forgot Password' link to be displayed. [2] Enter an email address preceded by 'mailto:' (without quotes). The user's local email client opens an email with the subject and body populated with the texts defined in the 'emailSubject' and 'emailBody' fields. [3] Enter a URL for a page that you define (for example, a mechanism for reminding users of their login credentials). Note: Do not enter 'true.'

emailSubject

If you enter an email address in the 'link' field, enter the text to populate the subject field of the email. If you do not want to populate the subject field, enter an empty string (' ').

emailBody

If you enter an email address in the 'link' field, enter the text to populate the body of the email. If you do not want to populate the body, enter an empty string (' '). For KalturaAuth's User Management send new password feature: (If authClass is set to KalturaAuth, MediaSpace exposes a user management system. This system's admin can click on a user's email to open the admin's local email client to email the new password to the user.)

reminderSubject

Enter the text to populate the subject field of the 'new password' email. If you do not want to populate the subject field, enter an empty string (' ').

reminderBody

Enter the text to populate the body of the 'new password' email. The password will be inserted automatically at the end of the body text. If you do not want to populate the body, enter an empty string (' ').
















































































































































[/collapsed]

[collapsed title="Categories"]

Categories

Field

Description

rootCategory

Which root category does MediaSpace use for all categories and content? A root category must be defined in the KMC.

showExternalPublish

Set to Yes to show entry categories from external applications

externalApplications - 

Define which external applications or categories should be displayed to the user for published media

applicationName

Select the display name for this application. Users will see this name in My media

applicationRootCategory

Which root category does application use for all categories and content?

type

choose application type

restricted

Restrict categories to specific roles. Only users with the specified role can view media in the restricted category. Only users with adminRole or unmoderatedAdminRole can add media to the restricted category.

category

Select a category to restrict.

roles

Select one or more roles that can access the restricted category. Use 'Ctrl' to select multiple roles.

[/collapsed]

[collapsed title="Channels"]

Channels

Field

Description

entriesPageSize

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

pageSize

How many channels can be displayed on each channel page? (The default is 20.)

pageCount

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

pagerType

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

defaultChannelType

Not applicable for KAF.

Select the default channel type when creating a new channel.

channelCreatorOpen

Not applicable for KAF.

Select the minimal role that can create Channels.

channelCreatorRestricted

Not applicable for KAF.

Select the minimal role that can create Restricted Channels.

channelCreatorPrivate

Not applicable for KAF.

Select the minimal role that can create Private Channels.

channelCreatorSharedRepository

Not applicable for KAF.

Select the minimal role that can create Shared repositories.

channelCreatorPublic

Not applicable for KAF.

Select the minimal role that can create Public Channels

channelsTermUse

Add channel term of use. Use to configure a policy message that is displayed to users every time a channel is created. The configured text is displayed in the top of the channel creation

supportPublicChannel

Not applicable for KAF.

Set to yes to support creation of channels that anonymous users can access. Note that after you change to 'no' anonymous users won't be able to view your public channels and the option to create public channels will be removed from the create channels page. Note that if you enabled this field then disabled it, the channels/ type would have to be manually reset to a new channel type.

channelsSorting

Use the drop down to select the channels’ sorting default. The options are: Media Count, Alphabetical, Members and Subscribers or Most Recent.

channelDefaultView

Default view for channel page.

[/collapsed]

[collapsed title="Client"]

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.

proxy

Configure proxy settings if the HTTP communication from the MediaSpace server to Kaltura server has to go through a proxy.

hostProxy server hostname or IP
portPort through which the communication with the proxy is going through
usernameOPTIONAL - proxy username if the proxy server requires authentication
passwordOPTIONAL - proxy password if the proxy server requires authentication
typeType of web proxy.

 

[/collapsed]

[collapsed title="Debug"]

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.

  

[/collapsed]

[collapsed title="Gallery"]

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.

playlistDefaultView

This is the default view for playlist page (gallery-like page) that is linked from the homepage.

categoryExplicitDateFormat

Explicit date format.

firstTabLoad

Select the tab you want to load first in categories.

The options are:

Media

Category moderation

Channel categories

The 'firstTabLoad' in the category configuration applies after the search as well.

tableviewAdd table view to My Media page.

 

 [/collapsed]

[collapsed title="Header"]

Header

Field

Description

headerStyle

Which background and matching theme should MediaSpace use for the header?

logoImageUrl

The option to load logo from URL - specify the URL of the logo. If URL is specified it will be used instead of logoImage (above). Default logo size is 325px wide X 41px high. Note: The width of the logo image affects the amount of space available for the Header menu. (See menu configuration below.)

logoImageUpload

An uploaded image will be displayed if the logoImageUrl field (above) is blank. The image will be displayed at its native resolution. Note: the size of the logo image affects the layout of the page. Default logo size is 325px wide x 41px high. (Upload does not support IE 11 or earlier).

logoAltText

The 'logoAltText' options are: [1] If you insert an image file in the 'logoImage' field, you may enter alternate text for the tag's 'alt' attribute; [2] If you enter 'false' or an empty string in the 'logoImage' field, you must enter text for the page header.

logoLink

The options for defining the behavior when a user clicks the logo are: [1] Enter 'false' if you do not want the logo to be clickable; [2] Enter 'home' to display the home page (displayed when MediaSpace opens); [3] Enter a full URL (starting with http://) to open a different page in a new browser window/tab.

enableUploadButton

Enable or Disable the 'Add New' button in the site's header

[/collapsed]

[collapsed title="Languages"]

Languages

Field

Description

DownloadLocaleText

Download a Zip file with all texts for all languages for this instance. These resources can be used to create or update custom languages.

UploadCustomLanguage

Upload new custom language

languageAdminName

Insert the name of the language to be presented in the language drop down list for the admin, in Application section, languageSelection and language fields.

languageClientName

Insert the name of the language to be presented in the language drop down list for the users.

languageCode

For KAF use - formal language code to be used to sync the instance language to the hosting application (LMS, CMS, SBS) chosen language.

localeFile

Upload your customize .mo file. in order to convert your customize .po file to .mo file you can use some available tools in the web

localeIcon

Upload custom language flag icon. In order to be presented to KMS end-users in the drop down list, in case this language will be selected for presentation. Icon should be in "*.jpg;*.jpeg;*.bmp;*.png;*.gif;*.tif;*.tiff;*.ico" format and dimensions should be 30px X 26px (the application will resize any given image, however for best visual result use these dimensions). You can also choose from this library of icons: http://freebiesbug.com/psd-freebies/100-flat-flag-psd-icons/

languageId

Unique language id for application usage.

For additional information see  Localization for KMS/KAF Administrators - How to Change Your Kaltura Application Language?

[/collapsed]

[collapsed title="Metadata"]

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

 

  

[/collapsed]

[collapsed title="Moderation"]

Moderation

This module allows you to make changes to the reasons for moderation text set in the KMC. Please make sure to enable the Moderation plugin in the relevant KMS players via the KMC Studio. See Moderating Content for more information regarding the KMC moderation flow.

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)

 

[/collapsed]

[collapsed title="Navigation"]

Navigation

Use options in this module to add menus to your MediaSpace header.

Field

Description

navigationStyle

Vertical - a hidden vertical menu appears on the left in all resolutions, Horizontal - a horizontal menu appears in desktop resolution and vertical menu appears in lower resolutions.

includeCategories

Select 'No' if you don't want the categories to display in main navigation and only want PRE and POST items to appear

showSearchBoxInHeader

relevant only for horizontal navigation - select 'yes' to show the search box in the header instead of in the navigation pane.

pre

Add items to the beginning of the main menu, before the categories. MediaSpace displays the items in the order you define here. The first 'pre' item must be a 'playlist' type.

type

Select one of the options: Playlist, My Media, My Playlists, Link, Category, Entry Id, or Channels Page

name

Enter the label for the menu item. The label is displayed in the main navigation bar.

value

Enter the menu item's playlist ID or URL.

sameWindow

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

items

Add items that would be displayed in a drop-down menu.

type

Select one of the options: Playlist, My Media, My Playlists, Link, Category, Entry Id, or Channels Page.

name

Enter the label for the menu item. The label is displayed in the main navigation bar.

value

Enter the menu item's playlist ID or URL.

post

Add items to the end of the main menu, after the categories. MediaSpace displays the items in the order you define here.

type

Select one of the options: Playlist, My Media, My Playlists, Link, Category, Entry Id, or Channels Page

name

Enter the label for the menu item. The label is displayed in the main navigation bar.

value

Enter the menu item's playlist ID or URL.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Example: Add the Home Menu to the Header

Configure the options to display the Home Page menu in your KMS header.

To add the Home page link to the header

  1. In the “pre” section, select Link from the type dropdown menu.
  2. Enter an intuitive name for the menu. In this example: Home
  3. Enter “/home” in the value field.
  4. Select Yes for the Home page to open in the same window.
  5. Click Save.

 

 

 

Example: Add the Channels Menu to the Header

Configure the options to display the channels menu in your KMS header. The Channels menu displays all available channels. My channels displays only channels that are created by the user.

To set the vertical navigation menu

  1. In the “post” section, select Channels Page from the “type” drop down menu.
  2. Enter an intuitive name for the menu. In this example: Channels
  3. Click Save.

Example: Configure a vertical navigation layout menu

To set the navigation menus

Vertical

  1. Set the navigationStyle value to vertical.
  2. Click Save.

Horizontal

  1. Set the navigationStyle value to vertical.
  2. Click Save.

[/collapsed]

[collapsed title="Player"]

Player

Kaltura Application Framework  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?

[/collapsed]

[collapsed title="Security"]

Security 

Field

Description

allowLoadInIframe

Allow MediaSpace to be loaded in Iframe. The default is NO for XFS.

loadThumbnailWithKs

The default is set to "no". When enabled, KMS will add a KS (Kaltura Session, read more here) to any thumbnail URL rendered by it, and KMS will pass relevant parameters to the player, to comply with the same requirement.. Switch this field to 'yes' if your account should apply access control rules on thumbnails (this would have to first be set up by Kaltura Customer Care. on the Kaltura Server admin console) and if your access control has KS-restriction.

[/collapsed]

[collapsed title="SharedRepositories"]

Shared Repositories

The SharedRepositories module allows any member to not only browse the media that is published in the shared repository, but also use the media to publish to other channels and/or categories. The shared repository allows education institutions and enterprises to create a shared media location for media that anyone with access to it has publishing rights to other areas in MediaSpace.

Metadata is composed of the following:

  • customDataProfileId
  • nested filters

At least one of these must be defined for the Advanced Search form to display in your MediaSpace instance.
customDataProfileId (schema)  - Create a metadata schema, and select it in the KMS admin sharedRepositories module.

The customDataProfileId selected in the sharedRepositories module MUST be different than the profileId selected in Customdata module.

nested filters - Select "yes" in the  nestedFilters field, to enable the nested filters appearance in KMS and to create the nestedFilters category (if needed).

Nested filters should be created in the KMC. In the KMC Categories tab site > nestedFilters category, add nested categories (up to 2 levels) which will be used as labels on the entry. For example, Create nestedFilters>Science category and nested to it create nestedFilters>Science>Physics and  nestedFilters>Science>Biology. This allows you to tag your entry with the relevant labels. 

Currently, searching for nested filters is only available via the Shared Repository Advanced Search.

Field

Description

enabled

Enable shared repositories.

amountOfSharedRepositories

Amount of shared repositories to show in the drop down (when adding media from shared repository).

termsOfUseLink

Enable Terms of Use

nestedFilters

Enable nested filters. Configure them as nested categories under root>site category in the KMC.

customDataProfileId

Choose custom metadata schema for media in  the shared repository. All custom data schemas can be viewed in KMC > Settings > Custom Data 

requiredFields

Which custom metadata fields are required before publishing media to a shared repository? Use custom data system names from KMC > Settings > Custom Data 

dateFormat

What is the format of the date for the date picker (of the shared repository custom data)?

[/collapsed]

[collapsed title="Widgets"]

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.

keaPlayerId

What is the uiConf ID of the player used by Kaltura Video Editing Tools? leave this field empty to use default.

[/collapsed]

[collapsed title="Search"]

Search

Field

Description

entriesPageSize

How many entries to show in search results.

inVideoPageSize

How many in-entry search results to show.

instantSearch

Select Yes for search results to render instantly. Select No for search results to display after pressing Enter (does not apply to KMS Header search).

eSearch

Configuration only available when the v2UI Module is enabled.

tags

Search in entry Tags.

Owner

Search in entry Owners.

RefId

Search in the entry Reference ID.

kwebcast

Add the options to search in kwebcast fields. See the Kwebcast Module.

mediaCollaboration

 See the mediaCollaboration Module.

pageSize

Display the number of entries to show in the page.

KeepHeaderSearch Open

Choose Yes to keep the global search bar open and stretched in the KMS Header in the web view. Please note that if turned on, the search ar will cover any Header Menu items (fields in the Headermenu Module where linkLocation=Header).

SearchContext

How are search suggestions shared bewteen KMS instances.

Additional information can be found in:

[/collapsed]

[collapsed title="MediaCollaboration"]

Media Collaboration

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

Enable this module to change the media owner and edit collaborators. (co-editors, co-publishers, Webcasting moderators)

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 or Webcasting Moderator and can be set to enable or disable the Co-editor, Co-publisher, or Webcasting Moderator without any dependencies.

allowGroupsCollaboration

Allow groups support in ‘MediaCollaboration’ features.

collaborationEnabledInUploadForm

Enable the option to add collaborators (co-editors, co-publishers, Webcasting moderators) in the upload media form.

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

[/collapsed]

[collapsed title="PlaylistPage"]

Playlist Page

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.

playlistPluginType

Use to choose the look of playlist page. ‘on page’ displays a unique application playlist page . ‘in player’ displays the default  player’s studio playlist look.

[/collapsed]

In This Article