Home
Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
Tutorials
HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
Search
HCL Commerce provides tutorials that are designed to describe how to customize HCL Commerce Search.
Elasticsearch-based tutorials
HCL Commerce Search with Elasticsearch includes the Ingest data platform, Query, and the Elasticsearch indexing system. You can find tutorials to aid you in configuring and customizing your Elasticsearch implementation.
Indexing profit margin data for use in dynamic product recommendation for Elasticsearch
In this tutorial, you customize HCL Commerce search to use specific search conditions to dynamically recommend products to customers based on the profit margin for the products.
Applying the NRT index (Versions 9.1.10.0-to-9.1.13.0)
This section of the tutorial describes the steps required to apply the Near Real Time (NRT) index for Profit Margin Customization for HCL Commerce Search prior to Version 9.1.14.
Upgrade the connector descriptor of an existing connector
In this lesson, you upgrade auth.product connector descriptor with the customized connector code.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
- Migrating
  Before you migrate to HCL Commerce Version 9.1, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
  - Docker start-up logic
    HCL Commerce provides tutorials that are designed to introduce the various tasks that are related to the customizing Docker start-up logic. The following tutorials provide sample guides to defining the custom logic.
  - Programming model
    HCL Commerce provides tutorials that are designed to introduce the various tasks that are related to creating customized code to develop and enhance HCL Commerce applications. The following tutorials provide sample guides to customizing elements of the HCL Commerce programming model.
  - Web services
    Web services tutorials introduce the various tasks that are related to creating and customizing web services for HCL Commerce applications.
  - Management Center
    HCL Commerce provides tutorials that are designed to introduce the various tasks that are related to customizing Management Center.
  - Migration
    HCL Commerce provides tutorials that are designed to introduce the various tasks that are related to migration from previous versions of WebSphere Commerce. The following tutorials provide sample guides to migrating your WebSphere Commerce sites to HCL Commerce Version 9.1.
  - Search
    HCL Commerce provides tutorials that are designed to describe how to customize HCL Commerce Search.
    - Solr-based tutorials
      Prior to HCL Commerce Version 9.1, the Apache Solr search engine is standard. If you are using Solr, the following tutorials can help you configure and customize it for your particular needs.
    - Elasticsearch-based tutorials
      HCL Commerce Search with Elasticsearch includes the Ingest data platform, Query, and the Elasticsearch indexing system. You can find tutorials to aid you in configuring and customizing your Elasticsearch implementation.
      - Customizing default connectors with Ingest Profile
        This tutorial demonstrates how to use Ingest profiles with default connectors to completely separate custom configurations and logic code from the product release logic. This logical separation makes it easier to upgrade to future product releases.
      - Customizing CAS connectors with Ingest Profile
        This tutorial demonstrates how to use Ingest profiles with your Catalog Asset Store (CAS) connectors to separate custom configurations and logic code from the product release logic. This logical separation makes it easier to upgrade to future product releases.
      - Indexing profit margin data for use in dynamic product recommendation for Elasticsearch
        In this tutorial, you customize HCL Commerce search to use specific search conditions to dynamically recommend products to customers based on the profit margin for the products.
        Load cost price list
        In this lesson, you create a cost price list that is called My Company Cost Price List in the Catalog Filter and Pricing tool. Then, you must upload the sample cost price data to the cost price list.
        Create the customization in NiFi
        This section of the tutorial explains the steps that are required to create the customization in NiFi to index profit margin data.
        Import the customization into NiFi
        This section of the tutorial explains the steps that are required to import the customization in NiFi to index profit margin data.
        Upgrade the existing connectors in NiFi
        This section of the tutorial explains the steps that are required to upgrade the existing connectors in NiFi with profit margin customization using Search Ingest Service API.
        Applying the NRT index (Versions 9.1.14.0+)
        This tutorial section describes how to apply the Near Real Time (NRT) index for Profit Margin Customization with the Custom Java ETL process group.
        Applying the NRT index (Versions 9.1.10.0-to-9.1.13.0)
        This section of the tutorial describes the steps required to apply the Near Real Time (NRT) index for Profit Margin Customization for HCL Commerce Search prior to Version 9.1.14.
        Get connector descriptor of existing connector
        In this lesson you create the auth.product connector descriptor JSON file using the Search Ingest Service API.
        Upgrade the connector descriptor of an existing connector
        In this lesson, you upgrade auth.product connector descriptor with the customized connector code.
        Modify groovy script in processor to accommodate NRT indexing
        This section of the tutorial explains the steps to modify the groovy script in the processor to accommodate Near Real Time (NRT) indexing for Profit Margin customization.
        Verify the NRT SQL query
        This section of the tutorial explains the steps to verify the NRT SQL query while applying the NRT index for Profit Margin customization.
        Test NRT index
        This lesson shows you how to test whether the NRT index is working after customization, and whether the Profit Margin is being updated, without running a full index build.
        Push customization to production environment
        In this lesson, you will push the customization created in the Auth environment to the Live environment.
        Testing the customization
        In this lesson, you test your customization to verify that your customization is successful.
      - Indexing profit margin data using the Catalog Asset Model
        In this tutorial, you customize HCL Commerce Search to use specific search conditions to dynamically recommend products to customers based on the profit margin for the products.
      - Elasticsearch file ingestion
        Ingest unstructured data for MS Word .docx, PDFs, Excel.xlsx, CSV files, .txt files, and HTML files, including media metadata.
      - Ingesting custom fields
        Optional custom database fields such as FIELD1, FIELD2, etc. in the HCL Commerce catalog data model are often used in Ingest customization. These fields help reduce the need for custom extension tables. This tutorial shows you how to use them with the Ingest service.
      - Sequencing using sales rank
        This tutorial demonstrates how to create a new custom index to house each product’s sales rank. You will make use of a custom Ingest connector to copy updated sales ranks to the product index incrementally. You will then customize a search profile in the Query service to use this sales rank to sort the term search results.
  - Starter stores
    HCL Commerce provides tutorials that are designed to introduce the various tasks that are related to customizing the storefront.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.

Upgrade the connector descriptor of an existing connector

In this lesson, you upgrade auth.product connector descriptor with the customized connector code.

Procedure

Complete the following steps to upgrade auth.product connector with the customized connector code.

Use the following URL to access Swagger UI to interact with Search Ingest Service API.

http://<ElasticSearchHostname/IP>:30800/swagger-ui/index.html?url=/v3/api-docs&validatorUrl=#
/Connector%20Configuration/upgradeConnector

On the Swagger UI, navigate to Connector Configuration > POST: /connectors/{id}/upgrade.
Click Try it out.
In the id field, enter auth.product and paste the entire request JSON body with the customized connector code.
Click Execute.

Important: This request takes some time to complete.

The server response appears, and will resemble the following screen:
Restart all Elasticsearch services after the connector upgrade is completed.