User Guide of Magento 2 Elasticsearch Module

After the successful installation of the Magento 2 Elastic Search extension on your Magento 2 store.

The admin will navigate through Stores > Configuration > Catalog > Catalog search > Search engine and then select Webkul Elasticsearch.

Magento 2 Elasticsearch General Settings

Once the search engine got selected as Webkul Elasticsearch, the admin will navigate through Stores > Configuration > Webkul > Elastic Search Setting > General Settings.

Here the Admin has to enter/Select:-

1. Add the elastic server hostname in the Host field.
2. Port Number:- To configure the elastic server enter the port number.
3. Index Prefix:- We are using an elastic search server on multiple websites. If we use an index prefix on websites, then at the time of re-indexing, that particular website data will not affect other websites.
4. Check Connection Status:- Check the current status of the elastic server. 
5. Reset Connection:- The connection will be reset if you choose this option, and all data will be deleted from the current elastic server. The administrator must manually reindex it by going to Elastic search > Index management.

Search Settings of Magento 2 Elasticsearch Extension

Here, The Admin can select any query as a search type for the frontend, such as Multi-Match Query or Simple Match Query:

1. Multi-Match Query

If the Multi-Match query search type enables, the customer can search for a product using its attributes. The attribute type must be text and created by the admin.

• Select Frontend Search Type: Choose the type of search.(e.g., Simple Match Query, Multi-Match Query).

• Select Fields For Multi Search: Choose which data fields (like SKU, product name, category, etc.) should be included in a multi-field search.

• Select Multi-Match Type – the admin needs to select multi-match type as the best field, most Fields, cross fields, phrase, and phrase prefixes.

• Select Operator For Multi-Search– The admin can select the “AND” or “OR” operator for multi-search.

2. Simple Match Query

If Simple Match Query is selected in the search type, the customer can only search for a product by its name and SKU.

• Allow Spell Correction in Search: Select the accuracy level for the search queries.

• Select Search Filters: Choose which filters (e.g., category, price, rating) users can apply to narrow down search results.

• Enter Comma Separated List Elisions: Define words (like “the,” “and,” etc.) to be ignored or excluded in search indexing, entered as a comma-separated list.

Search Suggestion in Magento 2 Elastic Search Extension

In search suggestions, with the help of keywords, customers can search categories, pages, or products.

Magento 2 Elasticsearch Did You mean

When a customer enters the wrong product name, it will recommend all nearby products with the same product name to the customers. 

Shown in the below screenshot.

Spell Correction in Search

The Elastic Search Engine will automatically correct keywords when they wrote incorrectly by the customer if the spell check is set to Level 1 or Level 2 by the admin.

Select Search Filters

There are four types of search filters to modify the search term provided by the customer. The admin can select the token filters.

1. Synonym Filter

The admin has to navigate through Marketing > Search Synonyms.

Admin can create a new synonym group from here. For example, the admin has added synonyms for jeans and pants.

Now, the search engine will display all the results connected to any of these keywords if the customer searches for one of them.

2. Elision Filter- An elisions-removing token filter. For example, “L’avion” (the plane) will be parsed as “avion” (plane).

3. Lowercase Filter– A lowercase token filter that converts token text to lowercase.

4. Stop Word Filter– Stop words are removed from the search query. Examples of stop words are and, is, and to.

To learn more about token filters, please go through the following Link:

https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html

Select Language Stemmer

According to the language of the Magento 2(Adobe Commerce) store, the admin must choose the appropriate Language Stemmer. 

For example, if the store language is set as English, the customer can only search in English.

• Select Language Stemmer: Choose the language for stemming words.
• Enter comma separated words to exclude from stemming: List words to keep unchanged during stemming.

Select Character Search Filters in Magento 2 Elasticsearch

There are three types of character filters. That is used to remove unwanted characters from the search input.

1. HTML strip char filter– The HTML strip character filter strips off the HTML parts.
2. Mapping Filter– The mapping filter swaps out the mapping keys with values. So, it will eliminate any character from the mapping in the Magento 2 Elasticsearch module.
3. Pattern Replace Filter– The Pattern Replace Filter functions similarly to the Mapping Filter. The main difference is that it replaces patterns instead of mapping them. To replace characters, it makes use of a regular expression
4. Enter Comma Separated List Of Filter Mappings: List multiple filter rules, separated by commas.
5. Enter Pattern: Define the text or pattern to search for.
6. Enter Pattern To Replace With Filter Pattern: Define the text or pattern to replace the found pattern.

To learn more about the character filters, please go through the following URL:

https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html