Global Settings

About

This module allows you to manage the overall settings of your application and customize the features displayed in your environment. Here you can set the title of the application and adjust various entry-related features such as enabling likes, restricting editing and deleting entries, setting the default language, and configuring other display options.

Configure

Go to your Configuration Management console. The Application module opens by default. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/application.

In the Application window, configure the following:

Preset fields

These values are set during installation and are read only.

instanceId - This is the unique string to identify an installation of Kaltura's Video Portal (aka MediaSpace). Can be used to differentiate the instance in the KMC analytics. 

privacyContext - This string is used to set as the privacy context on root category. The video portal root category must also be set with this value. 

userRoleProfile - This is the Metadata Profile ID for the user's role per video portal installation instance. 

virtualEventID - This is the event ID for this site, used for analytics and is a prerequisite for the Application Registry feature set (see below) and more. If empty, some instances may have a Generate Event ID button which you need to click to to enable it.  

Application Registry 

Use the applicationRegistry to subscribe an application to various microservices, primarily Authbroker, but also others.

mainSiteAlias - Set the main site domain to be used in the Application Registry and AuthBroker modules (hostname only, no protocol, for example, “videos.kaltura.com“). Value should be completed automatically by the Event Platform Manager (EPM).

appRegistrationID - This is the application registry ID - a prerequisite for the Application Registry feature set (such as AuthBroker). If empty, some instances may have a Register App button which you need to click to to enable it.  

userProfile - This field indicates the use of the User Profile for registration. Application must be registered in order to use this field. The default value is "1" , and only a Kaltura administrator is authorized to modify it.

Set the title of the application

title - Enter the title of your site. This title is displayed in the browser's title bar and is usually displayed in search engine results. Page titles consist of the name of the currently loaded media and the site title, for example, if a page features a video named 'My Video' and 'MediaSpace' is the site title, the page title would be 'My Video - MediaSpace'.

Set the site's footer

footer - Enter the footer text. The default is 'MediaSpace video portal by Kaltura'.

Add JavaScript (JS) to your pages

The following fields may be used to insert JS on all video portal (non-admin) pages, either by adding the JS directly in the app admin, or using a link to a hosted JS file. Do not use these fields if you are unfamiliar with the JS inserted. 

headerJS - Enter any JS to be run on all video portal headers. Don't use if you're not familiar with the JS inserted. Will not work on admin pages.

headerJSlinks - Enter links to JS files to be loaded on all video portal headers. Do not use if you are not familiar with the JS inserted. Will not work on admin pages. 

