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.
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.
Search
In keeping with HCL's commitment to current and open standards, HCL Commerce Search uses Apache Lucene as the basis of its Search framework. Lucene powers the Apache Solr search engine and the Elasticsearch search engine. The indexing pipeline is a more open, flexible and scalable and is tightly integrated with the data service. Using the underlying dataflow technology and architecture, you can easily customize the pipelines. This open-standards approach considerably eases the process of integrating Search with existing and third-party applications.
Solr -based solution
The Solr search index lifecycle includes tasks that you perform after HCL Commerce search is deployed. For example, building, replicating and propagating the search index, backing up and restoring the search index, and monitoring indexing activities across different search servers.
Populating and building the search index data
Populating and building the search index data includes the following tasks: building the search index, indexing site content, propagating the search index with the repeater, and setting up cache invalidation in the storefront.
Indexing contract prices
You can index prices in HCL Commerce Search. For example, you can build the HCL Commerce Search price index by issuing the Calculate Price RESTful call, and then indexing contract prices.
Index Load
Index Load is an indexing service that uses the Data Load framework to load data in parallel into one or more search extension indexes.
Monitoring Index Load
You can monitor Index Load and use the metrics to tune Index Load for optimal performance.

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.
  - The HCL Commerce application
    Every time you deploy the HCL Commerce application, you are deploying a set of Docker containers that communicate with each other to run your HCL Commerce site. Each HCL Commerce application deployment can contain one or more stores.
  - Overview of administering an HCL Commerce site
    In HCL Commerce the person who performs administrative tasks is called a Site Administrator. The Site Administrator installs, configures, and maintains HCL Commerce and the associated software and hardware. The administrator responds to system warnings, alerts, and errors, and diagnoses and resolves system problems. Typically, this person controls access and authorization (creating and assigning members to the appropriate role), manages the Web site, monitors performance, and manages load balancing tasks. The Site Administrator might be responsible for establishing and maintaining several server configurations for different stages of development such as testing, staging, and production. The Site Administrator also handles critical system backups and resolves performance problems.
  - Staging environment
    an HCL Commerce staging environment is a runtime environment where business and technical users can update and manage store data and preview changes. The changes can then be propagated to the production environment.
  - Workspaces
    You can enable and manage workspace assets and determine policies such as locking rules and commit and publishing options.
  - HCL Commerce database
    As a site administrator, maintain the HCL Commerce database and ensure that any HCL Commerce utilities and processes that load and retrieve data from the database is configured to connect to the database properly.
  - Dynamic caching
    In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
  - Extracting and loading data
    HCL Commerce provides utilities for preparing and loading data into a HCL Commerce database. The loading utilities are flexible and you can continue to use these utilities when you customize the HCL Commerce schema.
  - Payment plug-ins
    To configure a payment plug-in define payment and refund methods; payment and refund rules; and the payment protocols that you intend to use.
  - Search
    In keeping with HCL's commitment to current and open standards, HCL Commerce Search uses Apache Lucene as the basis of its Search framework. Lucene powers the Apache Solr search engine and the Elasticsearch search engine. The indexing pipeline is a more open, flexible and scalable and is tightly integrated with the data service. Using the underlying dataflow technology and architecture, you can easily customize the pipelines. This open-standards approach considerably eases the process of integrating Search with existing and third-party applications.
    - Comparing Solr and Elasticsearch architectures
      The Solr and Elasticsearch systems behave similarly at the storefront level. Behind that layer are certain key differences in architecture.
    - Comparing Solr and Elasticsearch index lifecycles
      Apache Solr and Elasticsearch have different approaches to updating your search index. Solr does delta updates on a regular schedule, usually every five minutes. Elasticsearch performs an incremental update in near real-time.
    - Comparing Solr and Elasticsearch common business tasks and their impact on the search index
      There are impacts to the search index when certain business tasks are performed. This topic describes the Solr and Elasticsearch comparison for the common business tasks and their impact on the search index. The following table lists the common business tasks and reindexing types for Solr and Elasticsearch. The table groups business tasks and reindexing types by business components.
    - Migrating from Solr to Elasticsearch
      The following table describes the Solr-based and Elasticsearch-based search solutions and their concepts. A guideline is also presented for migrating from the Solr-based search solution to the newer Elasticsearch-based solution.
    - Orchestration service
      The Orchestration service enables the Ruby starter store to use Solr-based search. The Ruby store uses the V2 search REST API that is only compatible with Elasticsearch. With the Orchestration service, the ability to convert a JSON message from one format into another is introduced.
    - Elasticsearch-based solution
      With HCL Commerce Version 9.1, HCL Commerce introduces a new service for inputting and organizing your data. This new version of HCL Commerce Search is a generic data management system that can be used by other Commerce subsystems, including but not limited to the Elasticsearch engine. Along with the Ingest service that brings in the data, the new Query service provides natural language processing, color recognition and more. For customers who need backwards-compatibility, the previous Apache Solr-based search solution is still available.
    - Solr -based solution
      The Solr search index lifecycle includes tasks that you perform after HCL Commerce search is deployed. For example, building, replicating and propagating the search index, backing up and restoring the search index, and monitoring indexing activities across different search servers.
      - Populating and building the search index data
        Populating and building the search index data includes the following tasks: building the search index, indexing site content, propagating the search index with the repeater, and setting up cache invalidation in the storefront.
        Index-building topologies and scenarios
        HCL Commerce Search indexes are created separately based on a specific master catalog. Deploy the HCL Commerce Search index, then separately manage and rebuild each index to refresh its data.
        Building the search index
        The HCL Commerce Search index is built by using the Build Index call to the REST API.
        Indexing contract prices
        You can index prices in HCL Commerce Search. For example, you can build the HCL Commerce Search price index by issuing the Calculate Price RESTful call, and then indexing contract prices.
        Building the contract price
        You can build contract prices embedded in the HCL Commerce Search catalog entry index when you deploy a B2B starter store.
        Creating and scheduling the ContractPriceCalculate job
        The ContractPriceCalculate job command is used for calculating prices on a schedule for all catalog entries that belong to a specific master catalog. The catalog entry price is calculated against all contracts that belong to the store.
        HCL Commerce Search and the B2B business model
        HCL Commerce Search includes support for the B2B store.
        Index Load
        Index Load is an indexing service that uses the Data Load framework to load data in parallel into one or more search extension indexes.
        Indexing contract prices using Index Load
        You can use Index Load to index contract prices from a .CSV file.
        Customizing Index Load
        You can customize Index Load to suit your business needs. For example, you can customize Index Load to read from multiple sources, or change how the source input is transformed.
        Monitoring Index Load
        You can monitor Index Load and use the metrics to tune Index Load for optimal performance.
        Index Load configuration files for indexing from database
        Index Load requires configuration files before it can be run from a web browser.
        Index Load configuration files for indexing from CSV files
        You can load index information from a CSV file. Index Load requires configuration files before it can be run from a web browser.
        Index Load configuration files for merging indexes
        Index Load requires configuration files before it can merge search indexes.
        Setting up and building the inventory index
        The inventory index, a separate index that contains index data, is an extension of the product index. For accurate inventory status, you can refresh the inventory index more frequently than the product index.
        Invalidating a Search cache
        You can invalidate the contents of a specific cache by issuing a call to the Search REST API
        Parallel preprocessing and distributed indexing
        You can index large catalog data into the search server with parallel preprocessing and distributed indexing by sharding and merging.
        Indexing site content with HCL Commerce Search
        HCL Commerce contains unmanaged content such as site content, that must be crawled using the site content crawler. Unmanaged content intended for production must be published separately, as it is not part of staging propagation. Once the static content is copied to the correct location, a manual site content re-indexing from the production system is required against the repeater.
        Index synchronization and delta updates
        The HCL Commerce Search index can typically fall out of synchronization with the latest production data over time. To maintain accuracy of the search result data, reindexing must be done at a certain time during normal business operation. There are three forms of search reindexing, and depending on your business requirements, costs and benefits are associated with each of the following options: Full reindexing, delta reindexing, and emergency updates.
        Caching and invalidation in HCL Commerce Search
        The JSP fragment cache and the data object cache can be used with the search server for caching and invalidation. The JSP fragment cache is used on the HCL Commerce server to cache portions of the storefront user interface for future reuse. The data object cache is used on the search server to store internal runtime properties that are used by certain search features to improve overall performance.
        Search index optimization
        When you administer HCL Commerce Search Search, consider the following optimization hints and tips.
      - Backing up, restoring, recovering, and verifying search indexes
        Several tasks help you backup and restore the HCL Commerce Search index, depending on your business needs.
      - Workspaces in HCL Commerce Search
        Business users work on catalog-related changes in an isolated environment when you work with workspaces in HCL Commerce Search. They can then preview their changes in the storefront before you submit them for approval. Content approvers or workspace managers then use the Workspace Management tool in the Management Center to preview a workspace, undo submitted tasks, reject, cancel, or approve task groups. A task group is scheduled for publishing after it is approved.
      - Using Search with product variants
        HCL Commerce provides a rich set of Search tools to use with product variants. Once you have enabled Search for variants, a number of usage scenarios become possible. Those scenarios are described in the following topics.
      - User sessions
        User sessions are synchronized between the HCL Commerce and HCL Commerce search servers.
      - Search index locking
        The HCL Commerce Search index is locked at certain points during the indexing lifecycle. For example, when running the search utilities or scheduler jobs.
      - Debugging HCL Commerce Search
        You can debug HCL Commerce Search by directly accessing Solr functions by using a web browser, without using HCL Commerce run time or utilities.
      - Tracing and logging
        You can enable tracing and logging to help troubleshoot HCL Commerce Search after deployment.
  - HCL Customer Service for HCL Commerce
    HCL Customer Service for HCL Commerce is a separately purchased product that provides a light-weight customer service solution that is embedded in the Aurora B2C and Aurora B2B storefronts. Even though this solution is a separately purchased product, it is not a separate application. Stores that are enabled with HCL Customer Service for HCL Commerce allow a customer service representative (CSR) to act on behalf of guest customers and registered customers. A CSR can manage customer accounts, cancel and reorder orders, and shop as customer. A CSR can also act on behalf of Buyer Administrators to help complete Aurora B2B tasks from the storefront, without having to access the Organization Administration Console.
  - HCL Commerce configuration file (wc-server.xml)
    Many aspects of the HCL Commerce runtime application are configured in an XML file. This XML file is located inside the HCL Commerce Java Platform, Enterprise Edition EAR.
  - Enabling the SSL Accelerator option
    An SSL Accelerator (or SSL Terminator) strips off HTTPS encryption at or before the Web server tier in a multitier setup. When you use an SSL Accelerator with HCL Commerce, you can use the SSL Accelerator option to configure HCL Commerce to correctly receive requests that require redirects.
  - Managing features
    You can administer the features for your store and site, such as attribute, catalog, promotion, marketing, order management features, and more. The administration tasks that you can complete differ depending on the type of feature and the tool that you use to administer your store and site.
  - Logging services
    HCL Commerce provides facilities for logging. For existing customers, ECTrace and ECMessage are still supported. For new implementations, use the WebSphere Application Server recommendation for logging and tracing.
  - Business auditing
    Business auditing is the capturing of the business logic and objects during a HCL Commerce operation. You may want to audit your business for various reasons: generic, such as to review various tasks performed weekly; or specific, such as to track the steps involved in a particular Customer Service Representative's order. A report on business auditing is available in the Administration Console.
  - Business events
    Each time that a command triggers a business event, a record is added to the BUSEVENT database table to persist data from the event. Event listeners and external systems (such as the Marketing component, a back end order management system, or an external analytics system) can use this data to perform further processing.
  - Business Object thresholds
    Applying limits on business operations reduces the risk of system attacks where unbound conditions might result in system failures.
  - Stores in HCL Commerce
    HCL Commerce supports several different types of entities that are defined as stores. The assets of these store entities may be edited using the HCL Commerce Accelerator.
  - Enabling registered users to access all stores in the Extended Sites business model
    HCL Commerce users can access storefronts by virtue of having the role of Registered Customer in the organization that owns the store, or in any organization above it. The roles a user has access to during registration are defined within the MemberRegistrationAttributes.xml file.
  - Hystrix on the Store server
    The Hystrix framework is used as a proxy for back-end resources such as the Transaction server and Search server by default. This can be disabled, but does have performance implications that must be considered.
- 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.
- 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.

Monitoring Index Load

You can monitor Index Load and use the metrics to tune Index Load for optimal performance.

About this task

You can monitor Index Load in the following ways:

Interactively, by using the Index Load status command while indexing.
After running Index Load, using the search administration logger.

Procedure

Use the metrics that are displayed by the Index Load status command while indexing to help refine tuning parameters and improve performance throughput:

Go to the following URL: https://hostname:searchadminport/search/admin/resources/indexload/profile/$profileName/status.
The status report is displayed and shows its metrics.

For example:
Review the status report and further adjust the tuning parameters in this task accordingly.
The status report contains the following considerations:
- The overall read rate and indexing rate.
- The batch queue size in memory with the high water mark, showing the peak memory consumption.
- The average document width and size in bytes.
- The cumulative flush and commit time.
- The time that the system resources are utilized. That is, the CPU time and heap memory.
- The index data directory statistics with related Solr configurations.