The Search add-on provides full-text search functionality for your application. It allows you to configure indexing of entities and uploaded files, as well as providing API and UI components for searching the indexed data. The search results are filtered based on the data access permissions of the current user.

The add-on utilizes Elasticsearch as its search engine. For more information about the internal search and indexing mechanisms, please refer to the Elasticsearch documentation.


For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.

For manual installation, add the following dependencies to your build.gradle:

implementation ''
implementation ''

Connecting to Elasticsearch Service

To connect to the Elasticsearch service, specify the following properties in the file:

  • - the complete URL of the Elasticsearch service.

  • - the Elasticsearch login for basic authentication.

  • - the user password used to connect to the Elasticsearch service.

By default, the Search add-on is configured for Elasticsearch version 7.11 and higher. If you intend to utilize a version prior to 7.11, you can disable compatibility mode by setting the application property to false.

Note that the Search add-on is not currently compatible with the Elasticsearch service offered by AWS.