1. Click +Add "headerJSlinks".
2. url -  Enter the full URL for the JS file (for example: https://myfiles.com/files/my.js).
   

bodyJS - Enter any JS to be run at the bottom of all video portal pages. Don't use this field if you're unfamiliar with the JS inserted. This field is not applicable to admin pages.

Set compatibility mode

forceIECompatibilityMode  - Set to 'Yes' if you want Internet Explorer to use the latest rendering engine even when Compatibility Mode is on. By default, when Compatibility Mode is on, Internet Explorer uses IE7's engine to render pages. Turning on this option makes Internet Explorer use the latest rendering engine instead. For more details, please visit the link.

Add a theme

theme - This field is only left for backward compatibility. Keep the value default if you are a new admin. If your instance is configured with the Theming Design System, please see the Theming module.

Set the UI language(s)

languageConfiguration - Choose your instance configuration. Use this field to enable users to choose a different language or multiple languages for their user interface.  All information entered manually, such as category names, entry names are not changed. 

To enable a single language, select Single Language Instance and choose the language from the language drop-down menu.

To enable multiple languages, select Multi Language Instance and choose the different languages you want to enable from the languageSelection menu.

languageSelection - Click the boxes next to the languages you want to display on the user interface.

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

language - Select the default language for new users. In the video portal, when users change the language from the dropdown menu, it will be saved on a persistent cookie. In KAF-based LMS, the language on Kaltura elements will match the language set by the user in the LMS settings.

Enable "Likes" and displaying entry titles in the URL

enableLike - Set to 'Yes' to enable the 'Like' feature for entries.

enableEntryTitles - Set to 'Yes' to include the media title in the URL of the media page when browsing the site and sharing a link to the media.

Restrict editing or deleting published entries

If you're worried about accidental deletions or edits to published content, you can restrict these actions. Simply set the corresponding fields to "No" and save. This disables the Edit and Delete icons for published content.

allowEditPublished  -  Set to 'Yes' to enable editing of published entries.

allowDeletePublished - Set to 'Yes' to enable deletion of published entries.

enableEntryDelete - Set to 'Yes' to enable deleting media from your video portal. 

Configure display options

enableViews - Set to 'Yes' to enable displaying the number of views per entry. 

showPageTitles - Set to 'Yes' to display the page titles. Note that this feature applies only to specific pages and will not function on Theming pages.

showCreatedByIndicator - Set to 'Yes' to show the ‘Created By’ indication on the media page and in the global search.

enableUnlisted - Set to 'Yes' to enable setting entries as unlisted. An unlisted entry may be viewed by anyone with the link to the entry page but will not appear in any search results.

timezone - Choose which timezone your video portal should use to present times and dates. 

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

Configure additional display options

assetConsolidationEnabled - Enable assets (js/css) consolidation and minification. Setting this field to 'Yes' will provide a faster load of the pages. Set to 'No' when looking to validate and investigate through the site's JS and CSS.

showEmailInUserSuggestions -  Set to 'Yes' to show the user's email address in the user suggestions box when searching for users.

enableLoadButton - When you enable this setting, a 'Load More' button will show up on list pages (like channels, galleries, My media, etc.) after displaying the initial set of results. This feature allows more entries to load instead of endless scrolling. Please note that this applies only to specific pages and will not work on theming pages, as they are configured with pagination.

Set the user management window display

extraUserInfoRow - Choose what column to show on the user management table.

• Show extra info  - displays the Extra Data column in the User Management window
• Show Registration Status - displays the Registration column in the User Management window

Cookies

usePartitionedCookies - Enable Partitioned Cookies (AKA CHIPS) on the instance. Note that partitioned cookies will automatically be enabled for KAF instances using Kaltura domain. Please see our article Preparing for Third-party Cookie Restrictions for more information.

partitionedCookiesAlert - After enabling or disabling partitioned cookies in KMS, some users may have trouble logging in because of duplicate cookies. To solve this, they'll need to clear their browser's cookies. You can set up an alert on the login page using the partitionedCookiesAlert field.

Suggested text: Due to a recent security change in the site's cookie policy, login might fail. To resolve the issue, clear the browser's cookies and try again. If the issue persists, contact the site admin.

The text will appear on the video portal login screen, as shown in the example below:

ssoDomains

Click +Add "ssoDomains" and enter the email domains for SSO users. SSO users are instructed to login using the SSO authentication method, and are not allowed to:

• Login through Kaltura login
• Register in the external registration form
• Use the forgot password flow

Supported formats: xxx.yyy or xxx.yyy.zzz (for example, “domain.com” or “sub.domain.com”) 

Click Save.

About

The Auth module manages user logins for the video portal. By default, it uses Kaltura Authentication. Please note:

• To switch to SAML authentication, check out the SAML module.
• For multiple authentication methods, use the 'enableMultiAuth' setting.
• To help users change their login method after selecting "Remember My Selection," they can visit: https://<partnerId>.mediaspace.kaltura.com/user/clear-login-selection or clear their browser cookies."

Configure

Go to your Configuration Management console, and navigate to the Auth module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/auth.

In the Auth module window, configure the following:

demoMode - Set to 'Yes' if you want to enable the demo login mode. After entering any user or password combination, the user has an admin role.

showLogin - Set to 'Yes' if you want to show login / logout menu on site header.

phUser - user ID alternate field placeholder

phPwd - password alternate field placeholder

phLoginInstruction - login instructions

enableMultiAuth 

enableMultiAuth set to 'No'

enableMultiAuth - Enable Multi-Authentication Methods configuration. If you leave the setting on 'No', complete the authNAdapter and authZAdapter fields below. If you select 'Yes', skip to the next section.

authNAdapter - 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, enter the custom class name, then click 'Add custom value'.

The value is added to the menu.

authZAdapter - 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, enter the custom class name, then click 'Add custom value'.

The value is added to the menu.

enableMultiAuth set to 'Yes'

enableMultiAuth - If you select 'Yes', a new section displays with multiAuthWelcome and multiAuthselect' fields, and a section for each authentication method you choose to configure.

multiAuthWelcome - Enter welcome text to show on login selection page.

multiAuthSelect - Enter the text to show on login selection page.

authMethods 

Click +Add "authMethods".

A new section displays.

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 - Set how long (in seconds) a MediaSpace user session can last. If set value is lower than the minimum of 3600 seconds (1h), the minimum wil be utilized.

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

Click Expand to display the LDAP server options.

ldapOptions

Click Expand to display the LDAP Options for group searches.

ldapGroups

Click Expand to 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'

SSO

Click Expand to configure the video portal login through SSO gateway.

headerAuth

Click Expand to configure KMS login through Header Authentication.

forgotPassword

Click Expand to define the values for the Forgot Password options.

adminsGroup - Enter a group ID to which any KMC or EP users will be added upon login to the site.

Click Save.

The AddNew module is used to add the +Create button located at the top right of the navigation bar. The +Create drop-down menu and its contents are configured in this module.

Configure

Who can see the +Create button?

The buttonDisplay field is used to configure whether to show or hide the +Create button for anonymous users. 

Sections

The +Create menu is split into three sections and allows you to promote tools to the top of the menu. Admins may select to promote the most used creation tools/apps to the top of the menu. You can also choose to have all the tools in one section if that works for you.

Use the section to control what tools to show in the dropdown menu, and in which section. To place the most-used tools in the first section, check the boxes next to each one.

The following configuration displays the default placement in which the Upload, Town Hall, Meeting Room, and Express Capture applications are placed at the top of the menu.

To add additional tools under the heading Other Creation Tools, check the boxes in the second section.

To add additional tools under the heading Collections, check the boxes in the second section. 

Modules

This section lists the available application modules available for adding to the +Create menu. You can configure the items you want in your menu by clicking on the configure option next to the module, and this will take you directly to the configuration window of that module.

The result is as follows:

About

The Channels module is used to set up channels, configure roles and permissions for creating channels, and set the channel page display, sorting settings, and other configurations. To learn more about MediaSpace channels, check out our article Understanding channels.

Configure

1. Navigate to Channels in the admin console under Global settings.

2. Configure the following settings:

entriesPageSize - Enter the number of entries to display on each channel page (the default is 15).

pageSize - Enter how many channels to display on the channel page (the default is 20).

The settings below apply for the channel types and user permissions, see Kaltura MediaSpace Channels and Permissions Planning Guide for more information.

defaultChannelType - Select the default channel type when creating a new channel: 

• Open
• Restricted
• Private
• Shared repository
• Public
• PublicOpen

channelCreatorOpen - Select the minimal role that can create Open Channels:

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelCreatorRestricted  - Select the minimal role that can create Restricted Channels: 

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelCreatorPrivate - Select the minimal role that can create Private Channels: 

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelCreatorSharedRepository -  Select the minimal role that can create Shared Repositories: 

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelCreatorPublic - Select the minimal role that can create "Public, Restricted" Channels: 

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelCreatorPublicOpen - Select the minimal role that can create "Public, Open" Channels: 

• No role - System admin only
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

channelsTermUse -  Enter the 'Terms of Use' text that describes a general agreement or policy that is displayed to users every time a channel is created. The text is displayed at the top of the 'Create a New Channel' screen. 

supportPublicChannel - Set to 'Yes' to support the creation of channels that anonymous users will have access to. Contribution is allowed for logged-in users only according to their publishing entitlements. If set 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 a New Channel' page. 

channelsSorting - Use the drop-down menu to select the channels’ sorting default: Creation Date, Alphabetically A to Z, Alphabetically Z to A, Members, and Subscribers, Media Count, Update Date.

channelDefaultView - Select the default view for the channel page: Grid, Collapsed View,  Detailed View, or Table.

allChannelsPageDisplay - Select the minimal role that can view the All Channels Page:

• Anonymous role
• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

myChannelsPageDisplay -  Select the minimal role that can view the My Channels Page:

• Viewer role 
• Private only role
• Admin role
• Unmoderated admin role
• Specific users / groups

3. Click Save.

Ready to try it yourself? Go to Create a Channel.

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.

You can set the severity level of the messages to control the type of messages displayed on the console, as follows:

About

Use this module to set up email templates to be sent out to users. 

• Be certain that you do not have Access Control Profiles setup for any specific domains.
• There are four types of mail templates used for KMS registration:
  • registrationEmailTemplates (verification mail)
  • confirmationEmailTemplates (confirmation mail)
  • passwordEmailTemplates (reset password mail)
  • passwordConfirmEmailTemplates (password updated successfully)
• Each template has the following configurations:
  • languageCode - for events supporting multiple languages. You may  configure a mail template per local.
  • subject - the subject that will be displayed in the mail
  • template - the body of the mail in HTML
• All mails support the following tokens: {FIRSTNAME} {LASTNAME} {COMPANY} {COUNTRY} {EMAIL} {URL}
• You can add a template per local code by clicking +addRegistrationTemplate.

Configure

emailFrom - Enter the email sender.

+addRegistrationTemplate. Click to add a template per local code. Configuring this section adds localized versions of a specific email template. 

templateName - Enter a template name that will be used to identify the template. For example: Confirm Registration and Set Password.

localizedTemplate - Templates for a specific locales. When no locale fits - the template for En (English) is used. 

languageCode - The template language code. The default is En (English), and is used when no other selection fits. 

subject - The email subject. For example Email confirmation and set password.

body - The email body. Supported tokens - {FIRSTNAME} {LASTNAME} {TITLE} {COMPANY} {COUNTRY} {EMAIL} {URL} 

Galleries define the taxonomy and hierarchical structure of your Kaltura MediaSpace site (KMS). Galleries are first created by the administrator via KMC and then accessed through the MediaSpace navigation header. The Gallery module can be configured as follows:

1. Navigate to Gallery in the admin console under Global settings.
   
2. Configure the following settings:
   pageSize - How many entries should be loaded onto the display for the initial gallery page. (The default is 16, max is 150). You may scroll down to view all of the entries.
   pageSizeWide - How many entries can be displayed on each gallery page in the Wide gallery view, e.g., search results, playlists (the default is 24).
   sortMediaBy - Set the default media sort for all categories: Channels, Galleries in KMS, and Media Galleries in KAF Applications. 
   globalSearchSortMediaBy - By default, how media in the global search should be sorted.
   
   thumbnailRotator - Enable thumbnail image rotation on mouseover in galleries.
   categoryDefaultView - Default view for categories. Select from Grid, Collapsed View or Detailed View.
   The example below shows Detailed view.
   playlistDefaultView - This is the default view for playlist page (gallery-like page) that is linked from the Homepage. Select from Grid, Collapsed View or Detailed View. The example below shows Collapsed view.

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

About

Use this module to configure the page UI, texts, and logo. You may also set a call to action section on the login screen using the showCallToAction field.  See Call to Action feature.

Related modules

• Theming
• Auth

Configuration fields

Page header 

The following fields define the header display for the login page:

headerText  -  Enter text that is displayed at the top of the page, next to the logo. 

headerBannerDefaultImg -  Use to upload an image to display as the background of the login page's header. Since the image will be cut according to page size, is it recommended to upload an atmospheric image the size of around 1600x400 pixels. Leave empty to use the default blue.   

showLanguageSelector  Use to present the language selector (assuming it is available on the site), set to 'Yes'.

customLogo - use to set a different logo on this page from the site's logo.

Page texts

Title - Use to change the main title of the login page. leave empty to use default

• Login instructions and field placeholders can be added/set from the Auth module, using the phLoginInstruction, phUser, and phPwd fields. 

Multi Authentication

The multi authentication page will automatically be updated to the new UI. The settings will remain the same and may be re-configured from the Auth module)

