Skip to main content

IndexSearch

Overview

The IndexSearch ViewTemplate provides a user interface component for submitting search terms to the ADITO index search. It renders a single input field, allowing users to enter queries that are processed by the system-wide search engine. This ViewTemplate is typically used to expose global search functionality in the ADITO client.

Client Integration

In the ADITO client, this ViewTemplate is made accessible via the global search functionality. Users can open it by clicking on the magnifying glass icon in the Global Bar. Once opened, the search field accepts free-text input, which is passed to the configured EntityField associated with the index search process.

IndexSearch

Example Implementation

The ViewTemplate named IndexSearchTemplate is part of the IndexSearch_view and operates within the IndexSearchContext.

Configuration

The configuration of the IndexSearchTemplate is minimal and centers around a single key property:

PropertyDescription
entityFieldDefines the EntityField responsible for holding the search term input. In this case, the property is set to INDEXSEARCHFIELD.
tip

This ViewTemplate is particularly suited for global navigation or dashboard contexts where a central search functionality is required.