Welcome to the Elastic Search Ultimate Guide!

Here you will find everything you need to set up a better search experience.

This guide is for Magento 2.1-2.3 only. For Magento 2.4+ please use this Elasticsearch Ultimate Guide.

The Elastic Search Ultimate Extension includes Elastic Search, Search Spell-Correction, and Search AutoComplete, giving you a powerful way to search through your store.

First, Please find your extension in My account / My Downloadable Products / View & Download. Then, start with the section titled: Installation. It is best to follow our guide step-by-step to configure the best search results.

Go ahead, dive in!

Learn about Initial extension's setup:

Installation
Upgrading
Disabling

Welcome to the Elastic Search Ultimate Guide!

Here you will find everything you need to set up a better search experience.

First, please find your extension in your account in My Downloadable Products section. Then, start with Installation. It is best to follow our step-by-step guide in order to configure the best search results.

Go ahead, dive in!

Learn about the initial setup:

Installation

Installation

In this article you will find two possible ways of our extension's installation.

Installation via composer (preferably)

We recommend this installation method because Composer doesn't allow to overwrite files.

Backup your store's database and web directory.
Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
Copy the installation instructions from the page My Downloadable Products / View & Download to the SSH console.
Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Search Mirasvit_SearchMysql Mirasvit_SearchElastic Mirasvit_SearchAutocomplete Mirasvit_Misspell Mirasvit_SearchLanding Mirasvit_Report Mirasvit_SearchReport to enable the extension.
Run command php -f bin/magento setup:upgrade to install the extension.
Run command php -f bin/magento cache:clean to clean the cache.
Deploy static view files
rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*;
rm -rf var/view_preprocessed/*
php -f bin/magento setup:static-content:deploy
Run search spell-correction reindex php -f bin/magento indexer:reindex mst_misspell
Go to System / Search Indexes, configure Product index and run the reindex for it.

Installation via direct file upload

You can also install the extension via direct files uploading.

Go to My Downloadable Products / View & Download
Unpack .zip package and copy contents to magento root directory
Run command composer require elasticsearch/elasticsearch:~5.1 to install required libraries.
Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Search Mirasvit_SearchMysql Mirasvit_SearchElastic Mirasvit_SearchElasticNative Mirasvit_SearchAutocomplete Mirasvit_Misspell Mirasvit_SearchLanding Mirasvit_Report Mirasvit_SearchReport to enable the extension.
Run command php -f bin/magento setup:upgrade to install the extension.
Run command php -f bin/magento cache:clean to clean the cache.
Deploy static view files
rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*;
rm -rf var/view_preprocessed/*
php -f bin/magento setup:static-content:deploy
Run search spell-correction reindex php -f bin/magento indexer:reindex mst_misspell
Go to System / Search Indexes, configure Product index and run the reindex for it.

Core Search Settings

Here you can quickly navigate across all functionality settings we have. Please use the list below to navigate.

This section covers all topics, necessary for working with indices, and consists of the following subsections:

Search Indexes Settings
- Managing Indexes
- Adding New Index
- Product Index
- Category Index
- CMS Index
- Attribute Index
- Wordpress Blog Index
- Add Custom Index
Global Search Settings
- Search Engine Configuration
  - Sphinx Search Engine (for Search Sphinx Ultimate extension)
    - Installation
    - Connection with Sphinx Engine
  - Elastic Search Engine (for Elastic Search Ultimate extension)
    - Installation
    - Connection with Elastic Engine
  - Search Settings
  - Multi-store Search Result
- "Long-Tail" Search
- Landing Pages
- Synonyms
- Stopwords
- Customize Search Weight

Configure Search Indexes

Search Indexes are the most important part of your search subsystem. The purpose of storing an index is to optimize speed and performance in finding relevant documents for a search query. Without an index, the search engine would scan every document on your store, which would require considerable time and computing power.

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Our Magento 2 Elasticsearch Extension or Sphinx Extension can combine all indexes, existing in your configuration, to boost search and give your customers the most relevant results. It brings them all to a single grid, located at System -> Search Management -> Search Indexes, from where you can configure them.

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

This attribute should be previously enabled for Advanced Search. It can be done at Stores -> Attributes -> Product grid. Pick up desired attribute, then jump to Storefront Properties subsection and then make them available for search by setting to Yes two options: Use in Search and Visible in Advanced Search.

Note

Attribute index can work only with attributes, that can be indexed, e. q. they belong to selectable type.

To see type of Product Attribute, visit Stores -> Attributes -> Product grid, pick up attribute record, and see Catalog Input Type for Store Owner field. Selectable types are Multiple Select and Dropdown. Only attributes of this type can be indexed.

If you wish to use attributes like Author, or similar, you have to make them selectable first, and then make them available for search as above.

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Configure Search Indexes

This section covers all topics, necessary for working with indexes, and consists of the following subsections:

Managing Indexes
Adding New Index
Product Index
Category Index
CMS Page Index
Attribute Index
Wordpress Blog Index

Managing Indexes

Each index, added to this grid, displayes the following properties:

Title - title of the search index.
Type - shows index type (searchable content type - read more at Adding New Index subsection).
Position - the position of the index in the search results. Search results will be organized in tabs according to this property.
Status - indicates, whether current index is ready for search. Disabled value means, that index will be excluded from search.

Additional Action column provides common actions, that can be performed directly from grid, such as:

Edit - edit index settings (default action).
Reindex - run manual reindexing for selected index.
Delete - remove index from Mirasvit Search extension. %
Note
This action will completely remove this index from your store, so if you wish index to be excluded from search - just change its status to Disable.

Back to top

Adding and Configuring New Index

To add a new index to Mirasvit Search extension, go to System -> Search Management -> Search Indexes and press Add New Index.
Index record creation are divided into two stages: setting common settings and specific, which depend from their type. Common settings are shown in General Settings subsection:
- Title - title of the search index. It will be used as tab header at search display page.
- Type - shows index type (searchable content type). Some values of this field will trigger specific options. Pick a link from type list below to know more:
  - Magento Indexes
    - Product
    - Category
    - CMS Page
    - Attribute
  - Custom Search Indexes
    - Wordpress Blog
  - Mirasvit Extensions
    - Blog MX
    - Knowledge Base
    - Gift Registry
  - Magefun Blog Extension
  - Mageplaza Blog Extension
  - Ves Extensions
    - Blog
    - Ves Brand
  - Amasty
    - Blog
    - FAQ
  - Blackbird Content Manager
- Position - the position of the index in the search results. Extension will sort tabs on search results page based on position.
- Active - sets, whether index should be activated.
Press Save and Continue Edit to proceed to index configuration stage.
Add Searchable Attributes to the type-dependent option list, with rows corresponding to attributes, where extension should conduct search. Each row consist of the following fields:
- Attribute - attribute name. It is picked from properties of selected index type. For example, if Product type is selected - then attributes would be Product Name, SKU, Price, Tax Class and so on.
- Weight - sort order, which defines importance of each attribute for product relevancy. The maximum weight is 10 (highest priority), the minimum weight is 0(lowest priority). Each index type comes with a predefined set of searchable options, that will be displayed after completing the first stage. There should be at least one searchable attribute, otherwise search will not work properly.
Properties - type-dependent specific options section. Read more below, or pick a link from type values, described in (2) step.
Save index and activate it to include to search.

On installation three indexes will be automatically created and configured: Product, Category and CMS Page.

Back to top

Product Index

Product Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Specific options of this type will be shown on Properies section of Index edit page:

Search by Parent Categories Name - include to search all parent categories (useful, when store has wide categories tree).
Search by child products - include to search associated products from Bundled, Grouped and Configurable products.
Search by Product ID - enable search by product id (entity_id attribute, which is not listed as searchable by Magento).
Search by custom options - enable search by custom options (defined additionally to existing ones).
Push "out of stock" products to the end - force sorting of search results by stocks inventory, so 'out of stocks' products will be displayed last.
Search only by active categories - display only products, which are assigned to at least one active category
Force sort order by - overrides default sort order of search results by one of these options:
- Relevance - sorting by maximum relevance with search request
- Name - sorting by names in alphanumeric order.
- Creation Time - sorting by date of adding products to store
- Price 0-9 - sorting from cheapest to most expensive.
- Price 9-0 - sorting from expensive to cheapest.

Back to top

Category Index

Category Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's no specific options for this type of index.

Back to top

CMS Index

CMS Page Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

There's only one specific option for this type on Properies section of Index edit page:

Ignored CMS Pages - defines, on which CMS pages search should not be performed. You can select zero or more pages here via checkbox drop-down list.

Back to top

Attribute Index

Unlike of other indexes, this one can be created only for specific attribute, which should be displayed as separate section in Search Results.

Note

After saving product you can configure Attribute Index for this attribute at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Back to top

Wordpress Blog Search Index

Wordpress Blog Index can be created at System -> Search Management -> Search Indexes grid. Read more here about adding new index.

Database Connection Name - connection name of the wordpress database.

If WordPress is installed on the same database, the correct value is default.

Example

Typical database connection should look similar to this:

    'db' => array(
    'table_prefix' => '',
    'connection' => array(
        'default' => array(
            'host' => 'localhost',
            'dbname' => 'store',
            'username' => 'root',
            'password' => 'password',
            'active' => '1',
        ),
    ),
   ),

If WordPress is installed on the separate database, you need to create a new connection in file app/etc/env.php.

Example

A typical separate database connection should look similar to this:

'db' => [
'table_prefix' => '',
'connection' => [
    'default' => [
        'host' => 'localhost',
        'dbname' => 'dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ],

'wpconnection' => [

        'host' => 'localhost',
        'dbname' => 'your_wp_dbname',
        'username' => 'username',
        'password' => 'password',
        'active' => '1',
    ]
]
],
'resource' => [
'default_setup' => [
    'connection' => 'default'
],
'wp_setup' => [
    'connection' => 'wpconnection'
]
],

Table Prefix - the prefix for the wordpress tables (wp_ by default) or login to MySQL: use your_wp_dbname; show tables;

Url Template - the full URL for your posts with dynamical variables.

Typical base urls should look like example below below:

http://example.com/blog/{post_name}.html
http://example.com/blog/?p={ID}
http://example.com/{category_slug}/{post_name}.html

Back to top

Implementing Custom Search Index

Sometimes it's need to have specific type of Index, which is either not included to our Magento 2 Elasticsearch Extension or Sphinx Extension, or belongs to some third-party extension. In this case custom index can be implemented, using the following instructions:

Clone the example module from repository http://github.com/mirasvit/module-search-extended
Note
There must be taken into account your Magento version. Correct steps should be:
1. git clone <repo_url> - Clone the example module from the repository;
2. cd module-search-extended/ - Change directory;
  git checkout magento23 - Navigate to specific tagname for Magento 2.1-2.3 please use tag magento23.
  git checkout magento24 - For Magento 2.4+ please use tag magento24.
  To make sure you switched to the correct tagname, run git branch.
Go to app/code/Mirasvit/SearchExtended/Index/ and rename subpath Magento/Review/Review/ to the required one ([provider]/[module]/[entity])
Change class names in file app/code/Mirasvit/SearchExtended/Index/[provider]/[module]/[entity]/Index.php
- Rename class
- Set your values to getName(), getPrimaryKey() and getIdentifier() methods
Configure the attributes you want to get in getAttributes() method
Change methods buildSearchCollection() and getSearchableEntities()
Change registration for new index in file app/code/Mirasvit/SearchExtended/etc/di.xml
Adjust layout file app/code/Mirasvit/SearchExtended/view/frontend/layout/catalogsearch_result_index.xml

Rename template name/path and adjust it /app/code/Mirasvit/SearchExtended/view/frontend/templates/index/magento/review/review.phtml
Enable module and Clear magento cache

If everything was correct, you can add index of your custom type like any regular index.

If you use SSU please go to: /vendor/mirasvit/module-search-autocomplete/src/SearchAutocomplete/Model/Index folder
Create folder/file structure <Company>/<Extension>/<EntityType>.php i.e. /vendor/mirasvit/module-search-autocomplete/src/SearchAutocomplete/Model/Index/Ves/Blog/Post.php
Open /vendor/mirasvit/module-search-autocomplete/src/SearchAutocomplete/etc/di.xml and add item to type name="Mirasvit\SearchAutocomplete\Model\Index\Pool" arguments

Configure Global Search Settings

This section describes, how you can customize and greatly improve the relevance of your search results by configuring Search Settings.

The most important part is Global Search Configuration. It is located at System -> Search Management -> Settings -> Mirasvit Extensions -> Search, and divided into the following sections:

Search Engine Configuration
Search Settings
Multi-store Search Result

Search Engine Configuration

Our extension allows you to power up search either with default Magento search engine, or with external engine. Option Search Engine selects, which engine should be in charge, and has three possible values:

MySQL - native Magento engine, used for Magento default search functionality.
Built-in search engine - will use an internal search algorithm of our extension.
Note
Built-in search engine mode does not require installation of Sphinx Engine on your server, but you will still receive the same features as with the Sphinx Engine. However, you can experience a slower search speed than with the Sphinx Engine (only for more then 20K products).

Third possible value depends from precise extension, that you're using. Mirasvit provides two search applications, that share this option, but support different search engines.

Sphinx Search Ultimate

Sphinx Search Ultimate, as it derives from its name, allows you to use Sphinx Engine on the dedicated server, or on the same server of your store.

Sphinx is an open source full text search server, which features high performance, relevance (aka search quality), and integration simplicity. It's written in C++ and runs on Linux (RedHat, Ubuntu, etc), Windows, MacOS, Solaris, FreeBSD, and a few other systems. It is better used for stores with products quantity below 50k and without need of layered navigation or aggregated search requests. Read more about this engine key features.

Sphinx Search Ultimate adds to the option Global Search Configuration -> Search Engine Configuration -> Search Engine possible value External Sphinx Engine.
Note
To start with, please, make sure that you have installed Sphinx Search Engine.

External Sphinx Engine also triggers additional options for configuring and managing Sphinx Daemon:
- Sphinx Host - sphinx daemon host (localhost by default).
- Sphinx Port - sphinx daemon port (any free port, like 9811, 9812).
- Sphinx installed on same server - triggers appearance of additional features of Sphinx Daemon. Can have two different modes:
For Sphinx installed on the same server with your Magento store :
- Yes - defines, that Sphinx works on the same server, as store and database. Triggers the following additional options and additional buttons, which allows to manage daemon:
  - Sphinx Bin Path - defines name and location of sphinx daemon. By default it's searchd.
  - Allow auto-start Sphinx Daemon - sets auto-starting daemon with Magento's store. Useful, when you can have unexpected server power-off (for example, for maintenance purpose).
  - Check Status - button, that allows to view current daemon status
  - Restart Sphinx Daemon - button, that allows to restart daemon directly from Magento Configuration pane.
  - Reset - button, that allows reset daemon current search task.
For Sphinx installed on the dedicated (remote) server :
- No - defines, that Sphinx works on separate or dedicated server.
  - Generate configuration file - button, that allows to generate Sphinx config file to copy to your remote (dedicated) server.
Search Engine Configuration section contains Additional Configuration subsection, visible for External Sphinx engine only. It allows you to tune up Sphinx configuration file, and contains the following settings:
- Custom Base Path - defines custom path to Sphinx, if it was installed not to the default [magento_root_directory]/var/sphinx/ location.
- Additional searchd configuration - defines additional parameters to searchd Search Daemon. Read more about it here.
- Additional index configuration - allows to add settings to the Sphinx index configuration. Read more about it here.
- Custom Charset Table - allows to add character sets to the Sphinx configuration file. Read more about it here.
Elastic Search Ultimate

Magento 2 Elasticsearch Extension, as it derives from its name, allows you to use Elastic Engine on the dedicated server, or on the same server of your store.

Elasticsearch is a distributed, RESTful search and analytics engine capable of solving a growing number of use cases, written on Java so it can be run virtually anywhere. It is best used for stores with more 50k of products and/or support of Layered Navigation. Read more about its key features.

Elastic Search Ultimate adds to the option Global Search Configuration -> Search Engine Configuration -> Search Engine possible value Elasticsearch Engine.
Note
To start with, please, make sure that you have installed Elastic Search Engine.

Elasticsearch Engine also triggers additional options for configuring and managing Sphinx Daemon:
- Elasticsearch Host - elastic host (127.0.0.1 by default).
- Elasticsearch Port - elastic port (any free port, but typically 9200).
- Elasticsearch Index Prefix - specifies index name for current Magento store.
It also features two buttons, that allows you to check Elastic Search connection:
- Check Status - button, that allows to view current Elastic status
- Reset - button, that resets Elastic current search tasks.

Back to Top

Search Settings

Wildcard search - allows customer to search the product by part of the word, marking unknown part with asterisk (*). There's four different wildcard modes available:
- Enabled (*word*) - fully enables wildcards.
- Enabled at end (word*) - partially enables wildcards, allowing to search by first part of keyword.
- Enabled at start (*word) - partially enables wildcards, allowing to search by last part of keyword.
- Disabled - totally disables wildcards.
  Note
  Wildcards enabling slightly reduces the relevance of search and increases the number of search results.
Enable redirecting from 404 to search results - if option is enabled, customer will be redirected to the store search results of the broken URL text instead of the "404 Not Found" page.
Redirect if there is a Single Result - if the search query results only have one match, the customer will be immediately taken to to corrresponding product page.
Enable Google Sitelinks Search - if option is enabled, the extension shows the Sitelink Search Box on the Google search results page. After enabling the option, the search box will be shown only after Google reindexing.
Enable search terms highlighting - if option is enabled, search query word(s) will be highlighted in the search results.
Display Related Search Terms - if option is enabled, related search terms will be displayed on the search result page.
Max number of items in the result - sets the maximum number of items in the search result. Set 0 to disable limitation.
Wildcard Exceptions - the list of keywords (characters) for which wildcard search can not apply.
Replace words in search query - two-column list of auto-replace. When evaluating search extension will seek keywords from Find word columns, and automatically replace with the one from Replace With column. Column Find word can contain more than one keyword, separated by comma.
Not' words - words from this list invert search. E. q. appearance of these words in search automatically treated as "exclude results with this word".
Long Tail Expressions - allows you to receive the correct search results for words that contain dashes or any other non-alphabetic symbols. Read more in Long Tail Configuration section. Or read our article in Mirasvit Blog about the feature
Minimum number of characters - to search-specifies the minimum amount of characters, which triggers autocomplete drop-down list. It works only when mirasvit/module-search-autocomplete is installed and enabled.
Match mode - overrides default Magento mode of search with one of the following options:
- AND - this mode is default. Elements (e. q. products, pages) matched only when all requested keywords are found in respective attributes.
- OR - defines, that elements matched only when at least one of requested keywords is found.

Back to Top

Multi-store Search Result

This option is useful when you have store-dependant elements in your store. For example, you have products which are visible only in specific storeviews and you wish to allow customers to search simultaneously in all your stores.

Enable Multi-Store Search Results - if you enable this option, search results will be displayed in tabs. Each tab has a number of results for a storeview and corresponds to one of your storeviews. This option triggers an additional sub-option:
- Stores - allows you to select, which storeviews should be included in a multi-store search.
  Note
  Multi-store search results work only on the search results page (when visitors click on the tab it redirects them to the selected storeview.).
  
  Autocomplete always returns results from the current store only. It can not display search results from another storeviews.

Back to Top

Configure "Long-Tail" Search

This section describes the Long-Tail Search feature, that will allow you to have correct search results for words that contain dashes or other non-alphabetic symbols. You can also replace on-the fly the most typical errors customers can make in complex product names.

What is Long-Tail Search?
Configuring Long-Tail Expressions
Examples of Long-Tail Expressions
Moving Long-Tail Expressions from M1 to M2

What is Long-Tail Search?

For example, we have a product Canon PowerShot SX500 IS. But customer can request Canon PowerShot SX-500IS, which default search will not find, because it differs from actual product label.

It's because Magento by default during reindex uses only correct product labels from database, and thus, index will contain only them - making products with complex names "ineligible" for search.

This is where "Long-tail" search come. During reindex and search this feature recognizes the keywords rather by pattern and replaces it either to the empty or some other characters, "correcting" customer's request on-the fly.

In example above the SX500 IS can be converted to the SX500IS and during the search, the SX-500IS also be converted to the SX500IS by replacing '-' symbol to empty char.

This way search will be able to find products by several combinations of spelling the product's name.

Also, please learn more about configuring Long-Tail Search for your store in our Blog article.

Back to Top

Configuring Long-Tail Search

Go to System / Search Management / Settings / Mirasvit Extensions / Search
In the section Search Settings go to the option Long tail.
There you can set up regular expressions to receive required search results.

Match Expression - the regular expression(s) that parses words for further replacing.

Parsing goes for search index, during an indexing process, and goes for search phrases during search. E.g. /([a-zA-Z0-9]*[\-\/][a-zA-Z0-9]*[\-\/]*[a-zA-Z0-9]*)/
Replace Expression - the regular expression(s) to parse characters to be replaced. Parsing goes in the results of "Match Expression". E.g. /[\-\/]/
Replace Char - the character to replace values founded by "Replace Expression". E.g. empty value.

Back to Top

Configuring Long-Tail Search

Here is some of most useful cases of long-tail search, implemented as corresponding rules.

Automatically remove '-' symbol from product names

Create a rule with the following parameters:
- Match Expression - /[a-zA-Z0-9]*-[a-zA-Z0-9]*/
  Matched text: SX500-123, GLX-11A, GLZX-VXV, GLZ/123, GLZV 123, CNC-PWR1
