Extended SearchMagento ExtensionUser Guide

EXTENDED SEARCH USER GUIDE �1

Important Notice

MageWorx reserves the right to make corrections, modifications, enhancements, improvements, and other changes to its products and services at any time and to discontinue any product or service without notice. Customers should obtain the latest information before placing an order and should verify that such information is current and complete. All products are subject to the MageWorx terms and conditions of sale supplied at the time of order acknowledgment.

MageWorx warrants performance of its products to the specifications applicable at the time of sale in accordance with the company’s standard warranty. Testing and other quality control techniques are used to the extent MageWorx deems necessary to support this warranty. Except where mandated by government requirements, testing of all parameters of each product is not necessarily performed.

MageWorx assumes no liability for applications assistance or customer product design. Customers are responsible for their products and applications using MageWorx components. To minimize the risks associated with customer products and applications, customers should provide adequate design and operating safeguards.

MageWorx does not warrant or represent that any license, either express or implied, is granted under any MageWorx patent right, copyright, mask work right, or other MageWorx intellectual property rights relating to any combination, machine, or process in which MageWorx products or services are used.

Information published by MageWorx regarding third-party products or services does not constitute a license from MageWorx to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from MageWorx under the patents or other intellectual property of MageWorx.

Resale of MageWorx products or services with statements different from or beyond the parameters stated by MageWorx for that product or service voids all express and any implied warranties for the associated MageWorx product or service and is an unfair and deceptive business practice. MageWorx is not responsible or liable for any such statements.

All company and brand products and service names are trademarks or registered trademarks of their respective holders.

Copyright © 2015 MageWorx

EXTENDED SEARCH USER GUIDE �2

Table of Contents 1. Extension Description 4........................................................................................

2. Extension Installation 5.........................................................................................

3. General Settings 6................................................................................................

4. xSearch Engine 6.................................................................................................

5. Sphinx and Apache Solr 6.....................................................................................

6. Attributes Priority 7................................................................................................

7. Search by Attributes 7...........................................................................................

8. Search Accuracy 8................................................................................................

9. Synonyms Section 9.............................................................................................

10. Related Searches 10..........................................................................................

11. Search Queries Stats 10.....................................................................................

12. Standard results vs Extended Search Results 11...............................................

13. Support 12..........................................................................................................

EXTENDED SEARCH USER GUIDE �3

1. Extension DescriptionIntegrated with 3 advanced search engines – xSearch, Sphinx and Solr, Magento Extended Search Extension greatly improves default Magento search results.

Search Weight – xSearch automatically calculates the ‘search weight’ of every product. Define the priority for every product's attribute manually, thus changing the ‘search weight’.

Search Accuracy – Process complex search queries with 3 options of search accuracy. Spot mistakes, typos, misspelled queries with synonyms or correct variants (‘Did you mean’…message).

Search by Attribute – Display any products' attributes near the search field to narrow the search results.

Related Searches – Display the results based on what other people have been searching your store for.

Search Queries Stats – Check search keywords that was used to purchase any product from the order.

EXTENDED SEARCH USER GUIDE �4

2. Extension InstallationTo install the extension, please follow the steps below:

1. Disable the Compilation Mode (if enabled)

2. Log out from Magento Admin Panel (if logged in)

3. Unpack the contents of the Extension folder (depending on your current Magento version) from the package file purchased from Mageworx to your Magento root folder

4. Log into Magento Admin Panel

5. Go to System - Cache Management section, select Refresh under the All Cache drop-down menu and press the Save Cache Settings (if Cache Control is enabled in Magento)

6. Run Compilation Mode back (if necessary)

7. Go to System – Index Management and re-index Catalog Search Index

8. Go to System - Configuration - MageWorx tab - Extensions & Support section. If you see Extended Search in the list of installed MageWorx extensions, the installation is done.

Please Note! Extended Search doesn’t use any 3rd party search services. You do NOT need to install anything to make it working, it works out of the box.

EXTENDED SEARCH USER GUIDE �5

3. General Settings To configure the extension, log into Magento Admin panel and go to System - Configuration - MAGEWORX tab - Tweaks – Extended Search.

This is what each setting is responsible for:

• Enable – enables/disables the extension.

