Catalog Search Plugin Configuration

Defines for how long the search cache is stored, starting from the last WRITE transaction.

For a list of accepted units, see Duration units.

If set to true, Elasticsearch-Evolution is enabled. Elasticsearch-Evolution is a library for migrating Elasticsearch mappings, thanks to which upgrades are done automatically as the application promotes configuration changes itself.

Default value: true.

The location from where Elasticsearch-Evolution migration scripts or configuration files are fetched. When defining multiple locations, set the index number accordingly.

Default value: /es/CHANGELOG.md.

The maximum allowed query size while already executed change sets are being validated. This value has to be higher than the total count of Elasticsearch-Evolution change sets.

Default value: 1000.

The name of the history index used by Elasticsearch-Evolution. This is where the internal state of Elasticsearch-Evolution is persisted and where the executed migration scripts are logged (in other words, all applied change sets).

Default value: .changelog_com_ataccama_one_catalog.

Defines how many primary shards an index is expected to have. For more information, see Elasticsearch Index Modules.

Default value: 1.

Specifies how many replicas each primary shard has. For more information, see Elasticsearch Index Modules.

Default value: 1.

Configures whether all data should be cleared from the Elasticsearch index. It should be set to the same value as the property ataccama.one.mmm.drop-first.

Default value: ${ataccama.one.mmm.drop-first:false}.

The name of the engine used for search.

Default value: ELASTICSEARCH.

Defines the order in which entity types are indexed during a full search reindex or search recovery.

Entity types that are not listed are indexed afterwards, ordered by their Global search order set in the search configuration, followed by entity types without a global search order. Entity types with the same or no global search order are indexed alphabetically by name.

Default settings:

A comma-separated list of Elasticsearch hosts. Must include the scheme as well.

Default value: http://localhost:9200.

The separator used to break down a search query into normalized tokens. By default, the delimiter is a space character. Default value: ' '.

Configures how many aggregation buckets are retrieved in a single aggregation batch. For more information, see Bucket Aggregations.

The name of the Elasticsearch index (BLUE) used for catalog search.

Default value: com_ataccama_one_index_catalog_search_blue.

The name of the Elasticsearch index (BLUE) used for catalog search. By default, references the property indices.catalog-search.

The name of the Elasticsearch index (GREEN) used for catalog search.

Default value: com_ataccama_one_catalog_search_green.

The name of the Elasticsearch alias (PRODUCTION) used for catalog search.

Default value: com_ataccama_one_catalog_search.

The name of the Elasticsearch alias (PRODUCTION) used for catalog search. By default, references the property aliases.catalog-search.

The name of the Elasticsearch alias (STAGING) used for catalog search.

Default value: com_ataccama_one_catalog_search_staging.

The name of the Elasticsearch query template for catalog search.

Default value: com_ataccama_one_template_catalog_search.

The name of the Elasticsearch filter suggestion template for catalog search.

Default value: com_ataccama_one_template_catalog_search_filter_suggestion.

The name of the Elasticsearch stored script for updating the catalog search node.

Default value: com_ataccama_one_script_catalog_search_node_update.

The name of the Elasticsearch stored script for deleting the catalog search node.

Default value: com_ataccama_one_script_catalog_search_node_delete.

The name of the Elasticsearch query template for concurrency control.

Default value: com_ataccama_one_template_optimistically_lock_catalog_items.

The annotation name for the default sorting property.

Default value: SORTABLE.

The annotation value for the default sorting property.

Default value: DOCUMENT_NAME.

The name of the node property used as the default sorting field (with index 0).

The name of the node used as the default sorting field (with index 0).

Default value: catalogItemProfile.

The name of the referenced node used as the default sorting field (with index 0). For example, catalogItem.

The name of the referenced node property used as the default sorting field (with index 0). For example, owner.

The sorting order used for the default sorting field (with index 0). Allowed values: ASC, DESC.

Default value: DESC.

The data type of the default sorting field (with index 0). Must match the data type of the default-sorting.properties[0].property-name property. Allowed values: KEYWORD, DATETIME, NUMBER.

