page last edited on 16 April 2018
For each store connected to CloudSearch service we maintain an index of searchable data. The data is pulled from the store using the API provided by the CloudSearch connector module installed in the store. On our servers, the data is indexed (specially prepared for more efficient storage and searching), after which it can be yielded as search results in response to requests coming from the search widget. That is to say, a piece of data can be found by CloudSearch only if it is contained in the index. X-Cart’s products, pages, categories and manufacturers (collectively, these are referred to as “items”) are pulled from your store via the above mentioned API three times a day (every eight hours). This accounts for the 8 hours’ delay between the time you update information on your site and the moment that this information becomes searchable via CloudSearch.
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) as well as products, categories, manufacturers and static pages that have been found to match 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 search results list, the user can obtain more information about the item: a fly-out panel displays a thumbnail image and a text excerpt containing the search hits. For example, for a product you will see the product’s thumbnail image, name, price and a portion of the product description.
The thumbnail images used for static pages are generated from the page screenshots:
Search hits are highlighted 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 “
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.
The module provides a dashboard where the store administrator can view the store’s account information for CloudSearch service:
The dashboard can be reached via the Settings link for the CloudSearch module on the Addons page or in the Catalog -> CloudSearch & CloudFilters section of the Admin back-end.
The central area of the page provides CloudSearch statistics for the store, including the most popular searches that returned search results and the most popular searches that returned nothing. Statistical data is available for three periods: 24 hours, 7 days and 30 days. Search results can be exported to CSV.
The panel titled Account Info shows the module subscription plan info. The panel titled Your Store shows the current number of items (products, categories, manufacturers and pages) in the store. The panel Search Index shows the number of items that are currently contained in the CloudSearch index for your store on our servers.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub.