Enhanced Autocomplete

Install the Elasticsearch server

Elasticsearch is a real-time distributed search and analytics engine that allows you to explore your data very quickly. It is used for full-text search, structured search, analytics, and all three in combination.

And it packages up all this functionality into a standalone server that your application can talk to via a simple RESTful API, using a web client from your favorite programming language, or even from the command line.

The Enhanced Autocomplete extension will allow you to make the link between the search and analytics engine and Magento 2.

You can find more information on the product here:

• https://www.elastic.co/products/elasticsearch
• https://www.elastic.co/guide/en/elasticsearch/guide/current/index.html

Install and run Elasticsearch server

As Elastic advises, "the easiest way to understand what Elasticsearch can do for you is to play with it".

To be able to use the Enhanced Autocomplete extension and reach the server, you first need to have a recent version of Java. You can easily install the latest version of Java from www.java.com.

Then you can install and run the Elasticsearch engine following the below steps.

Install Elasticsearch

You can download the latest version of Elasticsearch from elastic.co/downloads/elasticsearch.

Run Elasticsearch

To run Elasticsearch, open a console, and run the following command:

cd elasticsearch-<version>
./bin/elasticsearch

If you’re running Elasticsearch on Windows, simply run:

bin\elasticsearch.bat

Test Elasticsearch

You can easily test if the Elasticsearch engine is reached by trying to access http://localhost:9200/?pretty or by opening a new terminal window and running the following:

curl 'http://localhost:9200/?pretty'

You should then get:

You now have an Elasticsearch node up and running.

You can also check the official documentation to install Elasticsearch. 

Use the Enhanced Autocomplete extension

You can enable the Enhanced Autocomplete extension in:
StoreS › Wyomind › Enhanced Autocomplete

Once the extension is enabled, you will be able to configure the display settings as you want.

Debug mode

You have the possibility to enable debug mode.

When it is enabled, a toolbox will be displayed on the frontend with the below information:

• Infinite scroll?: have the products been loaded via the infinite scroll?
• Cache?: the module offers a cache for the current page. If the request is cached, the server will not be called and the response will be faster
  Yes = the result comes from the cache.
  No = the result doesn't come from the cache.
  The cache is reset when the page is reloaded.
• Elasticsearch?: it is the contrary of "cache?". Are the results coming from the Elasticsearch server or not?
  Yes = the request has been sent to the ELS server and the results are coming from ELS.
  No = the results were cached.
• PHP time: it is the execution time of the PHP code (including requests to the ELS server).
• Request time: it is the total execution time of the Ajax request to retrieve the products (including "PHP Time").
• Rendering Time: it is the time needed to render the products on the page ("Request Time" not included).
• Total time: it is the time required for the Ajax request and the rendering of the products.
• Enable Template Hints: to display the templates used for rendering the page by the module.
• Show last request data: to show the results of the last query (ESL or cached). It contains an explanation of why and how some products score higher than others.

Configure the autocomplete box

The Enhanced Autocomplete extension offers many features to configure the display as you want. 

Enable the highlight

With Enhanced Autocomplete, you have the possibility to enable the search terms highlight so that search terms can be underlined in the search results data.

Enable the "All results" link

You can enable the "All Results" link in the autocomplete box. This will redirect to the search results page. 

Update Search Terms

You have the possibility to update "Search Term" information when a search is performed from the autocomplete form.

You will then find the updated search terms in: Marketing › SEO & Search › Search Terms

Define your labels

With the Enhanced Autocomplete extension, you can define your own labels for: 

• "All Results" link
  {{term}} can be used to be replaced by the search term in the label.
  

  See all results for <b>{{term}}</b> >>

• "Did you mean?" section
  

  Do you mean?

• "Products" section
  

  Products

• "No product found"
  

  No product found

• "Categories" section
  

  Categories

• "No category found"
  

  No category found

• "Pages" section
  

  Page

• "No page found"
  

  No page found