Call to Action feature

You may add a call to action on the login page using the showCallToAction fields. Set the showCallToAction field to Yes, to open the CallToAction section.

Fill in the configuration as you please to show a call to action button on the login page:

This module enhances the collaborative potential of Kaltura MediaSpace. You can add any users or group you want as collaborators, enabling everyone to work together seamlessly on media projects.

Configure

1. Go to your KMS or KAF admin page, and navigate to the MediaCollaboration module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/mediaCollaboration.

2. In the MediaCollaboration window, configure the following:

mediaCollaborationEnabled - Set to 'Yes". Enabling this feature also allows the media owner to be changed, and co-editors, co-publishers, co-viewers and Webcasting moderators to be edited. 

changeOwnerEnabled - (This field is only available when the MediaCollaboration module is enabled.) The 'change media owner' feature (as shown below)  provides the ability to change the owner of the media. 

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

showInSearch - Set to 'Yes' to enable filtering by ownership and collaboration.

excludeGroups - Enter the group or user IDs, separated by commas, to hide from the 'Add a Collaborator' and 'Change Media Owner' search (as shown below). This means that those users and groups will be excluded from the search options; all others can be found.

3. Click Save.

User experience

After enabling the module, a Collaboration tab displays on the Edit media page:

Users can Change Media Owner:

Users can Add a Collaborator:

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.

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. 

Site navigation is the way visitors move through your site's pages and content. The navigation bar generally displays the pages and sections on your site that your visitors can click on and be redirected to. 

Let's start!

Configure

1. Login to your Video Portal Admin Console, at https://[your_partner_id].mediaspace.kaltura.com/admin. 
2. Select Navigation from the Global settings.

The Navigation module displays. 

3. Configure the desired navigation style.

• showNavigation - The default is already set to Yes.
• navigationStyle - Choose whether you want a horizontal or verticle header. Vertical means that a hidden vertical menu appears on the left in all resolutions (see image below). Horizontal means that a horizontal menu appears at the top in desktop resolution and vertical menu appears in lower resolutions  (see image above).
• showNavbarSearch - The default is Yes. Choose No if you don't want to have a search box in the header
• includeCategories - The default is Yes. Select No if you don't want the categories to display in the main navigation and only want PRE and POST items to appear.

4. Configure the desired navigation items.

Pre menu

Next is the Pre section. This is where you'll add items to the beginning of the menu and before the categories. Your Video Portal displays the items in the order you define here.

Example of the Home tab configured first in the navigation bar.

• Type - Select one of the options: 
• name - Enter the name of the menu item. The name is displayed in the main navigation bar.  
• value - Enter the menu item's playlist ID or URL. (backslash will direct to the homepage)
• sameWindow  The default is No. Select Yes if you want the page to open in the same window.