- Replace Expression -/-/
- Replace Char - empty
  Result text: SX500123, GLX11A, GLZXVXV, GLZ/123, GLZV-123-123, CNCPWR1
Automatically remove '-' and '/' symbols from product names

Create a rule with the following parameters:
- Match Expression - /[a-zA-Z0-9]*[ \-\/][a-zA-Z0-9]*/
  Matched text: SX500-123, GLX-11A, GLZX-VXV, GLZ/123, GLZV 123, CNC-PWR1
- Replace Expression - /[ \-\/]/
- Replace Char - empty
  Result text: SX500123, GLX11A, GLZXVXV, GLZ123, GLZV123, CNCPWR1
Automatically make solid all products names with separators

Create a rule with the following parameters:
- Match Expression - /[a-zA-Z0-9]*[-\/][a-zA-Z0-9]*([-\/][a-zA-Z0-9]*)?/
  Matched text: SX500-123, GLX-11A, GLZX-VXV, GLZ/123, GLZV-123-123, CNC-PWR1
- Replace Expression - /[-\/]/
- Replace Char - empty
  Result text: SX500123, GLX11A, GLZXVXV, GLZ123, GLZV123123, CNCPWR1
Automatically fix misspelled product's name

Create a rule with the following parameters:
- Match Expression - /([a-zA-Z0-9]*[\- ][a-zA-Z0-9]*[\-][a-zA-Z0-9]*)/
  Matched text: VHC68B-80, VHC-68B-80, VHC68B80
