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.
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.
Customizing content versioning
The content versioning feature is enabled for some objects in the Catalogs tool in Management Center. You can add or remove content versioning support for existing objects and custom objects by customizing both Management Center and HCL Commerce server.
Extending the content versioning feature to support additional business objects
You can extend the content versioning feature to support versioning in your own custom objects or in existing HCL Commerce objects.
Updating the version schema with custom tables
The updateVersionSchema utility automatically creates the custom tables in the version schema. This utility replicates newly added tables marked to be versioned from the base schema into the version schema.

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.
    - HCL Commerce Struts framework
      Struts is a well documented, mature and popular framework for building front ends to Java applications. To address concerns in software applications, it uses a Model-View-Controller (MVC) architecture: The Model represents the business or database code, the View represents the page design code, and the Controller represents the navigational code.
    - Spring framework
      The Spring Framework is a lightweight, open source programming and configuration model for developing Java based enterprise applications. This framework is used in HCL Commerce for building and configuring Management Center, including the managing of URL requests from Management Center to retrieve and process object data.
    - Management Center
      The Management Center for HCL Commerce framework is the foundation for HCL Commerce business user tooling. The business objects that are managed with Management Center are defined by the individual components that make up Management Center. The Management Center framework uses these definitions to provide the features that you can use to find, create, modify, and delete the defined business objects. If you plan to customize the Management Center, ensure that you understand the framework and all of the components that make up Management Center.
    - Developing Commerce Composer assets
      Enrich the capabilities of the Commerce Composer tool by developing your own widgets and templates, and extending other features and functions to suit your business needs.
    - Customizing promotions
      Customizing promotions can involve the customization of the promotion business user tools and the underlying promotion engine, which features a clean architecture supporting rich functionality, as well as a wide array of customization possibilities.
    - Working with the promotions component configuration file
      Some Management Center components, like the promotions component, have customizable configuration files. These files contain properties that control certain component features.
    - Customizing marketing
      You can customize marketing features and objects to better meet the business needs of your site. For example, you can customize e-Marketing Spots, customer segments, activities, activity components, such as triggers, targets and actions, and more. Customization is supported for the Marketing tool in Management Center and for the storefront to display e-Marketing Spots.
    - Customizing price rules
      You can customize price rules to suit the business needs of your site. For example, you can create a new condition or action for business users to add to price rules. Customization is supported for both the Price Rule Builder tool user interface in the Catalog Filter and Pricing tool, and for the pricing services.
    - Customizing store preview
      You can customize store preview to add enhancements that help business users work more efficiently. These enhancements include the click-to-edit function and in-context preview function.
    - Customizing content versioning
      The content versioning feature is enabled for some objects in the Catalogs tool in Management Center. You can add or remove content versioning support for existing objects and custom objects by customizing both Management Center and HCL Commerce server.
      - Content Versioning configuration file (wc-content-version.xml)
        The content versioning configuration file defines the configuration for the UI objects that are versionable. This file indicates which UI objects are versionable, and how the system versions the object. To change the default configuration for the UI objects, you must extend the configuration file. You can extend this file by creating a file in an component extension folder (workspace_dir\WC\xml\config\com.ibm.commerce.component-ext). A component extension folder includes all the extended files for the particular component or service module.
      - Content versioning access control
        The content version services operate on all the nouns that are enabled for versioning. Access control policies are enabled to limit users to access content version services for a particular noun or group of nouns. The content version noun versions another noun. For example, the access control policy for a version ensures that only the Catalog Manager can manage versions of the Catalog object type. The Catalog Manager has the authority to create, delete, restore, change, and display versions of Catalog objects, but does not have authority to perform the same actions on Marketing objects.
      - Viewing version details
        To enable viewing different version details on the UI, you modify the serialization JSP file that retrieves data for the versions, and you also update the query template file to make the SQL queries versionable to retrieve the different version information.
      - Extending the content versioning feature to support UserData
        You can extend the content versioning feature to support UserData in your existing noun. Currently, content versioning is enabled only for the Catalog service module.
      - Extending the content versioning feature to support additional business objects
        You can extend the content versioning feature to support versioning in your own custom objects or in existing HCL Commerce objects.
        Creating a content versioning configuration file
        You create a content versioning configuration file in your service module directory for each custom object you want versionable. This file defines the configuration for the UI objects that are versionable and what parts of the UI objects to save when a version is created.
        Updating the version schema with custom tables
        The updateVersionSchema utility automatically creates the custom tables in the version schema. This utility replicates newly added tables marked to be versioned from the base schema into the version schema.
        Implementing access control for version services
        The content version service operates on all the nouns that are enabled for versioning.
        Creating a new tab to display version information
        You add a new tab to show the list of versions for your custom object. To define the new tab named "Version", you update your business object properties definition file.
        Enabling the version services for custom object
        You update the primary object definition for the custom object you want to version. In the primary object definition file, you add the functionality to create versions, update versions, and retrieve the list of versions for your custom object.
        Enabling viewing custom object versions on the UI
        To enable viewing version objects in the UI, you create a serialization JSP file that retrieves the version object data, and you also update the query template file to make the SQL queries versionable to retrieve the different version information.
        Deploying the custom object content versioning customization
        After you have customized content versioning to support your custom object, you are ready to deploy the customization to your HCL Commerce Server.
      - Creating and registering a serialization JSP file to enable viewing version objects
        You must create and register a serialization JSP file to transform server versioned objects into XML that Management Center understands. When you extend content versioning in a business object, you want to display the versions in the Management Center user interface.
      - Hiding unversioned contents of a business object
        When viewing versions of an object, you might want to hide the parts of the object that are not versioned. For example, if the merchandising associations are not saved when a product version is created, you might want to hide the Merchandising Association tab when viewing the product version.
      - Disabling content versioning for a business object
        You can disable content versioning for particular business objects. For example, you might want your business user to be able to manage versions of sales catalogs, and catalog entries but not categories.
    - Customizing the infrastructure component
      Customizing the infrastructure component provides you the ability to change configurable properties for Management Center and Search Engine Optimization (SEO) functionality.
    - Developing JSP pages
      To create JSP pages for HCL Commerce, you should have Rational Application Developer skills and JSP skills. You should also be familiar with JSTL.
    - HCL Commerce JSP programming best practices
      This section offers the following selection of JSP programming best practices, which promote development of reusable and easily maintainable JSP pages within the HCL Commerce store development framework:
    - Double-click handling in HCL Commerce
      The purpose of double-click handling in HCL Commerce is to prevent processing the same request twice to ensure data integrity within the system. When processing certain URL requests, such as OrderItemAdd, the double-click feature of HCL Commerce will identify whether the request from the online shopper is currently being processed and blocks the current request if that is the case.
  - 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.
- 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.

Updating the version schema with custom tables

The updateVersionSchema utility automatically creates the custom tables in the version schema. This utility replicates newly added tables marked to be versioned from the base schema into the version schema.

Before you begin

Ensure that you have created your custom content versioning configuration file. See Creating a content versioning configuration file for instructions on how to create a custom content versioning configuration file.
Stop the HCL Commerce test server.

Procedure

From the command prompt, navigate to WCDE_installdir\bin
Run the updateVersionSchema utility.

Results

Ensure your custom tables are created successfully in the version schema by checking the log file WCDE_installdir\logs\updateVersionSchema.log. The SQL is generated in the file WCDE_installdir\logs\Update_version_db_demo.sql.log.