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. 

eSearch 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 search for media tags and have tags returned in the search results. Owner - Set to 'Yes' to search for media owners and return results based on media they own. RefId -  Set to 'Yes' to have media reference IDs searched for and returned in the search results. captions - Set to 'Yes' to have captions searched for and returned in the search results. Please note this feature can be enabled regardless of the captions module status. customMetadata - Navigate to the Customdata module to configure the handling of custom metadata in the search results. kwebcast - Navigate to the Kwebcast module to configure which kwebcast fields will be 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. 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.

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.