- Replace Expression - /[\- ]/
- Replace Char - empty
  Result text: VHC68B80

Back to Top

Moving Long-Tail Expressions from M1 to M2

Long-Tail expressions, which are used in Search Sphinx for M1 and M2 sliightly differ.

In M1 Search Sphinx you can enter one or more expressions to match, separated by '|' character. In M2 you can not.

Consider the following expression for Search Sphinx for M1:

Example

Match Expression: /[a-zA-Z0-9][ -/][a-zA-Z0-9]([ -/][a-zA-Z0-9]*)?/|/[a-zA-Z]{1,3}[0-9]{1,3}/
Replace Expression:/[ -/]/|/([a-zA-Z]{1,3})([0-9]{1,3})/
Replace Char:$1 $2

It actually contains two separate regexps to match: /[a-zA-Z0-9][ -/][a-zA-Z0-9]([ -/][a-zA-Z0-9]*)?/ and /[a-zA-Z]{1,3}[0-9]{1,3}/ with respective separate expressions for replace.

You need either to reformat that expression, so it will match in single expression, or rewrite this rule as a set of two:

First rule

This rule will implement the first part of original M1 expression.
- Match Expression: /[a-zA-Z0-9][ -/][a-zA-Z0-9]([ -/][a-zA-Z0-9]*)?/
- Replace Expression:/[ -/]/
- Replace Char:$1 $2
Second rule