Enable the Did you mean feature

The extension comes with the Did you mean feature. This provides alternative suggestions when users may have misspelled a search term.

The Did you mean feature can be enabled in:

• the autocomplete box
• the search results page

Also, you can limit the number of suggestions displayed in the autocomplete box.  

Configure the results displayed in the autocomplete box

The Enhanced Autocomplete extension allows you to make the products, the categories, and also the CMS pages searchable in the autocomplete box.

You can define your preferences from:
StoreS › Wyomind › Enhanced Autocomplete › Product/Category/CMS

Product

You can enable the products in the autocomplete box and limit the number of results displayed.

Below, only products are enabled in the autocomplete box.

You can also enable redirection when only one product is found.

Then, if only one product is found during the search, the customer will be automatically redirected to the product page when pressing the Enter button.

Category

Categories can be displayed in: 

• the autocomplete box
• the search results page: displayed in the left column

For each one, you can limit the number of results displayed. 

Also, you have the choice to display or hide that section when there is no category found. 

Below, products and categories are enabled in the autocomplete box. 

CMS page

Your CMS pages can be enabled in: 

• the autocomplete box
• the search results page: displayed in the left column

For each one, you can limit the number of results displayed. 

Also, you have the choice to display or hide that section when there is no CMS page found. 

Below, products, categories, and CMS pages are enabled in the autocomplete box. 

Configure the Elasticsearch Core

You can configure the Elasticsearch Core according to your needs in the Magento configuration from:
StoreS › Wyomind › Elasticsearch Core

Enable the logs / debug

The extension comes with logs in order to help you to check the frontend requests, the indexation, and the Elasticsearch server status. 

Note that the debug mode depends on the IPs authorized in your Magento configuration.

Enable request log

A log file is created for the frontend requests:
var/log/Wyomind_ElasticsearchCore_Frontend_Requests.log

Enable indexation log

A log file is created for the reindexation process:
var/log/Wyomind_ElasticsearchCore_Indexation.log

Enable client log

A log file is created for the Elasticsearch client calls:
var/log/Wyomind_ElasticsearchCore_Client.log

Enable Elasticsearch Server status log

A log file is created for the Elasticsearch Server status:
var/log/Wyomind_ElasticsearchCore_Server_Status.log

Receive a backend notification when the server fails

When the Elasticsearch Server status log is enabled, you can enable and define your own configuration for the backend notification subject and content.

Note that you have the possibility to use variables in the email content:

• {{store_id}}
  Store ID
• {{code}}
  Store code
• {{name}}
  Store name
• {{server_version}}
  Elasticsearch Server version
• {{servers}}
  Servers

Receive a mail notification when the server fails

When the Elasticsearch Server status log is enabled, you can enable and define your own configuration for the email notification.

Note that you have the possibility to use variables in the email content: 

• {{store_id}}
  Store ID
• {{message}}
  Returned message
• {{server_status}}
  Elasticsearch Server status
• {{server_version}}
  Elasticsearch Server version

Configure the server settings

You can configure the general Elasticsearch settings.

Elasticsearch Server version

Here will be displayed the version of the Elasticsearch server that you have installed.

6.3.2

Note that the version will be updated with the right value after having saved the config a first time or using a command line.

Servers

The servers must be written as host:port and separated with a comma.
Follow this pattern for full available parameters.
Check that your servers are correctly configured by clicking on TEST servers.

Verify Host

This is only used for https connection. You can set that option to No if you don't have a valid SSL certificate.

Connect Timeout

Number of seconds after a timeout occurs for every request.

5 seconds

Configure the indexing settings

Index Prefix

This is used to prefix index names in order to avoid potential collisions. 

demo_m2_

Index Settings

Having more shards enhances the indexing performance and allows to distribute a big index across machines and having more replicas enhances the search performance and improves the cluster availability.

When clicking on Use system value, the default configuration is reinitiated.

