Thank you for purchasing our extension. If you have any questions that are beyond the scope of this document, do not hesitate to leave us an email via our email address below.

Created: 15/11/2016 | By: Magenest |

Support Portal: http://servicedesk.izysync.com/servicedesk/customer/portal/49 

 


Introduction

Highlight Features

- Indexing the store content, including products and categories, and neatly store them in the server.

- Specify a list of synonyms for better search relevance.

- Specify a list of stopwords for less unrelevance search results.

- Specify maximum number of results.

- Specify replace words which will be applied in search queries.

- Specify frequently searched terms (future version).

- Specify related search terms (future version).

- Specify additional index and search daemon configuration.

- Fast and relevant search results.

System Requirements

 Your store should be running on Magento 2 Community Edition version 2.1.

 


 

Main Functions


We have created Magenest Sphinx menu which enable admins to manage all of things regarding Sphinx extension for Magento 2. 

 

 


First of all, you need to set configuration before using the extension.

Go to Stores > Configuration > Sphinx Search > Search Configuration.

There are three drop-down menus will be shown, include:

- Search Engine Configuration.

- Host Configuration.

- Search Settings.

 

 

 

(plus) Search Engine Configuration

The extension provides three options, include: My SQL, Sphinx Engine and Built-in Sphinx Engine. Admin will pick one of them to make as default for searching.   

We recommend that you should choose the option named Sphinx Engine.  



(plus) Host Configuration

At Host configuration drop-down list, there are some fields admin need to set, includes:

+ Sphinx Host: localhost (Default).

+ Sphinx Post: 9315 (Default).

+ Sphinx Bin Path: searchd (Default). 

 

 

(plus) Restart Sphinx Daemon: In the first use, admins will need to click on Restart Sphinx Daemon button to start using. A notification will be shown to inform you that Sphinx Daemon works successfully. 



(plus) Check connection status: After clicking on Restart Sphinx Daemon button, admin will need to check connection status by clicking on Check Connection Status button. A notification will be shown to inform you that Sphinx search extension and your store have connected successfully together. 

 



+ Reset: Admin will click on the Reset button if they want to make all of things to the original status. 

(plus) Additional Configuration

If admins have knowledge about the Sphinx platform, they can type text in HTML format in the two fields:

(minus)  Additional index configuration. 

(minus)  Additional searchd configuration.    

 

 

(plus) Search Settings


+ Wildcard search: There are 4 options enabled: 

(minus) Enabled (*word*) - This option allows to find  products and show them in the search results if the search phrase is contained in the beginning, end or in the middle of the product. 

Example: If the search query is "age", search results can be: "agent", "Magenest" and "image". 

(minus) Enabled at end (word*): This option allows to find products which only start by the search phrase.  

Example: If the search query is "age", search results can be: "agent" or "agency", but not: "image" or "Magenest". 

(minus) Enabled at start (*word): This option allows to find products which only end by the search phrase.    

Example: If the search query is "age", search results can be: "image" or "Sage", but not "Magenest" or "agent".              

(minus) Disabled: This option allows to show all search results exactly as the search phrase. 

Example:If the search query is "age", search result can be only for "age", but not for "agent" or "Magenest" or "image"

 

+ Result Limit: This feature allows admin to set maximum number of the search results. 

(question) Example:

If admins enter 100 at Result Limit field, the search results will be shown to maximize 100 results. 

 

+ Wildcard Exceptions: The list of words (characters) for which no wildcard rules will be applied.

(question) Example:

If Wildcard search is enabled, when customers search query 'Extension' then the search results will also return products with "Extensions" word. If admins add 'Extension' to exceptions list, search will return only 'Extension' results.

If admin want to add more words into Wildcard Exception, admins only click on Add button to add. 

 

+ Replace words in search query

The words from the left column will be replaced by words from the right column.

(question) Example:

If the search phrase is "Magen" entered by customers then "Magenest" is the real word searched by the search engine.

 

+ Long Tail Expressions.

 


(plus) Go to Magenest Sphinx > Stopwords. Then a Stopword page will be shown allowing admins to add stopwords into database as well as manage them.  

Stopwords are words which are not really useful for search because they have little lexical meaning or ambiguous meaning. This feature allows the search engine to remove these words from the search phrase automatically. 

 

 

(plus)  Add New Stopword

In order to add a new stopword, please click on Add New Stopword button. Then a New stopword page will be shown.

There are two fields that admins need to set, include:

(minus) Stopword: Admins need to enter a word that they want to remove this word from the search phrase entered by customer. 

(minus) Store: Default Store View. 

Please click on Save button to complete. 

(question) Example:

"a" is a stopword added by admins on Magento's backend. 
If the search phrase is " a laptop", the system will be removed "a" from the search phrase. "laptop" is really the searched word (not "a laptop").      

 


(plus) Go to Magenest Sphinx > Synonyms.

Synonyms are words which have the same or nearly the same meaning. This feature allows customers to find both the search phrase entered and its synonyms. 

(plus)  Add a new synonym

In order to add a new synonym, please click on Add New Synonym button. Then a New term page will be shown which allows admins to add manually a word with its corresponding synonyms according to the store owner's wish.



There are three fields to be set:

(minus)  Term: Admins will enter the word that they want to create the list of synonyms for it. 

(minus)  Synonyms:  The list of replacing synonyms (use comma as separator).

(minus)  Store: Default Store View. 

Please click on Save button to complete.

(question) Example: 

The search phase is "Big". The search results will show all products regarding both "Big" and "Large". 

 

 

Go to Magenest Sphinx > Products. then Search Indexes page will be shown. 

There are two records that admins need to consider, include:

+ Products. 

+ Categories. 

 

 

(plus) Products

Click on Products, there are two tabs will be shown, include:

 

(minus) General Index Settings

 

 

(minus) Searchable Attributes

There are some available attributes here, admin will add attributes that they want with Weight for searching.

Note: 1-minimum weight and 10-maximum weight. 

 

 

(plus) Categories

Click on Categories, then there are two tabs will be shown, include:      

(minus) General Index Settings

 

 

(minus) Searchable Attributes

There are some available attributes here, admin will add attributes that they want with Weight for searching.

Note: 1-minimum weight and 10-maximum weight. 

 

 

 


Update

 


Support

 


 

Once again, thank you for purchasing our extension. If you have any questions relating to this extension, please do not hesitate to contact us for support.