This rule will implement the second part of original M1 expression.
- Match Expression: /[a-zA-Z]{1,3}[0-9]{1,3}/
- Replace Expression:/([a-zA-Z]{1,3})([0-9]{1,3})/
- Replace Char:$1 $2

Back to Top

Manage Landing Pages

Landing search page is special search result page, with a static URL, where customers are redirected on using some search expression.

Let us have a large number of frequently asked (or just a promotional set) models of Samsung phones with black coat. So we create a separate promotional page, say, http://store.com/black-samsung-phone.html, and bind it to the search phrase "black samsung phone". Then, when customer will request a black Samsung phone, it will be immediately sent to your special page.

Also it supports the following logic .We create a separate promotional page, say, http://store.com/black-samsung-phone.html, and bind it to the search phrase "black samsung phone". When customer will go to this (specific) URL search results for "black samsung phone" will be immediately built on it.

All such a pages can be managed from System -> Search Management -> Manage Landing Pages grid.

Adding New Landing Page

Go to System / Search Management / Manage Landing Pages and press Add New button.
On creation page fill the following fieds:
- Query Text - the key phrase, which should bring customer to landing page (ex. black samsung phone)
- URL Key - relative path to landing page. For example, if URL key is shoes/all, then full URL would be https://example/shoes/all/.
- Active - activates or deactivated redirect to landing page.
- Page Title - overrides title of that page with yours.
- Meta Keywords - meta keywords, that can be used by search crawlers.
- Meta Description - meta description, that can be used by search crawlers.
- Layout Update XML - overrides XML layout of landing page.
Save and activate landing page.

