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.
Customizing
The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
Search
HCL Commerce comes with a powerful and fully integrated search function. The search functions in HCL Commerce provide an enriched customer experience, with features such as automatic search term suggestions and spelling correction. Since it is built on industry standards, HCL Commerce Search is highly flexible and extensible. Starter stores can use the search engine's most sophisticated features without requiring extra customization.
Solr-based solution
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. This open-standards approach considerably eases the process of integrating Search with existing and third-party applications.
Search configuration
HCL Commerce Search is configured using several files. These files contains properties that control certain search features, and can be extended to meet your business requirements.
Search server
Most HCL Commerce Search services run in the Search container. You can adapt the behavior of the Solr search engine and runtime processes to your business needs by editing customization files in your development workspace.
Solr configuration files
Solr configuration files control search indexes, cores, and interactions between the Solr core and HCL Commerce.
Solr XML file (solr.xml)
The solr.xml file specifies configuration options for each Solr core, including configuration options for multiple cores. The file also contains mappings for request URLs, and indicates which cores to load when the server starts.

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, 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.
  - ***
  - Managed asset deployment
    Managed assets are files that are uploaded by business users to be used for store marketing, or to supplement products. They are added to HCL Commerce through the Assets tool or the Marketing tool in Management Center. By default, managed assets are extracted and deployed through the HCL Commerce EAR. To maintain performance in a large-scale production environment, site administrators must switch to alternative extraction and deployment methods for managed assets.
  - What's new for developers
    Learn about the new features and functions HCL Commerce offers developers.
  - HCL Commerce development environment
    HCL Commerce Developer is the development toolkit for customizing a HCL Commerce application.
  - Functional architecture
    Functional architecture provides both the set of patterns used to implement the business functionality and the frameworks in which these business functions execute.
  - Persistent object model
    HCL Commerce deals with a large amount of persistent data. There are numerous tables defined in the current database schema. Even with this extensive schema, however, you might need to extend or customize the database schema for your particular business needs.
  - Creating your custom store
    After you install and set up your programming environment, you can create your custom store and customize your storefront. You must ensure that the store server is properly configured, and that your store assets are moved to the Store server.
  - Presentation layer
    HCL Commerce uses Java Server Pages (JSP) to implement the view layer of the Model-View-Controller (MVC) design pattern. The view layer is in charge of retrieving data from the database through the use of data beans and formatting it to meet the display requirements. The view layers determines whether the request is sent to a browser or streamed out as XML. JSP files present a clean separation between data content and presentation.
  - Controller layer
    The Controller layer is the conductor of operations for a request. It controls the transaction scope and manages the session related information for the request. The controller first dispatches to a command and then calls the appropriate view processing logic to render the response.
  - Business logic layer
    The business logic layer is the business components that provide OAGIS services to return data or start business processes. The presentation layer uses these OAGIS services to display data, or to invoke a business process. The business logic provides data required by the presentation layer. The business logic layer exists because more than just fetching and updating data is required by an application; there is also additional business logic independent of the presentation layer.
  - Persistence layer
    The interaction between the business objects and persistence layer is isolated in an object called the Business Object Mediator. Business object document (BOD) commands interact with the Business Object Mediator to handle the interaction with the logical objects and how they are persisted.
  - Business model information model
    A business model, a representation of the business processes used throughout the site, provides a sample commerce solution which includes an organization structure, default user roles and access control policies, one or more starter stores, administration tools, and business processes that demonstrate best practices. A business model can be customized to support business requirements and scenarios. HCL Commerce provides sample business models that show some common commerce solutions. These business models are created by setting up an organization hierarchy structure, access control policies, stores, and contracts that help satisfy the necessary business requirements.
  - Business models
    Before starting to develop your site with HCL Commerce, you need to determine the business model supported by HCL Commerce that best represents the purpose of your site. Usually sites created with HCL Commerce will be implemented based on of one of these business models.
  - Store data information model
    Store data is the information that is loaded into the Transaction server database, which allows your store to function. The URL Registry Entries and View Registry Entries packages are included in the diagram, but they are not database assets. These entries are presentation configuration (that is, struts actions and forwards) that must be deployed. URL registry entries are shown in the diagram to illustrate the entire store data information model. To operate properly, a store must have the data in place to support all customer activities. For example, in order for a customer to make a purchase, your store must contain a catalog of goods for sale (catalog data), the data associated with processing orders (tax and shipping data), and the inventory to fulfill the request (inventory and fulfillment data).
  - Customizing HCL Commerce
    You can extend the HCL Commerce product to fit your business needs. This topic describes the prerequisite skills and required knowledge that you need to customize business logic. After you have the required knowledge, use HCL Commerce Developer to take tutorials that guide you step-by-step through various customization scenarios.
  - Run Engine command framework
    The Run Engine command framework provides predefined commands, that you can use to change environment parameters or container configurations. This framework is built into the HCL provided Docker images.
  - Representational State Transfer (REST) services
    HCL Commerce uses Representational State Transfer (REST) services to provide a framework that can be used to develop RESTful applications on several platforms. These platforms can include web, mobile, kiosks, and social applications.
  - Web services
  - Search
    HCL Commerce comes with a powerful and fully integrated search function. The search functions in HCL Commerce provide an enriched customer experience, with features such as automatic search term suggestions and spelling correction. Since it is built on industry standards, HCL Commerce Search is highly flexible and extensible. Starter stores can use the search engine's most sophisticated features without requiring extra customization.
    - Search terminology
      HCL Commerce Search uses a number of specialized terms. A concise list of the most commonly used terms is provided to get you started.
    - Solr-based solution
      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. This open-standards approach considerably eases the process of integrating Search with existing and third-party applications.
      - Search customization for server containers
        The product Search server runs in its own Linux-based container. The containers use Docker technology. All servers share workspaces in the Windows-based development environment, simplifying the development process. After you develop and test your code in the workspace, you can deploy it in new containers.
      - Search services and interactions
        HCL Commerce Search includes several key services and interaction areas, including the search interface, programming model, and its interactions with other Commerce components.
      - Search configuration
        HCL Commerce Search is configured using several files. These files contains properties that control certain search features, and can be extended to meet your business requirements.
        Search server
        Most HCL Commerce Search services run in the Search container. You can adapt the behavior of the Solr search engine and runtime processes to your business needs by editing customization files in your development workspace.
        wc-search.xml
        The HCL Commerce Search configuration file (wc-search.xml) contains properties that are related to configuring HCL Commerce Search application features. You can change the properties to suit your site's needs by creating a custom wc-search.xml file that contains the changed properties only.
        wc-component.xml
        The component configuration file (wc-component.xml) contains properties to configure the Search server.
        Solr configuration files
        Solr configuration files control search indexes, cores, and interactions between the Solr core and HCL Commerce.
        Solr schema file (schema.xml)
        The schema.xml file contains information about the Solr fields and how they are analyzed and filtered during searches. Different field types can contain different types of data. Solr uses the schema.xml file to determine how to build indexes from the input documents, and how to perform index and query time processing.
        Solr XML file (solr.xml)
        The solr.xml file specifies configuration options for each Solr core, including configuration options for multiple cores. The file also contains mappings for request URLs, and indicates which cores to load when the server starts.
        Solr configuration file (solrconfig.xml)
        The solrconfig.xml controls how Solr behaves by mapping requests to different handlers. One index can be represented as one core. If you want to use multiple indexes, for example, a book of recipes and a book of countries, these different indexes or books represent different cores. The solrconfig.xml contains most of the parameters for configuring Solr. It defines how search requests are managed, and how to manipulate data for the user.
        Extending the schema.xml file
        The schema.xml file defines the default index schema structure. The default index schema can be extended using a separate XML file. The most common customizations of the index schema is defining new index fields.
        Extending the solrconfig.xml file
        The solrconfig.xml file defines Solr properties with default values. The default file can be extended using the jvm.options file, by using XInclude, or by configuring the SRCHCONFEXT table. The most common customization of the Solr configuration file is defining new values for replication and caching.
        Extending the wc-data-config.xml file
        The wc-data-config.xml file defines the default indexing queries, and the corresponding field mapping between the database column names and the index field names.
        STORECONF table
        The STORECONF table contains properties to configure various HCL Commerce Search application features.
      - Extension points and customization tasks
        HCL Commerce Search contains extension points that can be used for customization. If you are migrating from a previous version of the product, there are mandatory and optional areas to work with, depending on your existing customizations. In the following topics the available customization points are described, and you are given detailed instructions on customizing each.
      - Search relevancy and merchandising
        Search relevancy and merchandising is the process of controlling the search results that are returned to shoppers in the storefront, and the order in which they appear. There are several techniques that can be used to influence search relevancy, which lets you return products in the order that best suits your business needs.
