Indexes
Create and manage search indexes for custom schema types, customers, and legal entities. Follow build jobs and export or import index configuration.
The Indexes view lists search indexes for custom schema types, customers, and legal entities. An index defines which fields of a type are searchable and how search terms match them. Creating or changing the field list runs as a job. When the job succeeds, the index status is Ready and you can use the index in Search.
Browse and filter indexes
Open Indexes from the side menu. Filter the list by Schema type, Filter by id, Filter by name, and status. Schema type can be ALL to show every type, or one concrete type.
An index can have one of the following statuses:
Ready – the index is available for search.
Building – a create or update job is still running.
Failed – the last job did not succeed.

Create an index
Add fields
Use Ask assistant to build the field list. Describe what the index should cover, and the assistant adds the relevant fields and options (Text, Exact, Autocomplete) for that schema type. Review the result, edit it if needed, then continue.

You can also select Add field and choose each schema field yourself. For each field, set the options the field type allows:
Text – match free text, phrase, wildcard, or contains filters.
Exact – filter by equality, range, list, or existence, and support sorting. Number, Boolean, and date fields support only Exact.
Autocomplete – match a prefix or character sequence inside a word.
For a field with Text, choose an Analyzer to decide how the text is compared. To search inside a field that holds several entries, such as all addresses of a customer, select Add list field.
Add at least one field before you save.

Save and wait for the job
Select Save. The cockpit starts a build job. For a custom schema type, the job indexes the existing custom instances. For the first customer or legal-entity index, existing records are added only by a reindex. For more information, see Reindex customers or legal entities. On the edit view, open Jobs to follow status and messages. While a job runs, the index editors stay unavailable. When the job succeeds, the index status is Ready. If the job fails, review the message on Jobs, correct the field list if needed, and save again.
Control text matching with analyzers
An analyzer decides when a search term matches the stored text. Choose one per Text field so that searches find the values your users expect, for example names with or without accents, or codes typed with or without spaces.
The following analyzers are available on every index:
STANDARD – The default analyzer. Compares word by word and ignores case. Use it for general text such as names and descriptions.
FOLDED – Works like STANDARD and also ignores accents, so
MullermatchesMüller.IDENTIFIER – Compares the whole value and ignores spaces, hyphens, dots, and slashes. Use it for codes, postal codes, and reference numbers.
SOUNDS_LIKE – Matches words that sound alike. Use it for different spellings of a name.
When none of them fits, define your own under Analyzers on the index form. Select Add analyzer, give it a Name, choose the analyzer it is Based on, and adjust how it splits and compares text (Split, Compare) and which characters or words it ignores. For example, an analyzer for company names can ignore legal-form words such as gmbh and ag. An index can have up to 10 custom analyzers. Select each one on at least one field, otherwise the index cannot be saved.
To match a field in more than one way, add up to three Additional analyzers to it. A search uses an additional analyzer only when the query selects it. For example, keep FOLDED as the main analyzer for a name and add SOUNDS_LIKE for searches by sound. See Queries.
Analyzers are part of the field definition, so changing them starts a new build job.
Index a list of objects
Some fields hold a list of objects, for example the addresses of a customer. To search inside such a list, select Add list field, choose the list under List of objects, then add the fields inside it that you want to search, such as addresses.city or addresses.zipCode. Set Text, Exact, Autocomplete, and analyzers on those fields, not on the list itself.
Conditions on list fields are matched item by item. For example, a customer matches addresses.city Berlin AND addresses.zipCode 10115 only when one address has both values. See Conditions on a list of objects.
Edit or delete an index
Open an index from the list with Edit to change its details. Saving the index starts another job.

To remove an index, use the Delete option next to the index on the list and confirm the action. The list refreshes when the delete job finishes.
Reindex customers or legal entities
Customers and legal entities are added to their indexes as they are created or changed. Records that existed before the first index of that type are not indexed yet. After you create the first customer index or the first legal-entity index, reindex once to load all existing records of that type. Later indexes for the same type do not need a reindex.
Select Reindex next to a customer or legal-entity index and confirm. Reindexing affects every index of that type. If there are many records, it can take a long time. While it runs, the following restrictions apply:
Search for that type is unavailable until the reindex finishes.
Only one reindex runs at a time. Reindex stays unavailable on all customer and legal-entity indexes until the current one finishes.
You can leave the view while the reindex runs. The cockpit notifies you of the result.
Export and import configuration
Export and import allow you to copy index configuration between tenants, for example from a development tenant to production. On Indexes, select one or more indexes and choose Export indexes to download a package of index settings. In the target tenant, use Import index to apply that package. Import creates or updates indexes from the package and can leave some unchanged when the field definition already matches. The package contains index configuration only, not data records or job history.
Last updated
Was this helpful?