Manage Synonyms

Synonyms are keywords with the same or similar meaning. All of them are located at System -> Search Management -> Manage Synonyms section.

You can either manually add synonyms, or import them from YAML-formatted file.

Adding New Synonym

Go to System -> Search Management -> Manage Synonyms grid and press Add New Synonym button.
On creation page, fill the following fields:
- Term - is the keyword, which customer could enter to the search box, and which will be replaced with keyword
- Synonyms - comma-separated list of synonyms. It should contain at least one keyword. Each of them should match the following requirements:
  1. It should consist of one word, and only of alphanumeric characters (e. q. without spaces, dashes, slashes and so on).
  2. It should have length, greater than 1 character.
  3. Max length of synonyms list equals 255 symbols.
- Store View - allows to select, where defined synonyms will be applied.
Save record.

Example

Assume, that we have on our stores a set of watches, and need them to be found on "clock" keyword. So we setup Synonym as:

  Term: clock
  Synonyms: watch

Then, if customer issues "clock" query, all watches will be found.

Importing Synonyms

Our extension uses YAML file format for synonyms importing. It should resemble the following format:

-    
    term: [TERM_1]
    synonyms: [SYN_1]
-    
    term: [TERM_2]
    synonyms: [SYN_2]

Name of this file should be equal to your language code in capital case. Codes can be found here, use column 639-1 for that.