Be careful when modifying this parameter. Write consistency (one, quorum, or all) must be considered in order to avoid timeout write action.
More info here: Index settings properties reference

Analysis Settings

This is where you can define the analysis settings.

When clicking on Use system value, the default configuration is reinitiated.

See more about the Analysis settings.

Safe Reindex

Reindex in a temporary index and switch to it once finished. Especially useful for large product catalogs.

Automatically run indexers if invalidated

In some cases, you might need to reindex indexes automatically as it can take a lot of time. Then you can choose to automatically run indexers via a cron task when they are invalidated.

A notification is displayed in the header of Magento when indexes are invalidated.

If you disable this option, see how to run your indexes manually.

Check the status of the indexes from: System › Wyomind Elasticsearch Core › Manage Indexes

Configure the search settings

Query Operator

By default, it is set to AND. You may have fewer results with the AND operator but they’ll be more relevant.

"digital camera" is translated to "digital AND camera" or "digital OR camera"

Enable Product Weight

This enables product weight modifier. It is only available for search results.

When product weight is enabled, you can assign a weight to any product from the backend product page in the Elasticsearch tab. 

Use parent images

By enabling this option, when a product (configurable or bundle) is found from the data of a child product, then the parent product images will be used instead of the child product images.

Return available products first?

Enable this option to return the products available for purchase before the products not available.

Configure the entities settings

You can configure the indexing of the attributes more finely. 

1. Open each group of attributes using the arrow. 
2. Find all the attributes grouped by type. 
3. When fields are grayed out, it means that the attribute is indexed by default by the module.
   To be able to modify the searchable option, the attribute must be indexable.
4. For an attribute to be searchable it must be indexed.
   To be able to modify all of the following options, the attribute must be searchable.
5. You can boost each attribute you are indexing by assigning them a weight from 1 to 10.
   

   Note that 10 is the highest weight. 

6. You can start matching results from the first 1 to 5 characters. 
7. You can start matching results from the last 1 to 5 characters. 
8. The analyzer defines the way in which the content of the attributes will be analyzed. You have the choice between several analyzers. 
   

   Note that the automatic mode is suitable in most cases. 

   

   See how to create your own analyzers with our module.

9. You have the possibility to enable the approximative search for each attribute and choose the fuzzyness level:
   

   

   0: the number of possible errors is 0 whatever the size of the search word
   1: the number of possible errors is 1 whatever the size of the search word
   2: the number of possible errors is 2 whatever the size of the search word
   AUTO: generates an edit distance based on the length of the term. Should generally be the preferred value. 
   

   For the AUTO mode, the length of the words has an impact on the edit distance:
   

   0..2: must match exactly
   3..5: one edit allowed
   >5: two edits allowed

   Check the Elasticsearch documentation for more info on the fuzzy query mode. 

The attributes used in the search with Advanced Layered Navigation are automatically added to the Elasticsearch Core index.

Category

You can enable Category Search so that they can be indexed in Elasticsearch.

If you do, you need to select and configure the category attributes that are searchable.

Description
Name
Page Title
URL Key

Category indexing is only used with Enhanced Autocomplete and Multifaceted Autocomplete.

CMS

You can enable the search among your CMS pages to be indexed in Elasticsearch.

You just need to select and configure the searchable attributes. 

Content, Content Heading, Identifier, Title

You also have the possibility to exclude some pages that may not be relevant from the search results. 

404 Not Found, Enable Cookies, Privacy Policy

CMS page indexing is only used with Enhanced Autocomplete and Multifaceted Autocomplete.

Product

When the Product Search is enabled, the products are indexed in Elasticsearch.

You can define the image size in pixels. 

50px

The images will be used in the autocomplete with Enhanced Autocomplete and Multifaceted Autocomplete.

Then, select and configure the attributes that are searchable.

Product Name
SKU
Color
Description
Gender
Manufacturer

Attention, after having selected the attributes, indexes are invalidated. According to your configuration, they will be automatically reindexed by cron task, or you'll have to manually reindex them.

