Search Ultimate DocumentationSearch Ultimate Documentation
Here you will find everything you need to set up a better search experience.
This guide is for Magento 2.4 only
Sphinx Search Ultimate Guide for Magento 2.1-2.3
Elastic Search Ultimate Guide for Magento 2.1-2.3
The Search...
InstallationInstallation
On this page, you will find two possible ways to proceed with our extension's installation.
Please note these instructions are valid for Magento 2.4 only. To install the extension on a previous Magento
version, please follow:
Sphinx Search ...
Quick StartQuick Start
Search Ultimate is our most powerful extension which combines all of our best features to enhance the search capabilities of Standard Magento.
It combines several powerful modules, each of which offers you a large set of options:
Core Search ...
General SettingsGeneral Settings
Here you can quickly navigate across all the functionality settings we have available. Please use the list below to navigate.
This section covers all topics necessary for working with indexes, and consists of the following subsections:
...
Configure Key Search SettingsConfigure Key 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 the Search Logic Configuration. It is located at System -> Se...
Sphinx Engine InstallationSphinx Engine Installation
If you want to use our extension with Sphinx Engine, you first need to install it.
Note
Warning: The minimum allowed sphinx engine version is 2.2.x, 3.x
Installation includes a set of actions that should be performed under roo...
Connection with Sphinx EngineConnection with Sphinx Engine
After the Sphinx Engine is installed, you need to connect it to our Search Extension.
Settings are diffenent depending on where you had installed Sphinx - on the same server as a store, or on a dedicated separate server.
Conn...
Configure "Long-Tail" SearchConfigure "Long-Tail" Search
This section describes the Long-Tail Search feature which will allow you to have the correct search results for words that contain dashes or other non-alphabetic symbols. You can also replace the most typical errors customers ...
Customize Search WeightCustomize Search Weight
Our extension arranges the relevance of products found using Global Settings. However, sometimes (for example, for promotional purposes) you need to forcibly move one or more specific products to the top, or vice versa, to the bott...
Configure Search IndexesConfigure 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...
Implementing Custom Search IndexImplementing Custom Search Index
Sometimes it's necessary to have a specific type of Index which is either not included to our search extension, or belongs to some third-party extension. In this case, custom index can be implemented using the following in...
Configuring Autocomplete & SuggestConfiguring Autocomplete & Suggest
All Autocomplete settings are located in the System / Settings / Mirasvit Extensions / Search Autocomplete section.
It consists of the following sections:
General Configuration
Popular suggestions
General Configuratio...
Configure Search Spell CorrectionConfigure Search Spell Correction
All configuration options are located in the Store -> Configuration -> Mirasvit Extensions -> Search Spell Correction section.
There are only two options for now. In both, our extension analyzes the customer's re...
Search Results ValidatorSearch Results Validator
Validator - debugging tool. It is compatible only with the Elasticsearch engine.
It is located in the **System -> Search Management -> Validator** section.
To start validation, enter in the field Search term - wanted search ...
ReportsReports
With detailed search reports, you are able to check how relevant the search is to your customers.
From this information, you will be able to fine-tune your search configuration so that your customers will be led to the products they need.
You can ...
Manage Landing PagesManage Landing Pages
A landing search page is a special search result page with a static URL where customers are redirected by using some search expression.
Let's consider a large number of frequently requested (or just a promotional set) models of Samsun...
Manage SynonymsManage Synonyms
The extension enhances the functionality of native Magento synonyms and provides an additional capability for importing synonyms.
To import synonyms, follow these steps:
Create your custom CSV file using the following file structure.
abl...
Manage StopwordsManage Stopwords
Stopwords are words that have little lexical meaning or ambiguous meaning and are not useful during a search (ex. and, or, the, a, with, etc). Therefore, these words should be removed from search phrases to make them relevant.
You can eit...
Score Boost RulesScore Boost Rules
Score Boost Rules are a powerful tool, which allows you to influence the relevancy of search results, depending on certain conditions.
When the Mirasvit Search extension builds search results, it groups them by indexes' position and thei...
TranslationTranslation
Our extension supports multilanguage stores. To translate it, we have used the same logic as default Magento.
General Information
Example
General Information
All our translation files are in the "/i18n" folder of each sub-module.
...
FAQFAQ
This section describes the most common problems that customers report, and how they can be resolved.
How to make the autocomplete dropdown scrollable and smaller for mobile devices
For this, navigate to the Stores > Settings > Configuration >...
TroubleshootingTroubleshooting
This section contains the most common problems that customer can encounter, and how they can be resolved.
Note
Please, make sure that you're using the latest version of the extension. Otherwise, please update it to the latest version.
Se...
Command line commandsCommand line commands
Our Search extension also has a command-line interface which can be used from a console or SSH.
Here is the list of available commands. (for bin/magento):
mirasvit:search-sphinx:manage - sphinx engine management
mirasvit:search:rein...
Extension UpgradingExtension Upgrading
Please note these instructions are valid for Magento 2.4 only. To upgrade the extension from previous Magento
versions (2.1. - 2.3.), you need to disable and remove the previous extension and install the new one from scratch. To
do so...
Disabling the ExtensionDisabling the Extension
Temporarily Disable
To temporarily disable the extension, please follow these steps:
Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
Run this command to disable the extension:
p...
Change LogChange Log
2.3.7
(2024-12-10)
Fixed
Amasty Shopby Lite compatibility
2.3.6
(2024-12-02)
Fixed
'Exclude out-of-stock' functionality for MSI
2.3.5
(2024-11-13)
Fixed
Amasty Shopby compatibility
2.3.4
(2024-11-04)
Fixed
Sphinx search functionality ...