Example

Let's create a synonyms file for English locale. Name of such a file would be EN.yaml, and it's content should be:

-
    term: abiogenesis
    synonyms: autogenesis,autogeny,spontaneous generation
-   
    term: abject
    synonyms: low,miserable,scummy,scurvy,resigned,unhopeful
-    
    term: abjection
    synonyms: abasement,degradation
-    
    term: abjectly
    synonyms: resignedly

To import synonyms, perform the following steps:

Place your custom YAML file to [magento_root]/ folder.
Go to System -> Search Management -> Manage Synonyms and press Import Synonyms button.
Dictionary field defines locale (language), to which synonyms are imported. All dictionaries should exist, and have at least one record, since imported data are appended to existing.
Store View defines storeviews, where imported synonyms will be applied.
Press Import to import and apply synonyms.

Manage Stopwords

Stopwords are words that have little lexical meaning or ambiguous meaning and are not useful during the search (ex. and, or, the, a, with, etc). Therefore, these words should be removed from search phrases to make them relevant.

You can either manually add stopwords, or import them from YAML-formatted file.

Adding New Stopword

Go to System -> Search Management -> Manage Stopwords grid and press Add New Stopword button.
On creation page, fill the following fields:
- Stopword - is the keyword, which should be removed from search requests.
- Store View - allows to select, where defined synonyms will be applied.
Save record.

Importing Stopwords

Our extension uses YAML file format for stopwords importing. It should resemble the following format:

    [ID_1]:[Stopword_1]
    [ID_2]:[Stopword_2]
    [ID_3]:[Stopword_3]

Name of this file should be equal to your language code in capital case. Codes can be found here, use column 639-1 for that.

Example

Let's create a stopwords file for English locale. Name of such a file would be EN.yaml, and it's content should be:

    1:"but"
    2:"now"
    3:"what"
    4:"except"

To import stopwords from such a file, perform the following steps:

Place your custom YAML file to the special [magento_root]/ folder.
Go to System -> Search Management -> Manage Stopwords and press Import Stopwords button.
Dictionary field defines locale (language), for which stopwords are imported. It is picked from the name of your YAML import files.
Store View defines storeview, where imported stopwords should be applied.
Press Import to import and apply stopwords.

Score Boost Rules

Score Boost Rules are powerful tool, which allows you to affect relevancy of search results, depending on certain conditions.

When Mirasvit Search extension builds search results, it groups them by indexes' position and their position in System -> Search Management -> Settings -> Search Autocomplete -> Searchable Content. Groups can include Products, Pages, Categories and so on - they can be defined in System -> Search Management -> Search Indexes.

But inside these groups items are listed strictly by their relevance to search query, which calculated for each item separately as item rank. Position in search results list depends from this rank value.

Score Boost Rules allows you to increase or decrease this rank depending on item properties, which allow you to move certain products to the top or botton of list, which is extremely useful for promotion and marketing purposes.

Creating a new Rule

To create a new Score Boost Rule, navigate to System -> Search Management -> Score Boost Rules section and press Add New Rule button.

You need to define the following properties to create a Rule/

Title - sensical title of the Rule
Active - whether Rule is active and should be applied to Search Results
Active (date) - a time period, when Rule should apply to Search Results. Leave empty to have Rule always applicable.
Store - storeviews, where current Rule should be applicable.
Score Factor - score adjustment, that should be added or subtracted from rating, generated by search engine.
- Action - action, that should be performed. Can have only two possible values.
  - Increase By
  - Decrease By
- Rank Adjustment - numerical value, that should be added or subtracted from rating.
- Metric - defines, how Rank Adjustment shall be used for adjustment. Can have two possible values:
  - Points - in this case Rank Adjustment just added to the actual rating.
  - Times - in this case actual rating is multiplied by Rank Adjustment. Used to rocket-jump products to the top (for example, promotional products).
- Parameter - defines, which rating shall be adjusted by the Rule.
  - Initial Score - rating, which was generated by search engine.
  - Product Popularity - popularity rating, that is defined as quantity of orders with products, that meet conditions below.
  - Product Rating - product rating, that is defined as quantity of reviews for products, that meet conditions below

Conditions are broken into two parts.

Apply the rule only for following products - allows you to define, which combination of products makes Rule apply.