Default value: DATETIME.

Defines the maximum size of bulk request which can be send to Elasticsearch. The property type is Spring DataSize.

Bulk requests to Elasticsearch can be refused because of size (due to the Elasticsearch parameter http.max_content_length) so this chunk mechanism is implemented to divide bulk request to chunks and send them separately.

Default value: 10MB. For a full list of accepted units, see Size units.

Configures how often the event queue is polled for updates.

Default value: 10s. For a full list of accepted units, see Duration units.

The number of events that can be polled in a single batch.

Default value: 100.

Defines the delay of the event processing job execution after the plugin starts. This is needed to prevent interference with other plugins that start later, which could lead to issues with starting MMM.

Default value: 30s.

An array of durations, with each duration representing the waiting period before the next retry is attempted. The number of durations determines the number of reprocessing attempts before an event is considered unsuccessful.

Default settings:

Defines the probability of catalog search read repair process execution.

Defines the thread pool size for catalog search read repair functionality.

Determines how successfully processed events are handled. By default, such events are deleted after the time period defined in the property processed-event-retention-period.

Another option is KEEP, which disables the cleanup. In that case, the stored events should be managed through the database itself.

Default value: DELETE_AFTER_RETENTION_PERIOD.

The time period after which successfully processed events are cleared. Applicable when the DELETE_AFTER_RETENTION_PERIOD retention policy is used.

Default value: 1h. For a full list of accepted units, see Duration units.

Determines how failed events are handled. By default, such events are deleted after the time period defined in the property failed-event-retention-period.

Default value: DELETE_AFTER_RETENTION_PERIOD.

The time period after which failed events are cleared. Applicable when the DELETE_AFTER_RETENTION_PERIOD retention policy is used.

Default value: 7d. For a full list of accepted units, see Duration units.

Enables event compaction.

Default value: true.

Configures how often the event queue is checked for new, uncompacted events.

Default value: 5s. For a full list of accepted units, see Duration units.

Defines the consuming order for event queue.

Default value: false.

If set to true, background indexing events are processed by priority first and then by creation time. A full search reindex or recovery then follows the order set in plugin.catalog-search.ataccama.one.engine.reindex.priority-order.

If set to false, events are processed in no particular order. To process them in the order they were created instead, set plugin.catalog-search.ataccama.one.eventqueue.consume-chronologically to true.

Default value: true.

Enables HTTP basic authentication for the Elasticsearch client.

The username for the Elasticsearch client. Used if basic authentication is enabled.

The password for the Elasticsearch client. Used if basic authentication is enabled.

Defines the thread pool size (number of threads) for catalog search read repair functionality.

Performs a cross-checking with MMM to verify whether the searched items are still in MMM. If the items are not there, they are deleted from the search store. Probability is expressed as a floating point number from 0 to 1.

Default value: 0.01 (1% probability).

A refresh makes recent operations performed on one or more indices available for search immediately after the operation occurs.

Default: false.

Handles automatic synchronization of data reindexing in Elasticsearch, when data or a schema of data is changed during an upgrade procedure. How data is handled depends on its status during the upgrade procedure:

Handles automatic search configuration changes during the upgrade procedure.

Enables advanced HTTP configuration for communication with Elasticsearch. This property must be set to true if any other ataccama.client.connection.es_search.http.* property is used.

Enables TLS communication between the client and Elasticsearch.

Default value: false.

The full path to the truststore file used for the Elasticsearch client. Must contain the Elasticsearch certificate. For example, file:/path/to/truststore.p12.

The type of the truststore for the Elasticsearch client. Allowed values: PKCS12, JKS.

The password for the truststore. Used if the truststore is encrypted.

Enables mTLS for the Elasticsearch client.

Default value: false.

The full path to the keystore file used for the Elasticsearch client. Must contain the key for the certificate used by Elasticsearch. For example, file:/path/to/keystore.p12.

The type of the keystore for the Elasticsearch client. Allowed values: PKCS12, JKS.

The password for the keystore. Used if the keystore is encrypted.