Configure the frontend design

You have the possibility to define your preferences for the colors and the display.

Loader Image

Choose the image you want to display when categories and search pages are loading. It can be:

• jpg
• jpeg
• gif
• png
  

  

Primary color

Used for the main elements.

Secondary color

Generally used for highlighting search terms in the search results.

Background primary color

Generally used as the products listing background.

Background secondary color

Generally used as the secondary entities listing and layers background.

Enable overlay

Dark overlay behind the autocomplete popup.

Available if you have the Multifaceted Autocomplete or the Enhanced Autocomplete extension. 

Enable blur effect

Blurred background behind the autocomplete popup.

Available if you have the Multifaceted Autocomplete or the Enhanced Autocomplete extension. 

Enable transition

Smoothly show/hide the autocomplete popup.

If enabled, you can define the duration of the transition in seconds. 

0.2

Available if you have the Multifaceted Autocomplete or the Enhanced Autocomplete extension. 

Developer tools

Test Search

The Test Search is equivalent to the frontend search with debug info. This allows you to control how the search will work with the Elasticsearch Core configuration.

You can access the Test Search page from: 
System › Wyomind Elasticsearch core › Test Search

You can configure:

• Search term
  Add the term you want to search.
• Results limit
  Define a limit for the number of results displayed.
• Storeview
  Choose the store view from where you want to run the search.
• Customer Group
  Choose the customer group to search from.
  Useful to control the product prices for a specific customer group.

After that, you can click on Search.

A grid will display the results for your search. 

When clicking on Show details, you should get more details about the results.

This is particularly useful to know everything that is returned in the search.

The explanation field explains how the score is calculated and why the product appears first in the search results.

Test Analyzers

As our module offers the possibility to create your own analyzers, it is important to be able to test them.

You can access the Test Analyzers page from: 
System › Wyomind Elasticsearch core › Test Analyzers

Add your code in the Custom Analyzers field, select the Built-in Analyzers you want to test, and add a Test phrase. 

Click on Run Tests. 

The result of the analyzer will be displayed in the table below. 

Below are some examples:

whitespace: will analyze by separating words with spaces

standard: will separate words with spaces, apostrophes, chevrons ... and remove HTML tags to keep only useful content

Manage the indexes

You have the possibility to get more information and to manage your indexes directly from the table in:
System › Wyomind ELasticsearch Core › Manage Indexes

The indexes are automatically updated after the below actions:

• Add / Edit / Delete a product
  The product is updated at the product index level.
• Add / Edit / Delete a CMS page
  The CMS page is updated at the CMS index level.
• Add / Edit / Delete a category
  The category is updated at the category index level.
• Category products list update
  The category is updated at the category index level and the products previously and currently linked to the category are updated.
• Review added to a product
  The product rating is updated at the product index level. 

Indexer

There are 3 types of index:

• category
• cms
• products

The category and cms indexes are also used in the modules of the Elasticsearch Suite.

Description

In the Description column, when clicking on More information, you can see:

• demo_m2_default_category
  It is the name of the index at the Elasticsearch server level under the below format:
  

  the prefix + the storeview code + the index type

• 36 documents
  It means that 36 categories are indexed.
• 14,77 kB
  It is the size of the index on the disk.
• View Mapping
  When clicking on View Mapping, a popup should open and display the mapping data. 
  

  

Last Update

The last time the index has been run will be recorded in the Last Update column. 

Last action state

The last action state will be recorded in this column. You can also see the number of entities that were indexed by hovering the mouse over the status.

When running an index, a progress bar will display its status and some information about the indexing process.

Status

From the Status column, you can see if the indexes are valid of invalidated. 

According to your configuration, indexes will be automatically reindexed by cron task, or you'll have to manually reindex them.

Action

From the Action column, you can choose to:

• Flush the index: this will empty, reset the index.
• Run the index: this will fully reindex the entities.
• Run via cron: this will trigger the cron task to run the selected index.

