Kaltura Search Module - Administrator's Guide

About the KMS/KAF Search Module

Developed specifically for video and to address video’s unique findability challenges, the Kaltura Media Search searches through all regular, custom and temporal metadata, adheres to content entitlements, and allows for ad-hoc queries using the eSearch API.

The Kaltura Media Search utilizes the Elastic Search engine to support data discovery in Kaltura MediaSpace (KMS) and Kaltura Applications Framework (KAF) applications. The search results are unified, meaning that by searching for a keyword, the results from all metadata fields are returned in one symmetry search through all data.

Search results are rendered visually with the search string highlighted for each entry. The search is used for multiple use cases: "classical" full text search, analytics, auto completer, spell checker, alerting engine, and as a general-purpose document store.

In this article you will find best practices in approaching the setup of the Search module. For detailed information on each Search module field,  see the Search module.

For user information on the search in KMS and KAF applications see the following articles:

KMS Search Functionality

KAF Search Functionality

Kaltura Media Search – Administrator's Module

The Search page for KMS and KAF is managed by KMS and KAF system administrators in the Admin area accessed from https://{your_KMS_URL}/admin/config/tab/search. 

Setting the Searchable Items

Start with choosing searchable data on your site by using the eSearch options. You can choose from the following items: Tags, Owner, Reference ID, Captions, Custom Metadata, Webcast items and Media Collaborators. The Kaltura Media Search always searches on the Title and subject of media.

Some of the fields are not accessible from the Search module and require the admin to navigate to the relevant module to set the field’s searchability. These fields are clearly marked with the gray block (e.g. kwebcast).

Other Kaltura Media Search Settings

The following are a few things to consider when setting up the Search module:

  1. Instant Search – Decide if you want the results to populate your display automatically. As you enter characters, results are displayed. If you select yes, we recommend lowering the page size (Use the field under the eSearch configurations), to allow faster results population.
  2. Global Search – The Global Search is relevant to KMS only. This feature is available from the top right KMS header menu. To reach the Global Search, users can click the magnifying glass, and the search bar will open. 
    As an admin you can choose to keep the search bar open to all users. Keep in mind, that the header menu items will be covered permanently, so plan accordingly.

    Set Global Search Bar Closed:

    In this image you can see the ‘All Channels’ and ‘Go-To’ links are displayed in the header menu.  When opening the search bar, they are hidden.

    Keep Global Search Bar Open:

  3. Custom Metadata - A new set of filters other than the basic filters can be set and presented when using custom metadata in KMS or KAF. See the list of Search Filters in the Search For table for a list of the basic filters. Use the “Customdata” module to enable and set new fields.

    After setting the Customdata module, users will be able to filter data according to custom metadata of type Text, List, and Date. Selecting Yes allows the administrator to keep the header menu search bar open at all times.
  4. Setting the Suggested Search Strings - A set of options is available to select the suggested search results to display in KMS or KAF.

    Your selection determines the “recent searches” suggestions to display in the search box.

    The options are :

    Share the “recent search” list

    1. Between all the applications.
    2. Private per KMS.
    3. Fill in a Privacy Context, and the Search suggestions will be shared with apps that have the same Privacy Context.
  5. Add Information Icon - You can add useful tips onto the Search box to indicate to users how to use the search.  In the Search Module  set the showinfo field to Yes. In the infotext field, enter the text to display to users.
    The following is an example of how Info icon is displayed.
In This Article
Was this article helpful?
Thank you for your feedback!