If you choose to have a drop-down, you can add items to your drop-down menu by clicking . Example of the "Sailing School" channel set as a first item

• type - Select one of the options.  
• name - Enter the name of the menu item. The name is displayed in the main navigation bar.  
• value - Enter the menu item's playlist ID or URL.
• sameWindow  The default is No. Select Yes if you want the page to open in the same window.

Continue with this process if you want to add more items.

• allowedGroups - choose the group that should see this item. A user who's not in that group won't see this page in their navigation menu.

To create the next pre element, click and repeated the previous steps.

Post menu

Next is the Post section. This is where you'll add items that come after the categories. Your Video Portal displays the items in the order you define here.

Example of the Channels page as the main link and the "Survival skills" channel as the first item in the drop-down.

• Type - Select one of the options: 
• name - Enter the name of the menu item. The name is displayed in the main navigation bar.  
• value - Enter the menu item's playlist ID or URL. (backslash will direct to the homepage)

If you choose to have a drop-down, you can add items to your drop-down menu by clicking . 

• type - Select one of the options.  
• name - Enter the name of the menu item. The name is displayed in the main navigation bar.  
• value - Enter the menu item's playlist ID or URL.
• sameWindow  The default is No. Select Yes if you want the page to open in the same window.

Continue with this process if you want to add more items.

• allowedGroups - choose the group that should see this item. A user who's not in that group won't see this page in their navigation menu.

To create the next post element, click and repeated the previous steps.

5. When you have finished your configuration, scroll down and click Save.

User experience

