Add more complex search completion support to your application via the Salesforce B2C Commerce APIs. Before you begin coding, review the SiteGenesis application to see how this feature was implemented.
Review these SiteGensis files to understand how this feature was implemented, for example:
static/default/js/app.jstemplates/default/resources/appresources.ismlpipelines/Search.xmlstatic/default/css/style.csstemplates/default/search/suggestionsbeta.ismltemplates/resources/search.propertiessg20_demo_data_no_hires_images/meta/system-objecttype-extensions.xmlWhen you implement this feature, you need to consider the performance impact. The SiteGenesis implementation shows suggestions as a popup immediately after the customer starts entering text in the search field. The popup’s HTML content is fetched using an asynchronous AJAX call. The SiteGenesis application executes the AJAX calls in a gracefully way as follows:
Use the B2C Commerce APIs to customize your code. The Suggest API consists of the following:
dw.suggest.SuggestModel class: main access point to obtain suggestionsdw.suggest.Suggestions class: container for bundling suggested items (for example, products), suggested phrases, and the specific terms of a particular type (for example, auto completed products names), for example, dw.suggest.ProductSuggestionsdw.suggest.SuggestedTerms class: lists of terms suggested for a single term of the customer inputdw.suggest.SuggestedTerm class: provided by specific classes such as SuggestedProduct or SuggestedContent. Each SuggestedTerm object represents a single suggested term and its associated attributes and flagsdw.suggest.SuggestedPhrases class: represents one or more search phrases suggested by B2C Commercedw.catalog.ProductSearchModel.getSuggestedSearchPhrase method: provides the corrected search phrase as a hint on the search results page.See the B2C Commerce APIs for more information.
Match Types
Matches are defined as follows:
| Match Type | Ranking Priority | Description |
|---|---|---|
| Exact | 1 | The original and suggested terms are exactly equal |
| Auto completion | 2 | The original is a prefix of the suggested term. |
| Fuzzy | 3 | The original and suggested terms differ by a few characters, similar to spell correction |
The match types and ranking described here is only applicable for suggested terms, that is, auto completion and auto correction. It doesn’t affect any search results or sorting rules.
Note
j