1

Search Suite Magento Extension User Guide

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 relevant information before placing orders and should verify that such information is current and complete. All products are sold subject to 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 MageWorx' 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

2

Table of Contents

1. Extension Description…….……………………………………………………………..………….. 42. Extension Installation …….………………………………………………………………..……….. 5

3. Search Suite Settings……………………………………………………………………………….. 6

4. xSearch Search Engine……………………………………………………………………….…… 8

5. Sphinx & Apache Solr………………………………………………………………………………. 8

6. Attributes Prioriy…. ……………………………………………………………………….………… 10

7. Search by Attributes ………………………………………………………………………………… 10

8. Search by Categories ………………………………………………………………………………. 11

9. Search Queries Accuracy ………………………………………………………………………… 12

10. Synonyms for Misspelled Queries………………………………………………………………. 13

11. Stopwords …………………………………………………………………………………………. 14

12. Sales Metrics …………………………………………………………………………………… 15

13. Search Autocomplete…………………………………………………………………………….. 16

14. Standard Results vs Search Suite…….………………………………………………………… 21

15. Support ………………………………………………………………………………………….…. 22

3

1.Extension Description

Integrated with 3 advanced search engines – xSearch, Sphinx and Solr, Magento Search Suite Extension greatly improves default Magento search by making it more user-friendly, accurate and interactive.

Search Accuracy — Process simple & complex search queries with 3 options of search accuracy. Spot mistakes, typos, misspelled queries with synonyms or correct variants (‘Did you mean’…message). Add stopwords that won’t be used in the search process.

Sales Metrics — Check your search performance, the amount of revenue each search query brings and # of countries a certain query was searched from.

Autocomplete Functionality — Automatically suggest the most relevant search results in the AJAX-based pop-up after the first characters are entered. Control what product details are shown in the pop-up. Fully customize the appearance of the autocomplete pop-up window.

Customizable Product Search — Narrow down search results to the specific attribute or category. Display Related Searches. Include CMS pages into the search results.

Search Priority — xSearch automatically calculates the ‘search weight’ of every product. You can define the priority of every product attribute manually, thus changing the ‘search weight’.

4

2.Extension Installation

The extension package includes 4 folders: Search Suite, Search Suite Autocomplete, Sphinx and Solr. The Search Suite package should always be installed the first one. You will find the installation guidelines of the Search Suite and Search Suite Autocomplete parts below.

To install Sphinx and Solr, copy those folders from the package (downloaded on MageWorx site) to your root Magento folder (the folder where your Magento is installed).

To install Search Suite & Search Suite Autocomplete, 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 ‘Search Suite’ or ‘Search Suite Autocomplete’ 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 the System - Cache Management section, choose Refresh under the All Cache drop-down menu and press the Save Cache Settings (if Cache Control is enabled in Magento)

6. Enable the Compilation Mode back (if necessary)

7. Go to System - Configuration - MageWorx tab - Extensions & Support section. If you see Search Suite on the list of the installed MageWorx extensions, the installation is complete.

Installation to a custom template/theme

If you use a custom template or theme you need to copy the extension’s layouts and templates to the folder with the custom design.

Copy all the folders inside app/design/frontend/default/default/ to the folder with your current template and/or theme app/design/frontend/<your_template>/<your_theme>/

Don’t forget to refresh the cache if enabled.

It’s related to the SearchSuite and SearchSuiteAutocomplete folders.

5

3. SEARCH SUITE SETTINGS

To configure the extension, log into Magento Admin panel and go to System - Configuration - MAGEWORX - Search Suite.

�

Here is what each of the settings does:

• Default Search Text – defines the text that is shown in the search bar by default. • Search Query Accuracy – changes how the internal search algorithm works for complex

queries.

6

• Search Engine – here you can pick up one of the 3 available search engines: xSearch, Sphinx or Solr.

• Priority Multiplier – specifies the priority multiplier for calculating the ‘search weight’ value. • Search by Attributes – enables/ disables the attributes selector on the front-end so visitors

could search by a specific product attribute.• Search by Categories – enables/ disables the category selector on the frontend to search

within a specific product category.• Length of Search Field – changes the length of the search field to adjust it to the custom

design. • Redirect to Product – sends a searcher directly to a product page in case when only one

result is found.• Enable ‘Did you Mean’ Functionality – enables the synonyms display on the frontend.

Customers will see the ‘Did you mean...’ message if they have misspelled smth.• Enable Related Searches – shows what other customers searched for using the current

search query.• Enable Search Terms Highlighting – highlights the searched keywords in the found results. • Search CMS – enables the search on CMS pages.• CMS Search Results Fields – lets you select what CMS attributes will be shown in the

results.• Search Category – enables the search by categories.• Category Search Results Fields – allows you to select category attributes that will be shown

in the results. • Category Thumbnail Size – defines a size of a category image shown in the search results.

Also, you can configure the Search Indexes for CMS and Categories in the backend:

�

• Enable CMS Page Index – lets you show/hide CMS pages from search results.• Filter CMS Pages — allows to choose what CMS pages should not be shown in search