Note that you can reindex any of your attributes. See how to make your attribute searchable.

Browse Data

You can easily see what is indexed at the category, CMS pages, and product level in that section:
System › Wyomind ELasticsearch Core › Browse Data

From the Action column, you have the possibility to:

• Edit each line
  Redirects you to the category/CMS/product page
• See the raw data
  Opens a popup that displays the raw data; what is really indexed in Elasticsearch.

Use the Command Line Interface

The extension comes with several command lines you can easily use.

Update Elasticsearch server version

To update the Elasticsearch server version with the right, you can use the below command line:

bin/magento wyomind:elasticsearchcore:update:server:version​

Update the configuration file

To update the configuration file which is used on the frontend to avoid loading the full Magento Core, you can use the below command line:

bin/magento wyomind:elasticsearchcore:update:config

Reindex your data

To reindex your data, you can use the below command line:

bin/magento wyomind:elasticsearchcore:indexer:reindex [options]

Options:

• -s storecode or --store storecode
  The code of the store view for which to re-index data.
  Note that this parameter is unique, you can’t add many store codes.

  To reindex all types for the store view which code is “storefr”:

  bin/magento wyomind:elasticsearchcore:indexer:reindex -s storefr

  or

  bin/magento wyomind:elasticsearchcore:indexer:reindex --store storefr

• -i type or --index type
  A space-separated list of index types: cms, category, and product
  
  

  To reindex products only:

  bin/magento wyomind:elasticsearchcore:indexer:reindex -i product

  or

  bin/magento wyomind:elasticsearchcore:indexer:reindex --index product

  You can also reindex your brands when using the Shop by Brand extension. 
• -p ID or --product ID
  The ID of the product to reindex. 
  Note that this parameter is unique, you can’t add many products. To reindex product with ID 2:
  

  bin/magento wyomind:elasticsearchcore:indexer:reindex -i product -p 2

  or 

  bin/magento wyomind:elasticsearchcore:indexer:reindex --index product --product 2

More examples:

To reindex all index types for all store views and products:

bin/magento wyomind:elasticsearchcore:indexer:reindex

To reindex categories for the store view which code is “storefr”:

bin/magento wyomind:elasticsearchcore:indexer:reindex -s storefr -i category

To reindex categories and CMS pages:

bin/magento wyomind:elasticsearchcore:indexer:reindex -i category cms

When running an index, a progress bar will display its status and some information about the indexing process.

Note that this will be logged in Wyomind_ElasticsearchCore_Indexation.log.

Manage your search results

Like the product attributes, you can assign weight to your products directly. 

Give weight to your products

Assign weight to products

To boost your products in the search results, you can give them a weight. For this, go in:
Catalog › Products

There, edit a product you want to showcase.

In the Wyomind Elasticsearch Core tab, you can define the weight from 1 to 10. 

Note that 10 is the highest weight. The higher the weight, the more the product will appear first in the search results.

This is only possible when the Product weight option is enabled in the Elasticsearch Core configuration. 

Ignore products in the indexation

You have the possibility to ignore products in the indexation process. For this, go in:
Catalog › Products

There, edit a product you want to showcase.

In the Wyomind Elasticsearch Core tab, you can switch the Ignore the product for indexation option to Yes. 

When changing this value, a full reindex must be run (manually or using the CLI).

Manage the synonyms in your search results

The extension takes into account the synonyms in the search.

Create groups of synonyms

You can create new groups of synonyms from:
Marketing › Seo & Search › Search Synonyms

For example, if you create the list of synonyms:

shoes,footwear

This means that when searching for "orange shoes", the extension will search:

orange shoes
orange footwear

If other synonyms are defined such as:

red,orange,yellow

In that case, the extension will search:

red shoes
red footwear
orange shoes
orange footwear
yellow shoes
yellow footwear

All the corresponding products will then be displayed in the same list.