Draft:Claud Search

X-Cart 4.4or above

Overview

CloudSearch is a SaaS solution that integrates with X-Cart to enable dynamic, real-time product search in an X-Cart based store. With CloudSearch, your customers can search for products instantly: typing a search query produces search results immediately, without loading a new page. Searching with CloudSearch is an incremental process: the search begins as soon as the user types in the second character of the search string and goes on progressively as long as the user continues typing; a list of suggestions and search hits is generated after each key press allowing the user to adjust his or her search strategy in real time.

As its name suggests, CloudSearch runs on our company's cloud infrastructure. On your store's website, there will be just a small widget needed to make CloudSearch work for your customers. Since X-Cart version 4.5.3, the CloudSearch widget is included into X-Cart code. On earlier X-Cart versions (4.4.0-4.5.2), the widget can be enabled by installing the CloudSearch integration module. The module is distributed free of charge to existing X-Cart store owners. CloudSearch service is provided on subscription basis.

Key benefits of using CloudSearch in X-Cart:

• Search as you type: Search results are presented instantly, before the user is even done typing.
• Search hit highlighting: Search results show the exact portions of text where the word or phrase matching the search query occurs, with the words matching the query emphasized by background highlighting.
• Real-time suggestions: The user can stop short of typing the entire word or phrase at any moment and just choose one of the suggested options.
• Automatic spelling corrections: Even if a word has been misspelled, the customer can still find the product by using a closely related option from the presented list.
• Relevant search results: Based on Apache Solr, the industry leading open source enterprise search platform, CloudSearch recognizes word forms and provides other advanced full-text search capabilities.
• Amazingly fast: The CloudSearch widget in your store interacts directly with our cloud without increasing load on your server.
• SaaS architecture: High performance and feature updates are available automatically without the need to upgrade your client software.
• Slick Ajax GUI widget.
• CSS-based layout that can be tweaked to fit any design.
• Compatible with major browsers: Internet Explorer 7 or later, Chrome, Safari (including iOS), Firefox.
• 30 day free trial period.
• Subscription-based plans.

How it works

When a visitor of your store types text in the search field, the CloudSeach widget almost instantly displays a list of search results below the search field. This includes a list of suggestions (popular search queries beginning with the characters the user has typed) and a list of products whose name or description matches the search query. The search results are sorted by relevance, with the most relevant results appearing at the top of the list.

By hovering the mouse over any item in the product search results list, the user can obtain more information about the item: a small fly-out panel displays the product's thumbnail image, name, price and a portion of the product description. Search hits are highlighted both in the product names and product descriptions so the user can quickly see all occurences of the string he or she has typed.

The widget can display up to 3 suggestions and up to 10 product names at a time. If the search returns more results than the widget can display, the link See more results for "<search_string>" is provided at the bottom of the widget. This link can be used to access the 'Search results' page with all the search results for the search query. Please note that at present the results displayed by the 'Search results' page are delivered by standard X-Cart search, not CloudSearch; due to the use of a different search algorithm, these results may differ from the ones displayed by the widget.

CloudSearch offers great search accuracy and flexibility: it can find not only words, but partial words, word forms, upper or lowercase, etc.

If a user makes a spelling mistake while typing a search query, CloudSearch will try to offer corrections so the user can still find what he or she is looking for.

CloudSearch integration module system requirements

To be able to successfully install and use the CloudSearch integration module, you must have a working copy of X-Cart Gold or X-Cart Pro already installed on your server.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

Installation and removal

The CloudSearch integration module installation process is the same for both X-Cart Gold and X-Cart Pro.

To install the CloudSearch integration module:

1. Obtain a distribution package for the module by downloading it from the File Area section of your X-Cart Account account or from this page: http://www.x-cart.com/cloud-search.html. The distribution package you need is archived in the file cloudsearch-xcart-x.y.z.tgz, where x, y and z indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.
2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
   • If you use a Windows-based server or a UNIX-based server without terminal access:

   a) Extract the contents of the archive with the CloudSearch integration module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).

   b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.

   • If you use a UNIX-based server with terminal access:

   a) Use an FTP client to upload the archive with the CloudSearch integration module distribution package to the X-Cart root directory on your server or hosting account.

   b) Decompress the package using the following command:

   tar -xzvf cloudsearch-xcart-x.y.z.tgz

   Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten!

3. In a web browser, run the installation script at httр://www.example.com/install-cloudsearch.php, replacing www.example.com with the actual domain name of your X-Cart based store.
4. Enter the Auth code, accept the License Agreement and click the Next button.

   Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it on the Summary page in X-Cart Admin area before the License info subsection. Another way to find out the code is to retrieve the value of the variable $installation_auth_code from the file<xcart_dir>include/install.php .

5. The installation script copies the files and activates the module. Click the Next button to continue.
6. The installation script generates a new system fingerprint. Click the Next button to complete the installation.
7. Use the ADMINISTRATOR AREA link to log in to the Admin area.

To uninstall the CloudSearch integration module:

1. In a web browser, run the installation script at httр://www.example.com/install-cloudsearch.php, replacing www.example.com with the actual domain name of your X-Cart based store.
2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.
3. Once the installation script has removed the CloudSearch integration module files and deactivated the module, click the Next button to complete the uninstallation.
4. On the Uninstallation complete screen, click Next to leave the Wizard.
   
   Important: After you have uninstalled the CloudSearch integration module, be sure to remove the CloudSearch integration module distribution package from your web directory as well.

Enabling the CloudSearch integration module in X-Cart

After the CloudSearch integration module installation has been completed, the module needs to be enabled in your store.

To enable the CloudSearch integration module:

1. In the X-Cart Admin area, go to the Modules section (Settings -> Modules).
2. In the list of modules, choose the "CloudSearch" item by selecting the respective check box on the left.
3. Scroll down to the bottom of the page and click the Apply changes button. This activates the module.

The module does not require any additional configuration and will work out of the box.