- 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.

Solr XML file (solr.xml)

The solr.xml file specifies configuration options for each Solr core, including configuration options for multiple cores. The file also contains mappings for request URLs, and indicates which cores to load when the server starts.

Core names are specified using the following naming convention:

MC_masterCatalogID_indextype_locale

Example


<?xml version='1.0' encoding='UTF-8'?>
<solr persistent="true">
<cores adminPath="/admin/cores">
  <core name="Default" instanceDir="default"/>
  <core name="MC_10001_CatalogEntry_Unstructured_en_US" instanceDir="MC_10001_\en_US\CatalogEntry\unstructured\"/>
  <core name="MC_10001_CatalogEntry_en_US" instanceDir="MC_10001_\en_US\CatalogEntry\"/>
  <core name="MC_10001_CatalogGroup_en_US" instanceDir="MC_10001_\en_US\CatalogGroup\"/>
</cores>
</solr>

Where the preceding snippet contains the following cores:

MC_10001_CatalogEntry_Unstructured_en_US: The unstructured content Catalog Entry core for the 10001 master catalog ID in United States English (en_US).
MC_10001_CatalogEntry_en_US: The structured content Catalog Entry core the 10001 master catalog ID in United States English.
MC_10001_CatalogGroup_en_US: The Catalog Group core with a master catalog ID of 10001 in United States English.