Note
To add additional conditions please go to Stores - Attributes - Product, select a necessary attribute, for example, SKU, open edition in the tab Storefront Properties, and set Yes for the Use for Promo Rule Conditions, clean Magento cache after saving.
Apply the rule only when the following conditions are met - allows you to filter Search Query, to which Rule shall apply.

Both of them use the same pattern, as other rules in Magento 2, and enclosed into logical blocks If ALL of these conditions are TRUE/FALSE (products meet conditions, when all of them apply) or If ANY of these conditions are TRUE/FALSE (product shall meet only one of defined conditions).

Here are few useful examples, that demonstrate, how Score Boost Rules work.

Examples

Erin Recommends Promo

This example allows you to move products, that were recommended by your editorial board (it is defined by custom attribute Erin Recommends), to the top of search results.

Title: Erin Recommends Promo Score Factor: Increase by 10 points Initial Score Apply the rule only for the following products:
- Erin Recommends is Yes
Analog Watches to the End

This rule drops to the very bottom all analog watches, when customer search includes "watch" keyword.

Title: Analog Watches to End Score Factor: Decrease by 2 times Initial Score Apply the rule only for the following products:
- Product Name contains analog Apply the rule only when the following conditions are met:
- Search Query contains watch
New Products Promo

This example allows you to uplift promotional products higher than others, but not necessary at the top.

Title: New Products Promo Score Factor: increase by 5 points Initial Score Apply the rule only for the following products:
- New is Yes

Customize Search Weight

Our extension arranges relevance of found products using Global Settings. But sometimes (for example, for promotional purposes) you need to forcibly move one or more specific products to the top, or vice versa, to the bottom of search results.

It can be done via special option Search Weight, added by our extension to the general settings of the Product Edit Pages.

This weight is the relative position, where product will be placed on search result page. It ranges from 100 (product or category will always appear at the top of search results list) to -100 (product or category will always appear at the bottom of search results list).

Troubleshooting

This section contains the most common problems, that customer can encounter, and how they can be resolved:

