Setting up your custom search profile

The endpoint for the profile is:

https://data_environment_hostname:30921/search/resources/api/v2/documents/profiles/profileName

For the full REST API specification, see the Query REST API.

Each profile document is in .json format and has the following structure. (This example shows the Elasticsearch Highlighting feature; for more information about this feature, see Highlighting in the Elasticsearch Guide.)

{
	"indexName": "string",
	"parentProfileName": "string",
	"profileName": "string",
	"query": {
		"highlight": {
			"fields": [
				"name",
				"fieldName"
			],
			"simplePre": "<strong><span class=font2>",
			"simplePost": "</span></strong>"
		},
		"params": [
			{
				"paramName": "value"
			}
		],
		"postprocessor": [
			"postprocessorClass"
		],
		"preprocessor": [
			"preprocessorClass"
		],
		"provider": [
			"providerClass"
		],
		"queryFields": [
			"field1",
			"filed2"
		],
		"responseFields": [
			"field1",
			"filed2"
		],
		"sortFields": {
			"key": "value"
		},
		"spellcheck": {
			"limit": "5"
		},
		"group" : {
			"enable" : "false",
			"sort" : "score desc",
			"field" : "relationship.product.group"
		},
		"hero" : {
			"overrideFieldName" : "url.thumbnail",
			"showGroupPriceRange" : "false",
			"field" : {
				"7741124012283334335" : "Hero"
			}
		}
	}
}

You can use a Lookup profile if the Hero Product Image is enabled. When the term search API has grouping enabled, it uses the Lookup profile to get the group owner (parent product) details. The term search API uses the HCL_findProductsBySearchTerm profile, which has a Lookup profile property with value HCL_findCatalogEntryById. You define the Lookup profile as follows:

{
      "parentProfileName" : "",
      "profileName" : "HCL_findProductsBySearchTerm",
      "lookupProfileName" : "HCL_findCatalogEntryById",
      "indexName" : "product",
      "query" : {

Internally the SearchRelevancyByProductGroupingPostprocessor processor uses the Lookup profile to fetch the product details. Similarly, if a Hero Product Images is enabled for category browsing then the HCL_findProductsByCategory profile has the Lookup profile property with value HCL_findCatalogEntryByIdForBrowse. Internally, the SearchBrowseRelevancyByProductGroupingPostprocessor processor uses the Lookup profile to fetch the product details.

{
      "parentProfileName" : "",
      "profileName" : "HCL_findProductsByCategory",
      "lookupProfileName" : "HCL_findCatalogEntryByIdForBrowse",
      "indexName" : "product",
      "query" : {

The HCL_findProductByIds_Details profile is configured with lookup profiles as follows. If you override the profile, ensure that you do not change the LookupProfileNames key. If no lookup profile is specified the call will fall back to the default profiles which are mentioned below in the default HCL_findProductByIds_Details profile.

{
     "profileName" : "HCL_findProductByIds_Details",
     
     "indexName" : "product",

     "lookupProfileNames" : {
          "productSKU" : "HCL_findCatalogEntrySKUs",
          "variantSKU" : "HCL_findCatalogEntrySKUsByVariantIds",
          "component" : "HCL_findCatalogEntryComponents",
          "merchandisingAssoc" : "HCL_findCatalogEntryAssociatedMerchandising"
      },

     "query" : {

You can create an independent custom profile without inheriting any default settings. Creating a standalone custom profile will help with editing any fields that are not required for your customers, such as response fields, providers, or post-processors. By restricting the fields you use, you can reduce attribute payload and improve efficiency. For example, you could create the following profile (the parentProfileName parameter is not a mandatory field and can be left blank):

{ "parentProfileName" : "", "profileName" : "X_findCatalogEntrySKUs",
"indexName" : "product", "query" : { "params" : [
{"maxRows" : "1200"}

], "queryFields" : ["relationship.product.id"], "provider" : [ 
      "com.hcl.commerce.search.internal.expression.provider.SearchInventoryExpressionProvider", 
      "com.hcl.commerce.search.internal.expression.provider.SearchByPublishedEntryOnlyExpressionProvider", 
      "com.hcl.commerce.search.internal.expression.provider.SearchByStorePathExpressionProvider", 
      "com.hcl.commerce.search.internal.expression.provider.SearchByCatalogExpressionProvider", 
      "com.hcl.commerce.search.internal.expression.provider.SearchByLanguageExpressionProvider", 
      "com.hcl.commerce.search.internal.expression.provider.SearchProductEntitlementExpressionProvider"], 
"preprocessor" : [], 
"postprocessor" : [
      "com.hcl.commerce.search.internal.expression.postprocessor.SearchMainCatalogEntryViewResultQueryPostprocessor",
      "com.hcl.commerce.search.internal.expression.postprocessor.SearchCatalogEntryViewPriceQueryPostprocessor",
      "com.hcl.commerce.search.internal.expression.postprocessor.SearchCatalogEntryViewUserDataQueryPostprocessor"  ], 
"responseFields" : [ "id.catentry","id.store","buyable","id.catalog","identifier.sku.raw","name.raw","name.override.raw",
"description.raw","description.override.raw","url.thumbnail","url.override.thumbnail", "url.image","url.override.image","keyword.text",
"manufacturer.raw","type","prices.","path.","relationship.product.id", "relationship.item.id","attribute.source","url.seo","attachments.", 
"images." ]
 } 
}