Field | Description |
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 |
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 | |
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? |
Not applicable for KAF. Choose your instance configuration. See Localization for KMS/KAF Administrators - How to Change Your Kaltura Application Language? | |
languageSelection | Choose the languages you want to enable for your users. You can edit existing languages and add custom languages using the Languages module. |
Select 'Yes' to show the available languages with the flag. Select 'No' to show the first 2 letters representing the 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. |
Which timezone should KMS/KAF use to present times and dates? | |
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. |
| 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. |
| extraUserInfoRow | Choose what column to show on the user management table. |
| timeDisplay | Choose how to show time in the application. The coices are 24 hours or am/pm. |
The Auth module controls the way users login to KMS. The default login is set to Kaltura Authentication. To enable SAML authentication, please refer to the SAML module. To enable the multiple types of authentication methods, use the 'enableMultiAuth' field. To assist end users that have checked “Remember My Selection” and would like to change their login method, ask them to navigate to the following URL: https://<partnerId>.mediaspace.kaltura.com/user/clear-login-selection or have them clear their browser’s cookies.
The Channels module is used to configure roles and permissions for creating channels. This module is also used to set the channel page display, sorting settings and other configurations for channels.
Field | Description |
serviceUrl | The URL of the service for API calls. Modify the URL if you use the Kaltura On-Prem Edition. Note the URL's prefix must be http:// or https://. |
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. |
| analyticsServiceUrl | The Analytics server URL. Used for Reports. 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 Kaltura uses your user secret to create secure sessions to access the Kaltura API. |
verifySSL | Set to No, if you want to use SSL with a self-signed certificate. |
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) |
The Debug feature provides a way to record event logs and debug messages on a remote device, such as the Kaltura server (in SaaS) or the On-Premises server. By default, the Debug log Level is enabled to allow a higher level of event log messages to send to an external device for debugging purposes.
The Kaltura SaaS server logs are only accessible by Kaltura's third level support and development engineers.
You can set the severity level of the messages to control the type of messages displayed on the console, as follows:
| Log Level Keyword | Level | Description |
| ALERT | 1 | System unstable |
| CRIT | 2 | Critical conditions |
| ERR | 3 | Error conditions |
| WARN | 4 | Warning conditions |
| NOTICE | 5 | Notification conditions |
| INFO | 6 | Informational messages only |
| DEBUG | 7 | Debugging messages |
| DUMP | 8 | Core dumps |
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. |
| tableview | Add table view to My Media page. |
Field | Description |
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.) |
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 |
For additional information see Localization for KMS/KAF Administrators - How to Change Your Kaltura Application Language?
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 |
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 LMS users can choose for flagging media. (If none are provided, the default Kaltura reasons will be used) |
reasonViolence | Please provide the reasons LMS users can choose for flagging media. (If none are provided, the default Kaltura reasons will be used) |
reasonHarmful | Please provide the reason 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.) |
Use this module to select which columns to display for the My Media table view.
The table view is displayed when selecting the Table View icon on your My Media Page. 
Field | Description |
| Select what columns to show on the table view. Please consider columns width when choosing many columns. | |
initialView | Select which view to load first. |
Use options in this module to add menus to your MediaSpace header. For more information see Setting the Home Page - Kaltura MediaSpace.
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
- In the “pre” section, select Link from the type dropdown menu.
- Enter an intuitive name for the menu. In this example: Home
- Enter “/home” in the value field.
- Select Yes for the Home page to open in the same window.
- 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
- In the “post” section, select Channels Page from the “type” drop down menu.
- Enter an intuitive name for the menu. In this example: Channels
- Click Save.
Example: Configure a vertical navigation layout menu
To set the navigation menus
Vertical
- Set the navigationStyle value to vertical.
- Click Save.
Horizontal
- Set the navigationStyle value to vertical.
- Click Save.
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:
|
| playerModerationId | What is the player ID (uiConf ID) of the player shown in moderation pages? |
Field | Description |
Allow MediaSpace to be loaded in Iframe. The default is NO for XFS. | |
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. |
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 |
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)? |
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. |
What is the uiConf ID of the player used by Kaltura Video Editing Tools? leave this field empty to use default. |
The Search Module is used to configure the Search page results and display.
For more information see:
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). |
| showinfo | Set to ‘Show’ to provide an information icon next to the search field. |
| infotext | This text will show on the information icon next to the search field. If left empty, the following default text will be used: "To search for an exact match, please use Quotation Marks. Example: "computer". |
tags | Search in entry Tags. |
Owner | Search in entry Owners. |
RefId | Search in the entry Reference ID. |
| captions | Select 'Yes' to have captions returned in the search results. Please note that this feature can be enabled regardless of the Captions module status. |
| customtMetadata | Navigate to the Customdata module to have media custom metadata returned in the search results. |
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. |
KeepHeaderSearchOpen | 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 between KMS instances. |
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. |
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.
This module controls the visibility of Playlists.
- To enable the Channel Playlist functionality - navigate to the Channelplaylists module.
- To enable the ability to add content to personal playlists - navigate to the Addtoplaylists module.
- To enable the ability for users to grab embed codes of playlists - navigate to the Embedplaylist module.
| Field | Description |
playerId | Enter the playlist player ID (uiConf ID) for playlists dedicated view page |
The Playlist 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. |
Use this module to change the default format for date representation in the application. You can change the default date formats for any of the site’s languages. To find a list of locations, please see the Setting the Date and Time Format Display article.
| Field | Description |
|---|---|
| timeDisplay | Choose how to show the time in the application. |
| AddLanguageDates | Click to open the date representation for a specific language configuration. |
| Language | |
| longDate | Full date including the day of the week. e.g: Saturday, June 12, 2021. |
| shortDate | Date not including the day of the week. e.g: June 12, 2021. |
| longDateNoYear | Date including the day of the week, but no year. e.g: Saturday, June 12. |
For additional information see Localization for KMS/KAF Administrators - How to Change Your Kaltura Application Language?