results.• Enable Category Index – show/hide Category pages from search results.

7

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 SOLR

The Search Suite integrates Sphinx and Solr engines with Magento. The basic configurations for Sphinx search engine are located here: System – Configuration – MAGWORX -Search Suite - Sphinx.

Under these settings you can set up a Sphinx Config file using the default values, or enter your custom ones.

8

When done, hit the Generate Config button.

To validate the generated file, click the Check Availability button. If some custom setting were entered incorrectly, follow the instructions given in a tooltip.

Additionally, under these settings you can set up Sphnx search results ranker and select a search Matching Type.

The basic configurations for Sphinx search engine are located here: System – Configuration – MAGWORX -Search Suite - Apache Solr.

9

6. ATTRIBUTES PRIORITY Search Suite allows changing the priority of each product attribute. That defines the importance of every attribute in the search algorithm. For example, if a ‘Name’ attribute has the highest priority, the products that contain a search keyword in their names will rank higher in the results.

You can configure the priority for each attribute in Catalog – Search Suite – Manage Attributes

�

7. SEARCH BY ATTRIBUTES

Search Suite adds an attributes selector on the frontend, next to the search box. It helps to narrow down the search results and find more accurate results.

�

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

Attributes that are marked as ‘Search by Attributes’ in Catalog – Search Suite – Manage Attributes will be displayed in the drop-down.

10

�

8. SEARCH BY CATEGORIES

With the extension you can display categories drop-down on the frontend near the search box. It helps to narrow down the search results and find more accurate results.

�

For example: when customers want to find the only furniture items, they can choose ‘Furniture’ category and search only in this category.

Categories that are marked as ‘Use in Quick Search’ in Catalog – Manage Categories are displayed in this drop-down. You can choose this function for each category separately when editing categories.

�

11

9. SEARCH ACCURACY

To specify how the search should work for complex search queries, go to System – Configuration – Search Suite and choose one of the 3 possible options:

�

• 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.

12

10. SYNONYMS FOR MISSPELLED QUERIES

Add an unlimited number of synonyms used for suggesting the correct variant of misspelled search queries. To create/ edit/ manage the synonyms list, go to Catalog – Search Suite – Manage Synonyms.

�

�

13

For example: if you add ’acerr’ as a synonym for the keyword ‘Acer’, customers, who enter it incorrectly, will get the right result.

�

11.STOPWORDS Add stop words that won’t be added to the search indexes. You can do that in Catalog – Search Suite – Manage Stopwords.

�

14

12. SALES METRICS

Track and calculate important sales metrics. Check how your store search works and what revenue different search queries generate. You can find these stats under Reports – Search Terms:

�

For each query there are the following metrics:

• Results – a number of products found for each query• Hits – a number of uses• # Purchases – a number of orders generated by the query• Revenue – a revenue a query generates• Orders/Hits, % – a number that shows what part of all searches lead to purchases• # Country – a number of different countries searched for the query.

15

13.Search Autocomplete

Search Suite Autocomplete feature instantly delivers results right from the search box. To configure the settings go to System - Configuration - MAGEWORX - Search Suite – Autocomplete section.

� 16

This is what each setting is responsible for:

• Show Popup — enables/ disables the extension on the frontend.• Loading Animation – lets you select the animation to portray the loading process. You can

choose between the ‘NProgress’ (the animation used in YouTube) and ‘Spinner’ (Gif or APNG (animated PNG).

• Search Delay – sets a delay period (in milliseconds) that precedes the search.

• Enable Search terms highlighting — if enabled, search keywords get highlighted in the search results.

• Show Fields in Popup — lets you choose what sections will be shown in the search popup.

• Number of Results Suggested Search – limits the number of the suggested search results in the popup.

• Number of Results Product Search — limits the number of product results in the pop-up.

• Products Search Results Fields – here you can define the product attributes that should be shown in the pop-up.

• Show Product Results Grouped by Categories – the setting groups the found results by categories.

• Product Image Size — lets you specify the size of a product thumbnail in the pop-up.

• Category Search Results Fields – hides a category name, description and a thumbnail in the AJAX pop-up.

• Category Thumbnail Size — defines the size of a category thumbnail shown in the pop-up.

• CMS Search Results Fields – hides CMS page title or/ and description in autosuggest pop-up.

17

This is what it looks like on the frontend.

�

18

Also, Search Suite lets you fully customize the appearance of the autocomplete pop-up. You can change its every element: the color of keywords' highlight, background color, font and font size, etc. To do that, go to System - Configuration - MAGEWORX - Search Suite —Autocomplete.

�

You can control all the products’ attributes, which are shown in the pop-up. For example, if you enable all the attributes, the pop-up will look like:

� 19

CMS pages can also be shown on the pages with the standard Magento search results:

�

20

14.Standard Results vs. Search Suite Have a look at the two images below. These are the default Magento search results and these are the results powered with Search Suite.

DEFAULT MAGENTO WITH SEARCH SUITE EXT

21

GOT 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 MAGENTO

MageWorx 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

Copyright © 2015 MageWorx 22