Kaltura Search Module User Guide

Developed specifically for video to address video’s unique find ability challenges, the Kaltura Media Search searches through all regular, custom and temporal metadata, and adheres to content entitlements.

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.

For Administrative information on the search in KMS and KAF applications see the Kaltura Search Module - Administrator's Guide article.

The following topics provide information about the Kaltura Media Search in KMS and KAF applications:

Types of Search Pages

You can use the Kaltura Media Search in many of the KMS and KAF pages using the magnifying glass.

There are 4 types of search pages available:

Global Search (KMS Only)

The Global Search page may be reached from the top right KMS Header menu magnifying glass. This unified search page contains not only media results, but also results for galleries and channels.

The Global Search display page is configured by your system administrator. You may need to click the magnifying glass to open the search bar, or the search bar may be set to “Always Open” by your administrator.

Closed:

Open:

 

You can also reach the Global Search page directly with the following URL:

https://{your_KMS_URL}/esearch/search?keyword={yourkeyword}

For example:  https://videos.kaltura.com/esearch/search?keyword=tips

 

The Global Search page contains results from:

Media Results 

All media results (video, audio, image, etc.) containing the keywords will be displayed on the Media Results section.

More information may found in the How to Read the Search Results and Search Filters sections.

Channel Results and Gallery Results

On the right side of the page, a side bar appears with MediaSpace Channels and Galleries results.

 

The top 3 results are displayed in the results side bar per channels/galleries, with an indication of the number of channels/galleries found. If there are more than 3 results, you may click on the “Go to Channel/Gallery Results” and be directed to the Channels Search or Galleries Search pages .

 

You can collapse the side bar using the collapse button  and expand it back using the expand button.

Media Search

The search magnifying glass icon is available in the following pages in KMS and KAF:

  1. Global Search
  2. My-Media
  3. Channel/Gallery pages (KMS) & Media Gallery page (KAF)
    You will find the search icon:
    1. When searching for content within each channel & gallery
    2. When adding content to the channel & gallery
    3. When browsing the moderated content (pending tab).
  4. Browse Search & Embed page (KAF’s BSE)
  5. Media page - search in video’s captions if enabled
  6. My History page

For each page: When searching, the media view will be replaced with the search results when a keyword is entered and the display page capabilities remain the same. For example, the Approve and Reject buttons in the Pending tab are displayed for the returned results.

 

Channels Search

To search for a channel, navigate to the “All channels” or “My Channels” pages. You can also reach the Channels’ Search page from the Global Search. See the Global Search section.

Galleries Search

Access to the dedicated page for searching through galleries can only be reached via the Global Search. See the Global Search section, or you may access the Galleries Search page with the following direct link:

https://{your_KMS_URL}/esearch/search-galleries?keyword={yourkeyword}

For example:  https://videos.kaltura.com/esearch/esearch/search-galleries?keyword=tip

 

The Gallery search results will be displayed with the Parent Gallery, Name, Description, and Tags.

How to Read the Media Search Results

When using the search in each page, the media results are displayed as follows:

The Title and Description of the media are displayed next to the thumbnail. If the search keywords are found in either the Title or the Description, the keywords (partial or exact) are displayed highlighted in yellow.

On the thumbnail, a small icon indicates what type of media it is. If no icon is present, it is a video media.

Clicking the media title or thumbnail redirects you to the Media page.

Keyword found in:

If keywords are found in metadata fields other than Title or Description, they are displayed in the “Keyword found in:” section. Each metadata type found is clickable - for example, clicking the ‘2 Chapters’ metadata button will display up to 5 chapters where the keywords are found:

A second click closes the displayed chapters.

When the metadata type is time based, a number will be displayed on the left, indicating the location in the media’s timeline of the keyword. Clicking the time indicator will take you to the video’s page, where the video will start playing from the time indicated.

Show More

Click “Show More” to open all types of metadata and display 5 results of each metadata type.

Available metadata fields:

  • Tags (initial click displays 7)
  • Details –Details are custom fields other than the basic metadata (The initial click displays 10 results)
  • Quiz – Results from quiz Questions and Answers
  • ChaptersSlidesCommentsCaptions

Clicking “Show More” also presents additional information below the video: Owner, Creation date, Published categories, Like, Views, and Comments.

Click “Show Less” to collapse the results.

If more than 5 keywords are found in any of the metadata types, the “Show all” link is displayed. This scenario may happen when searching for a word that re-appears many times in a captions file. “Show All” displays all the results found for this entry.

Search Filters

After clicking the search icon, the search bar opens, where you can enter your keywords or modify them. If Instant Search is enabled by your system administrator, (as you enter characters, results are displayed and there is no need to click Enter.)  any changes in this bar will automatically be reflected in the results below.

In the KMS’s Global Search, the search bar is always open at the top of the page and the number of results found are displayed to the right.

Use the Filters below the search icon to filter, sort, and adjust your search:

Sort By 

You can sort results using the “Sort by” feature.

Available sorts:


    • Relevance
    • Creation Date - Descending
    • Creation Date - Ascending
    • Update Date - Ascending
    • Update Date - Descending
    • Alphabetically - A to Z
    • Alphabetically - Z to A
    • Views
    • Plays
    • Likes
    • Comments

Search In

You can pin point the location of keywords in the search by using the “Search in” feature.

Available “Search in” fields


    • All Fields
    • Details
    • Chapters/Slides
    • Captions
    • Polls
    • Quiz
    • Comments

Filter by

You can enhance your search results by using filters. The following displays the Basic Filters available.

Click the “More Filters” arrows to navigate the filters.

Faceted searchallows you to apply multiple values for filtering. For example, you can search through all video files an all audio files at the same time.

After adding a filter, your selection of filters is displayed below the Filters button. Use the ‘x’ button to remove specific filters or use the ‘Clear All’ button on the bottom right. 


Basic filters availability depends on the page you are searching in. See the table for all basic filters. Advanced filters may be enabled by your admins.

The Media Search Filters List

General Filters

  • Media type – All Media/Video/Quiz/Audio/Image/Webcast Events
  • Ownership – Any Owner/I Own/Media I Can Edit/Media I Can Publish
  • Webcasts – All webcasts/Live Webcasts/Upcoming Webcasts/Recorded Webcasts/Archived Webcasts
  • Scheduling – All Availabilities/Future Scheduling/Available Now/Past Scheduling
  • Duration – Any/00:00-10:00 min/10:00-30:00 min/30:00-60:00 min/Custom
  • Creation Date – Any/Last 7 days/Last 30 days/Custom
  • Last Update Date – Any/Last 7 days/Last 30 days/Custom

My Media Filters:

  • Publish Status – All Statuses/Private/Published/Pending/Rejected/Unlisted

Moderation Filters:

  • Moderation Status – All statuses/Approved/Pending/Rejected

History Filters:

  • Watched at – All History/Completed Watching/Started Watching
  • History – All Time/Last 7 Days/Last 30 Days/Custom

Shared Repository Filter:

  • SR filters – Per custom metadata.

Keywords & Filters Logic

Each filter is added as an AND to other filters, however, each value within each filter is added as an OR to same filters values.

For example, when choosing the following filters:

The logic followed is:

(Type = Video OR Quiz) AND (owner = Media I Own OR Media I Can Edit) AND (Created - Last 7 days)

When using keywords, results are returned based on scoring.

Searching for Keyword1 Keyword2 will first show results that contain both keywords, and lower score results containing only one of the keywords, or partial results, lower on the results lists.

When adding keywords, the filter logic will use “(Keywords) AND (filters)".

Advanced search information can be found in the Advanced Search article

In This Article