• Search Engine - choose one of the 3 available search engines: xSearch, Sphinx or Solr.

• Search Query Accuracy – changes how the internal search algorithm works for complex queries.

• Priority Multiplier – specifies the priority multiplier for calculating the ‘search weight’.

• Search by Attributes – enables/disables the attributes selector on the front-end so visitors could search by a specific product attribute.

4. xSearch Engine xSearch (Extended Search Engine) uses its own search algorithm based on ‘search weight’ of every product. The value is calculated dynamically for each search query.

The algorithm is similar to what is used in major search engines, when each result is sorted based on its ‘weight’ to search queries. This makes the results maximally relevant.

5. Sphinx and Apache SolrExtended Search integrates Sphinx and Solr engines with Magento.

The basic configurations for these engines are here: System – Configuration – MAGEWORX – Extended Search - Sphinx/ Solr.

EXTENDED SEARCH USER GUIDE �6

6. Attributes PriorityExtended Search allows changing the priority of each product’s attribute. For example, if a ‘Name’ attribute has the highest priority, the products that have a search keyword in their names will rank higher in search results.

To configure the priority of each attribute, go to Catalog – Attributes – Manage Attributes – choose an attribute – Quick Search Priority.

7. Search by AttributesAdd an attributes selector on the front-end, near the search box. It helps to narrow down the search results and find more accurate results.

EXTENDED SEARCH USER GUIDE �7

For example, if a customer wants to find ‘Apple’ products only, they can choose the ‘Brand’ attribute and search for products by this manufacturer.

Attributes that are marked as ‘Use in Advance Search’ in Catalog – Manage Attributes will be displayed in this drop-down:

8. Search AccuracyTo specify how search should work for complex search queries, go to System – Configuration – Extended Search and choose one of the 3 possible ways:

EXTENDED SEARCH USER GUIDE �8

• Any – the extension finds the products that contain the whole search query, its separate keywords and their combinations.

For example, when searching for ‘Nokia Lumia’, customers will find the exact match results, the products that contain the keywords ‘Nokia’ and ‘Lumia’ and their combinations, e.g. ’Lumia Nokia’.

• All – the module finds all products that have the whole search query as well as all the combinations that include its separate words.

For example, when searching for ‘Nokia Lumia’, first, customers will see the exact match results -> next, the results that contain the keyword combinations, e.g. ‘Lumia Nokia’ -> and finally, broad matches e.g. ’Nokia is the best smartphone. Lumia is the nice model’.

• Exact – the extension will deliver the results that exactly match the search query.

For example, when searching for ‘Nokia Lumia’, customers will see only those products that exactly correspond to the entered search query.

9. Synonyms SectionAdd synonyms to suggest customers the correct variants of misspelled search queries. To add/ edit/ delete the list of synonyms, go to Catalog – Search Terms:

When a customer types a misspelled search query, they receive a ‘Did you mean…’ message with the correct search result.

EXTENDED SEARCH USER GUIDE �9

10. Related SearchesRelated Searches feature automatically displays the search results based on what other people have been searching your store for.

11. Search Queries StatsTo track what search queries resulted in a purchase, go to Sales - Orders – choose an order – Search Queries:

EXTENDED SEARCH USER GUIDE �10

12. Standard results vs Extended Search ResultsHave a look at two images below. These are Magento search results without and with Extended Search Magento Extension.

Default Magento Search Extended Search

Howtomakeaperfectsearchatyourstore?

Totransformyoursearchintoanamazingtoolandletyourcustomersfindwhattheyarelookingfor,we’drecommendtouseExtendedSearchalongwithSearchAutoCompleteextension.Thisextensionautosuggestsfoundproducts,relatedsearches,categoriesandCMSpagesinthepop-upwhileyourcustomersaretypinginthesearchbox.

EXTENDED SEARCH USER GUIDE �11

13. SupportGot Questions?

MageWorx offers FREE lifetime support and updates for any extension developed for Magento.

If you need support related to MageWorx extension usage, feel free submit a ticket from http://support.mageworx.com

Getting Help with MagentoMageWorx offers outstanding services developing custom tailored solutions for Magento platform to attain your eCommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe. You are most welcome to contact us at sales@mageworx.com

EXTENDED SEARCH USER GUIDE �12