Example of vertical navigation

Example of horizontal navigation

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

About

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.

Configure 

1. Go to your KMS or KAF admin page, and navigate to the PlaylistPage module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/playlistPage.
   The PlaylistPage window displays.
   playerID - The playerId field should already be populated. To change the playerId, see The Kaltura Player Getting Started Guide.
2. Thumblink - Choose how you'd like the thumbnail link to behave:
   • Redirect to Playlist Player - This will redirect the user to a dedicated playlist page with the player pointing to the selected media.
   • Redirect to Single Media page - This will take the user to the single media page, without the context of the playlist.
     

     Please note that this applies to manual playlists only. For dynamic playlists configured in the Templatepages module, such as "Most recent" or "Most viewed", (excluding "Custom playlist"), clicking on the thumbnail will exclusively direct you to the entry page and not the playlist page.

3. Click Save.

Example of playlist with Thumblink set to Redirect to Playlist player:

Example of playlist with Thumblink set to Redirect to single media page:

About

The Search module unlocks your vast video library, offering convenient access through both the header bar and the dedicated global search page. Optimized for video content, it provides accurate and efficient search capabilities.

Key features

• Tailored for video: Understands video-specific metadata for relevant results. 
• Comprehensive search: Covers regular, custom, and temporal metadata.
• Complete access: Search your entire library, including private and niche content.
• Fine-grained control: eSearch API empowers advanced query construction.
• Elasticsearch integration: Delivers seamless and unified search results across all data fields.

Search options

• Instant header search: Quickly find specific videos using keywords on any page.
• Deep dive with global search: Explore the entire library, browse categories, and refine your search.

Specially for Theming users!

• Customized homepage: Transform the search page into your site's entry portal. Customize the title and description to reflect your site's identity or brand, and create a unique starting point for your users' adventures. 

These instructions will help you choose the right tools for your use case. Let's get started.

Enable the module

1. Go to your KMS Configuration Management console, and navigate to the Search module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/search.

2. In the Search window, you can set up the non-Theming-based or Theming-based search function.

Configure non-theming-based search 

If you don't have the Theming feature set enabled, this section is for you.

1. Configure the eSearch section:

eSearch In this section, you can choose searchable data on your site by using the eSearch options (matches in the title and subject of media are always included). tags - Set to 'Yes' to have media tags returned in the search results. Owner -  Set to 'Yes' to have media owners returned in the search results. RefId -  Set to 'Yes' to have media reference IDs returned in the search results. captions - Set to 'Yes' to have captions returned in the search results. Please note that this feature can be enabled regardless of the captions module status. customMetadata - Navigate to the Customdata module to have media custom metadata returned in the search results. kwebcast - Navigate to the Kwebcast module to have kwebcast fields returned in the search results. mediaCollaboration - Navigate to the MediaCollaboration module to enable the ownership filter.  pageSize - Select how many search results to display per page. Remember, higher numbers may slow down page loading. We suggest a page size of 30 results for best performance. KeepHeaderSearchOpen - Set to 'Yes' to keep the global search bar constantly expanded in the web view. Accessible from the top right header menu, users can open the Global Search by clicking the magnifying glass icon. Note that the search bar will cover any header menu items. 'KeepHeaderSearchOpen' set to 'No' (you can see the ‘All Channels’ and ‘Go-To’ links displayed in the header menu) 'KeepHeaderSearchOpen' set to 'Yes' (the ‘All Channels’ and ‘Go-To’ links are hidden)  SearchContext - Choose how search suggestions are shared between KMS instances. Suggestions are shared between all KMS video portal instances.  Suggestions are private per KMS video portal instance.  Suggestions are shared between KMS video portal instances having the same search context below: An additional field will open named CustomSearchContext - Fill in the "CustomSearchContext" field with a privacy context. This allows search suggestions to be shared with apps having the same context. For example, if you have many video portal sites and want suggestions shared between two, type in a context like 'MediaSpace Travel' in the Search module's CustomSearchContext of those two. This links the sites, enabling shared suggestions. Your SearchContext selection determines the 'recent searches' suggestions that will display in the search box.

2. Configure the remaining settings as follows:

