HCL Commerce Version 9.1.15.0 or later

Enabling deep search sequencing

Deep search sequencing refers to the process of ordering products within a category and all its subcategories. This process is used to enhance the storefront by enabling category-based browsing flows for your customers.

Before you begin

Ensure that you have enabled ExpandedCategroyNavigation in the Management Center. ExpandedCategroyNavigation behaves in the following way:
EnableDeepProductSequence : false
Category navigation browsing shows products based on the product sequence only.
EnableDeepProductSequence : true
Category navigation browsing products is based upon both category and product sequence.

About this task

When this feature is enabled, a new globalsequence field will be added in the product index. This field includes category level sequences based on the catalog. The new field is used for sorting along with the product sequence when searching via category navigation.
For example, consider a product that is available in the following category hierarchy for a calalog, [10502]:
{1}Apparel [1] > {10001}Woman [2] > {10013}Dresses [3]
The new field will have three fields for the catalog category, similar to the following:
globalsequence  : {
10502-1 : 000100000200000300
10502-10001 : 000200000300
10502-10013 : 000300
}
Here, the format of the category sequence is based on the GlobalSequenceFormat configuration specified in the following Zookeeper configuration endpoint.
GET/PATCH http://baseUrl:port/api/v2/configuration?nodeName=ingest&envType=auth 
By default, the parameter value is 4.2. That means it considers the category sequence value up to two decimal points and generate a six digit sequence, as in the following example.
Input vs output 3.4444 => 000344, 23.3=>002330, 3.0=>000300
Note: Deep sequencing supports only non-negative sequence values.

Procedure

  1. To enable deep sequencing, update the EnableDeepProductSequence parameter with the value true using the following REST API endpoint.
    PATCH httop://baseUrl:port/api/v2/configuration?nodeName=ingest&envType=auth
    {"global": {
            "connector": [
                {
                    "name": "attribute",
                    "property": [{
                            "name": "EnableDeepProductSequence",
                            "value": "true"
                        }
                    ]
              }]
    }
    }
    
  2. Restart the Query server. For more information, see Starting the Query Docker container with default configurations.
  3. Perform a reindex operation. For more information, see Building the Elasticsearch index.

What to do next

After enabling deep search sequencing, you can browse the storefront and see that products are sequenced across a category and all of its subcategories.