Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Search Settings

Search Settings

The search settings control the behavior of searching and browsing in Commerce Manager. The following table describes these settings.

Setting name (path) Description

COMMERCE/SEARCH/indexOptimizationInterval

Specifies how often the index is optimized. Optimization is generally only needed when the index has had a large number of updates (adds/deletes), so if the index is updated frequently, you may want to specify a higher frequency. For more information, see Scheduled Jobs (Search Server).

COMMERCE/SEARCH/maxReturnNumber

The maximum number of matching items to include in search results. The default is 0, which specifies no limit.

COMMERCE/SEARCH/minimumSimilarity

Used for fuzzy searching. This specifies how similar the matching terms must be to the query term. It must be set to a value between 0 and 1, not inclusive. (1 would mean it must be an exact match and 0 would mean the terms do not match need to match at all.) Default is 0.75.

COMMERCE/SEARCH/prefixLength

Used for fuzzy searching. Specifies the number of characters at the start of the search term that must be the same in potential matches. Default is 0.

COMMERCE/SEARCH/minimumResultsThreshold

Used for the spell checker. Results that are below or equal to this number will trigger a spelling suggestion lookup. Default is 10.

COMMERCE/SEARCH/maximumResultsThreshold

Used for the spell checker. Results that are above or equal to this number will trigger a spelling suggestion lookup. Default is 10000.

COMMERCE/SEARCH/minimumSuggestionsPerWord

Used for the spell checker. The maximum number of spelling suggestions to return. Default is 3.

COMMERCE/SEARCH/accuracy

Sets the accuracy of spelling suggestions. This value works the same as minimumSimilarity. Default is 0.75.

COMMERCE/SEARCH/boosts

Optional. Specifies a comma-separated list of field name/value pairs that specify greater importance to values matched in specific fields. For example:

categoryCode=0.5,productCode=0.5,
categoryName_en=2.0,description_en=0.2

By default, all search fields are assigned a boost value of 1.0.

COMMERCE/SEARCH/excludeAttributes

Optional. Specifies a comma-separated list of attribute keys that should be not be included when searching all fields. For example:

A00981,A01012

By default, all attributes are included.

Configuring Search Settings

The following indexes are used to optimize sorting, searching, and browsing:

  • category
  • customer
  • product
  • promotion
  • cmuser
  • shippingservicelevel
  • sku

Search settings can have different values for each of these indexes, depending on the application (Commerce Manager client or web services). Search settings also affect search behavior at the store level, so they can have a different value for each combination of index and store. As such, the context of a search setting value must specify the index to which it applies, and either the application or the store. For example, the COMMERCE/SEARCH/maxReturnNumber setting lets you configure the maximum number of search results to return. To set the maximum number of results when searching for products (the Product index) in the Commerce Manager client (identified by RCP), the context must be set to the following:

APPSPECIFIC/RCP/product
Note:

The context is case-sensitive.