Setting up an Elasticsearch configuration determines the STEP data that is provided to the Elasticsearch database to provide a modern faceted search experience. The configuration defines how data can be searched using the Web UI Search Screen.
Note: Elasticsearch can display product, entity, classification, and/or asset data only, based on configuration.
Important: To access and use faceted search powered by Elasticsearch, the ‘elasticsearch-integration’ add-on component must be activated on your system. To access and use the faceted Search screen, the 'ui-search' add-on component must be activated on your system. Contact your Stibo Systems representative for more information.
Creating an Elasticsearch configuration automatically creates or identifies the related event processor. The event processor collects the STEP data events indicated by the configuration and publishes it to the Elasticsearch database.
Note: The Search Screen only contains data for events that have been processed. Data for unread events on the event processor cannot be displayed in search results. For more information, refer to the Running an Event Processor topic in the System Setup documentation.
The Elasticsearch Configuration wizard adds a number of data specifications automatically, while attributes, attribute groups, link meta / source / target data, and child attributes can be added manually. Each item added manually can be configured for full text search, ID queries, and can be set to display as a default facet.
For example, attribute values that are often used to identify objects (such as manufacturer or country of origin) would be included as a search feature. While attributes that are not relevant for identifying an object (such as size or color) as are excluded. Additionally, attribute values important for data enrichment tasks should be included
For illustrations of search results using the faceted Search Screen, refer to the Search Screen Search Result Examples topic.
Important: Ideally, the configuration should include only the data necessary to allow users to easily scope and shape the desired search results. Excessive data in Elasticsearch can negatively impact the response time of searches on the faceted Search Screen. Carefully consider the attributes and references to configure initially and expand the configuration as you determine additional information is required.
To use Elasticsearch and the Web UI faceted Search Screen, complete the setup steps in the following topics:
- Perform the one-time setup as defined in the Initial Setup for Elasticsearch topic and the Elasticsearch Searchable Data Setup Options topic.
- Create an Elasticsearch object type as defined in the Creating an Elasticsearch Object Type topic.
- Create an Elasticsearch configuration and the required event processor as defined in the Creating an Elasticsearch Configuration topic.
- For details on 'data specifications' used in the Elasticsearch configuration, refer to the Elasticsearch Data Specification Type Examples topic.
- To edit an existing configuration, refer to the Maintaining an Elasticsearch Configuration topic.
- Add STEP data to the Elasticsearch database as defined in the Elasticsearch Publishing topic.
For more information on using Elasticsearch on the Web UI Search Screen, refer to the Search Screen topic.