Search is not possible by SKU
After enabling fallback search and entering too many words, search fails
Autocomplete (and/or Search Results) is too slow
Aheadworks blog search doesn`t return results
"unknown column" error while Sphinx reindex
Long reindexing time
Error: Please make sure you use different sphinx ports for all these instances
Strange search terms
No alive nodes found in your cluster

Note

Please, make sure, that you're using the last version of the extension. Otherwise, please, update it to the latest version.

Search is not possible by SKU

Please, make sure about the following:

SKU attribute is searchable. You can check it in Stores -> Attributes -> Product grid -> SKU -> Storefront Properties -> Use in Search and Visible in Advanced Search should be Yes.
SKU is in the list of Searchable attributes in Product Index. You can check it in System -> Search Management -> Search Indexes -> Product Index.
If SKU includes dashes or other non-alphabetic symbols, set up Long-Tail Search expressions.
Validate search result. Go to System -> Validator -> Validate Search Results. In Search term field enter your SKU, in Product ID - ID of the product with not searchable SKU and press Validate Search Results.

After enabling fallback search and entering too many words, search fails

Possible cause: too small max_execution_time PHP parameter, which is not enough to complete requests with large number of words.

Solution: there can be two possible solutions.

Increase max_execution_time parameter either in .htaccess, or directly in PHP.ini.
Use default Magento settings to adjust search parameters. They are located at Stores -> Configuration -> Catalog -> Catalog Search and consist of two options:
- Minimal Query Length - defines minimal quantity of words in search request (1 for default).
- Maximum Query Length - defines maximal quantity of words in search request (128 by default).

Typically it is enough to decrease the latter parameter, until search will work correctly.

Autocomplete (and/or Search Results) is too slow

Possible Causes and Solutions

Search Engine Settings

How to Check:
- Navigate to System -> Search Management -> Settings -> Search Engine Configuration. If option Search Engine is set to Built-In Engine or MYSQL, this is the probably cause.
How to Resolve:
- If you have Mirasvit MYSQL Search Module version below 1.0.23, upgrade it to latest version. It contains a significant improvement, that speeds-up built-in search engine.
- Enable option Fast Mode in Autocomplete settings at System -> Settings -> Mirasvit Extensions -> Search Autocomplete section.
- If this will not help, consider recommendation from next option.
Large Quantity of Products (for Sphinx Search Pro and Ultimate extensions)

How to Check:
- Navigate to Catalog -> Products section. If you have more than 14k records there, this is the probably cause.
How to Resolve:
- Replace Build-In Engine to External Sphinx Engine in option Search Engine at System -> Search Management -> Settings -> Search Engine Configuration.
  Tip
  Search Sphinx shall be installed first, and then connected (see our user manual - Connecting Sphinx Engine).
- If you use Layered Navigation on your store, consider switching to Elastic Search Ultimate extension. It should improve response time, because it also handles layered navigation requests.
Large Quantity of Products (for Elastic Search Ultimate extension) How to Check:
- Navigate to Catalog -> Products section. If you have more than 14k records there, this is the probably cause.
How to Resolve:
- Replace Build-In Engine to Elastic search Engine in option Search Engine at System -> Search Management -> Settings -> Search Engine Configuration.
  Tip
  Elastic search engine shall be installed first, and then connected to your store (see our user manual - Elastic Engine Configuration).
High-load Crontasks

How to Check:
- Install Cron Scheduler for M2.
- Navigate to System -> Cron Scheduler by KiwiCommerce -> All cron jobs section and System -> Cron Scheduler by KiwiCommerce -> Cron job schedule timeline. Check there execution time and results of crontasks. If some of them are stuck or executed for too long period, this is the probably cause.
How to Resolve:
- Disable or reconfigure all crontasks, which are stuck or taking too much time.
Conflicts with other vendor's search extensions

How to Check:
- Go to Stores - Configuration - Mirasvit extensions - Developer tab on the sub-modules grid click Validate Installation. If there is any possible conflict, we don't recommend to use a few similar extensions, it may cause conflicts and slow down your search speed.
How to Resolve: Disable this extension and check your search speed: php bin/magento module:disable <module_name>

Aheadworks blog search doesn\`t return results

How to Resolve:
- Find and open the following file : Aheadworks/Blog/Block/Post.php
- Find public function getSocialIconsHtml()
- After condition you will see this row $block = $this->getLayout()->createBlock, place this code before $socialIconsBlock = !empty($this->getSocialIconsBlock())?$this->getSocialIconsBlock():'Aheadworks\Blog\Block\Sharethis';
- Replace $this->getSocialIconsBlock() after createBlock with $socialIconsBlock
- You should get your code look like $socialIconsBlock = !empty($this->getSocialIconsBlock())?$this->getSocialIconsBlock():'Aheadworks\Blog\Block\Sharethis'; $block = $this->getLayout()->createBlock( $socialIconsBlock,...

"unknown column" error while Sphinx reindex

If your Sphinx Search Engine installed on same server run the following steps:
- Click "Reset" in Search Engine Configuration (backend)
- Click "Restart Sphinx Daemon" in Search Engine Configuration (backend)
- Reindex Search indexes by running bin/magento indexer:reindex catalogsearch_fulltext (CLI) or in System / Search Management / Search Indexes (Backend)
If your Sphinx Search Engine installed on a remote server run the following steps:
- Click "Generate configuration file"
- Copy generated file to your remote server
- Run killall -9 searchd on your remote server
- Start sphinx daemon using command searchd --config <path to config/sphinx.conf>
- Reindex Search indexes by running bin/magento indexer:reindex catalogsearch_fulltext (CLI) or in System / Search Management / Search Indexes (Backend)

Long reindexing time

1) Whether you have Elastic or Sphinx search Ultimate extension, and use a built-in engine with over 20K products, consider using external search engines. To check your engine settings you may find at System -> Search Management -> Settings -> Mirasvit Extensions -> Search.

2) In case you already use an external search engine, you may check if it has a unique Index Prefix for your store for Elastic Search
or try to stop and restart Sphinx Daemon, then run reindex.

3) You have a Fast Mode enabled at System / Settings / Mirasvit Extensions / Search Autocomplete section: the disadvantages include the increased indexing time of the search index. Otherwise, disable this feature to speed up reindexing time.

4) Additionally disable some options in Product Settings content appearance such as Show Thumbnail, Rating, etc at System / Settings / Mirasvit Extensions / Search Autocomplete section.

5) Make sure there are no duplicate searchable attributes or searchable attributes with search weight = 1 at the Product Index in System -> Search Management -> Search Indexes, otherwise delete those searchable attributes and try reindex.

6) Take a look also on Magento Best Practices for reindexing here.

Error: Please make sure you use different sphinx ports for all these instances

When happens: We installed on our staging/dev/test site and configured different ports on staging and on live. But the sphinx engine is not connecting on our staging site, keep getting the error message:
How to solve:
1) turn off “Allow auto-start Sphinx Daemon”, put a different Sphinx Port (any free port, like 9811, 9812) for each instance;
2) specify the “Custom Base Path” in Additional configuration (for example, for dev store: /home/dev/sphinx/bin/searchd);
3) separately run reindexes on the instances, and then enable “Allow auto-start Sphinx Daemon”.

Strange search terms

Sometimes you can see unwanted, strange search terms in Reports, Hot searches in the autocomplete or in the Related Search Terms and think it is spam or generated by our extension.

Actually, they are the most searched Search Terms in your Magento, more details find in official Magento documentation here. You can clear some of the search terms and it won't appear: go to Marketing > SEO & Search > Search Terms, find the necessary term and delete it, otherwise, you will need to delete them in the database.

No alive nodes found in your cluster

Usually, it is a server error. The cause for the problem can be found in the server logs at /var/log/elasticsearch/ directory. First of all, make sure it is configured properly, reset elastic search indicies from the console curl -XDELETE localhost:9200/* and run re-index bin/magento indexer:reindex catalogsearch_fulltext. Also, here is the best Magento practices to resolve elastic search problems.

Welcome to the Elastic Search Ultimate Guide!

Here you will find everything you need to set up a better search experience.

Go ahead, dive in!

Welcome to the Elastic Search Ultimate Guide!

Go ahead, dive in!

Installation

Installation via composer (preferably)

Installation via direct file upload

Core Search Settings

Search Indexes Settings

Global Search Settings

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note

Wordpress Blog Search Index

Example

Example

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note

Wordpress Blog Search Index

Example

Example

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note

Wordpress Blog Search Index

Example

Example

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note

Wordpress Blog Search Index

Example

Example

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note

Wordpress Blog Search Index

Example

Example

Configure Search Indexes

Managing Indexes

Note

Adding and Configuring New Index

Product Index

Category Index

CMS Index

Attribute Index

Note