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.
Web services
Data service layer
The data service layer (DSL) provides an abstraction layer for data access that is independent of the physical schema.
Data service layer query processing
The data service layer uses the different sections of the query template file to control how the query is run.
Query template file
The query template file is a mechanism by which you can easily map a query on your logical model to one or more SQL statements. The SQL assets are kept in separate files, which are isolated from the runtime Java code. This template helps database administrators and programmers to locate and analyze SQL statements. Additionally, changes to SQL that are used for queries do not require recompiling Java code. Also, the addition of new columns into existing tables might not require changing SQL statements that use those tables. Column information is separated out in the SYMBOL_DEFINITIONS section.
Graph composer
In the query template file, an optional graph composer Java class can be specified in the ENTITY section within the PROFILE block. This Java class allows you to augment the final graph of physical SDOs. It can perform data aggregation from other sources and can merge multiple graphs of physical SDOs into a single graph if there is more than one associated SQL statement defined in the profile for the base table object.

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
    - Working with HCL Commerce SOI services
      Working with HCL Commerce services involves developing client libraries, new commands, and business logic. The Java Emitter Template (JET) is documented to assist you with these tasks.
    - Creating HCL Commerce services
      Creating HCL Commerce services involves setting up the development environment, creating and extending client libraries, and setting an EMF genmodel. The Java Emitter Template (JET) is provided and documented to assist you with these tasks.
    - HCL Commerce BOD command framework
      The Business Object Document (BOD) command framework encapsulates the business logic layer of HCL Commerce. In Version 9, it is largely superseded by the Java Persistence API (JPA).
    - Developing the business logic layer using the BOD command framework
      Business layer can be designed and programmed using the BOD programming model introduced in HCL Commerce Version 6 Feature Pack 3.0.1. This command framework revolves around using Business Object Documents, and the Java representation of those objects, logical service data objects.
    - HCL Commerce BOD command framework
      The Business Object Document (BOD) command framework encapsulates the business logic layer of HCL Commerce. In Version 9, it is largely superseded by the Java Persistence API (JPA).
    - Data service layer
      The data service layer (DSL) provides an abstraction layer for data access that is independent of the physical schema.
      - Business Object Mediator
        The Business Object Mediator (BOM) performs bidirectional transformations between the physical service data objects (SDO) and logical SDOs. By performing this role, it provides a business object persistence interface for the data service layer. The BOM supports create, read, update, delete operations on the logical SDOs so that the business logic layer can work with them rather than the physical schema.
      - Physical data container
        The physical data container supports create, read, update, delete operations on the physical SDOs, which are mapped directly to the physical schema. It also enables the business logic to work with physical SDOs that are not mapped to the logical model – for example, statistics or auditing data.
      - HCL Commerce extended XPath notation
        When get requests for HCL Commerce nouns are processed, HCL Commerce uses extended XPath notation as the query language to identify which nouns to return. XPath is an industry standard language for addressing parts of an XML document, and the HCL Commerce extended XPath notation uses extensions to this standard.
      - Object-relational metadata
        Object-relational metadata is an XML file that maps physical SDO Java classes to the database schema. The data service layer requires this object-relational metadata to translate between the physical Java classes and the HCL Commerce database schema.
      - Service Data Objects (SDO)
        SDO (Service Data Objects) is a framework for data application development, which includes an architecture and API. HCL Commerce utilizes the SDO capabilities for XML marshalling and unmarshalling, and code generation from XSD to static Java objects. The SDOs themselves are Java object representations of your nouns, and can be easily traversed by using getters.
      - Data service layer query processing
        The data service layer uses the different sections of the query template file to control how the query is run.
        Query template file
        The query template file is a mechanism by which you can easily map a query on your logical model to one or more SQL statements. The SQL assets are kept in separate files, which are isolated from the runtime Java code. This template helps database administrators and programmers to locate and analyze SQL statements. Additionally, changes to SQL that are used for queries do not require recompiling Java code. Also, the addition of new columns into existing tables might not require changing SQL statements that use those tables. Column information is separated out in the SYMBOL_DEFINITIONS section.
        SQL parameters
        Within query templates, you can use SQL parameters to substitute values in SQL queries. The extended XPath query expression specifies the values of the SQL parameters in two ways, using XPath attributes or elements, and using control parameters.
        Query template file tags
        The query template file uses the following tags.
        Graph composer
        In the query template file, an optional graph composer Java class can be specified in the ENTITY section within the PROFILE block. This Java class allows you to augment the final graph of physical SDOs. It can perform data aggregation from other sources and can merge multiple graphs of physical SDOs into a single graph if there is more than one associated SQL statement defined in the profile for the base table object.
        Access profiles
        It is very common, especially when building Web applications, to require a different level of detail on various web pages for the same object. For example, on a product list page, only minimal information about each product is needed, while on a product detail page, more information is required. To accommodate the varying needs for different levels of knowledge about an object, clients can use access profiles to convey the intent of their requests.
        Parametric search support
        A parametric search allows queries using multiple criteria to narrow the results. For instance, all products that have a name starting with "Toy", under $50, that have color = "blue". WebSphere Commerce supports parametric search queries on both vertical and horizontal schemas.
      - Paging support in the data service layer
        Paging is used to return multiple "pages" of data when it is necessary to retrieve only a certain number of entries at a time. The data service layer supports paging of data, as well as setting result limits for paging.
      - Using the data service layer
        You can customize the data service layer to create and modify schemas and queries.
    - HCL Commerce Web services with JSP pages
      A Web service is an interface that describes a collection of operations that are accessible through the network by using standardized XML messaging. A Web service is described using a standard, formal XML notation, called a service description. The service description includes all the details necessary to interact with the service, including its message formats (that detail the operations), transport protocols, and location. The interface hides the implementation details of the service, allowing it to be used independently of the hardware or software platform on which it is implemented and also independently of the programming language in which it is written. The foundation for Web services are standards such as simple object access protocol (SOAP), the Web Services Description Language (WSDL), and the Universal Description, Discovery, and Integration (UDDI) registry.
    - Workspaces support for BOD service modules
      There are two user interfaces that use workspaces in HCL Commerce, HCL Commerce Accelerator, and Management Center. The Management Center uses Get services from BOD service modules to retrieve many of its business objects, and along with the business objects, change control metadata is also included in the response. The change control metadata is returned to the Management Center, where it is used to determine whether the object can be modified by the current user.
    - Location-based services
      HCL Commerce uses location-based services to target customers using Global Positioning System (GPS)-enabled mobile devices.
  - 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.

Graph composer

In the query template file, an optional graph composer Java class can be specified in the ENTITY section within the PROFILE block. This Java class allows you to augment the final graph of physical SDOs. It can perform data aggregation from other sources and can merge multiple graphs of physical SDOs into a single graph if there is more than one associated SQL statement defined in the profile for the base table object.

The graph composer is needed for two-step queries that use multiple association SQL statements. You need to implement your own graph composer only if the result sets of the association SQL statements retrieve identical records from tables other than the base table.

If specified, the graph composer must subclass from the com.ibm.commerce.foundation.server.services.dataaccess.GraphComposer abstract class and implement the abstract composeGraph() method.

For example:

BEGIN_PROFILE 
	name=profileName1

	BEGIN_ENTITY 
	  entity_table=CATENTRY 

<!-- must subclass from com.ibm.commerce.foundation.server.services.dataaccess.GraphComposer -->
<!-- used to compose the final graph --> 
<!-- if more than one associated SQL statement defined -->
	  className=com.my.GraphComposer

   associated_sql_statement=CatEntryWithDescription
   associated_sql_statement=CatEntryWithProperty
 END_ENTITY
END_PROFILE