showMediaSearch - Choose to display or hide the on-page media search.

inVideoPageSize - Choose the number of results to show in the media entry page’s timeline tab ‘search in media’ feature (for example, 5).

instantSearch  - Choose whether search results on the global search page should appear instantly or only after pressing Enter. We recommend lowering the page size to allow faster results population. 

showinfo - Select 'Yes' to provide an information icon  next to the search field. 

infotext - This text will show as a tool tip when hovering over the information icon. If left empty, the following default text will be used: To search for an exact match, please use Quotation Marks. Example: "computer"

3. Click Save.

Configure theming-based search 

If you have the Theming feature set enabled on your site, this is the section for you. Just make sure to set the globalsearch configuration to 'Yes', found under the Features section of the Theming module.

allContentText - This section is specifically for using the search page as a landing page. Check it out below if you're interested!

Configure the remaining settings as follows:

GalleryResults - Choose to display or hide the gallery results on the global search page. 

ChannelResults - Choose to display or hide the channel results on the global search page. 

Filters

Choose which filters to display on the search filters. This will affect search in all locations.

MediaType - Provides the ability to filter content by type, such as video, image, audio, and more.

Webcasts - Provides the ability to filter live content by its scheduling time.

Captions - Provides the ability to filter content with or without captions.

Duration - Provides the ability to filter content by duration of the media.

CreationDate - Provides the ability to filter content by creation date of the media.

LastUpdateDate - Provides the ability to filter content by the last update date of the media.

Ownership - Configured from the mediaCollaboration module.

PublishStatus - Provides the ability to filter content by its publishing status. Available for the My Media page only.

Scheduling - Provides the ability to filter content by its scheduling status. Available for the My Media page only.

To control customized filters, please visit the customData module.

Below is an example of a Theming-based global search page:

Set up as homepage

allContentText - Enter the text you want to display at the top of the page (HTML markup is supported). 

Next, you'll need to set up the page in the Navigation module pre-menu. This ensures users land on it first when logging in.

Below is an example of a global search page that also serves as a homepage (Theming):

To activate the global search page, make sure to set the globalsearch configuration to 'Yes',  found under the Features section of the Theming module.

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.

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. 

The application has 3 date formats, used in different locations and chosen according to the context and the space available.  Leave the fields empty, to use system defaults:

1. Long (e.g: Saturday, June 12, 2021)
2. Short (e.g: June 12, 2021)
3. Long with no year (e.g: Saturday, June 12).

Each of the formats is used in different pages/locations in the application. To find a list of locations, please see the Setting the Date and Time Format Display article.

Admins may apply different date format for different languages, using the mapping below. This is useful for languages such as Japanese, where the date standard requires special characters.

To build your own date format, choose from the following tokens:

• YYYY: 4-digit year '2019'
• YY: 2-digit year '19'
• MMMM: Full-length month 'June'
• MMM: 3 character month 'Jun'
• MM: Month of the year, zero-padded '06'
• M: Month of the year '6'
• dddd: Day of the week 'Sunday'
• DD: Day of the month, zero-padded '01'
• D: Day of the month '1'
• Do: Day of the month with numeric ordinal contraction '1st'

Here's some common date formats and how to express them using tokens:

• To show '2019-06-01' use: YYYY-MM-DD
• To show 'June 1st, 2019': MMMM Do, YYYY
• To show 'The 1st of June' use: [The] Do [of] MMMM
• To show '6/1/2019' use: M/D/YYYY
• To show '2020年 5月11日 火曜日' use: YYYY[年] MM[月] DD[日] dddd

Below you will find the list of fields available in the module:

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

You can easily control whether you want to show or hide media thumbnails on session cards by using the widget module. These session cards appear on Theming-based pages such as the channel page, profile page, and agenda page.

1. Go to your Video Portal admin page and navigate to the Widgets module. Your link should look like this: https://{your_video portal_URL}/admin/config/tab/widgets.
   
2. Choose whether you want the thumbnail to be visible or hidden.
   
3. Click Save.

The image below shows a session card with its thumbnail set to visible:

Session card with thumbnail set to hidden:

For more information about session cards, visit our article Session card.