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.
GraphQL for HCL Commerce
The GraphQL markup language is available for any API. It is a server-side interpreter for processing queries using a data type system you design. With GraphQL, your data and code are independent of any database or storage system.
Creating and customizing GraphQL services
You can create and customize your own GraphQL services with HCL Commerce Developer.
GraphQL introspection configuration
Describes the introspection configuration option for the HCL Commerce GraphQL server and how it affects schema discovery and client tooling.

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.
  - Customizing Management Center for HCL Commerce
    HCL Commerce allows you to pull the GIT bundle of Management Center source code and start the application locally to customize the Management Center.
  - 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.
  - 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.
  - GraphQL for HCL Commerce
    The GraphQL markup language is available for any API. It is a server-side interpreter for processing queries using a data type system you design. With GraphQL, your data and code are independent of any database or storage system.
    - Creating and customizing GraphQL services
      You can create and customize your own GraphQL services with HCL Commerce Developer.
      - HCL Commerce GraphQL extensions
        The HCL Commerce GraphQL provider creates and hosts a GraphQL server endpoint that delegates requests to a set of REST services defined by a set of OpenAPI 3 requirements.
      - Certificates and HCL Commerce GraphQL server
        The HCL Commerce GraphQL application behaves as a server when it receives graphql requests over HTTP or HTTPS (or both), and as a client when it calls REST services provided by other servers, again over HTTP or HTTPS. When serving over HTTPS the application should be configured to use an appropriate TLS server/ key pair, and when acting as a client to trust the certificates used by the servers it connects with.
      - Changing GraphQL server configuration
        The HCL Commerce GraphQL server exposes many configuration options through a yaml or json file included in the container. A majority of the settings influence the Openapi to GraphQL translation, however a few others regulate the HTTP or HTTPS connection behaviour while GraphQL is functioning as both a server or client.
      - Setting up GraphQL services
        Set up up a GraphQL server using a custom Node.js file. This customization creates a GraphQL schema and resolver code from a set of OpenAPI specifications. It is dependent on the express, express-GraphQL, GraphQL, and OpenAPI-to-GraphQL packages.
      - Enabling GraphQL in stores
        This tutorial will show you how to set up GraphQL in your store.
      - GraphQL introspection configuration
        Describes the introspection configuration option for the HCL Commerce GraphQL server and how it affects schema discovery and client tooling.
        Disabling GraphQL introspection
        You can disable GraphQL introspection by overriding the GraphQL server configuration in opts.yaml and setting introspection to false. This option is provided to support customers who want to disable introspection based on their own risk assessment (introduced for HCL Commerce V9.1.20.0).
        Potential impacts and fallback options
        Describes what can change when introspection is disabled and the available recovery options if disabling introspection causes issues.
  - 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. Starting with Version 9.1, HCL Commerce Search with Elasticsearch microservices manage indexing and other crucial tasks, with no performance impact on the storefront or transaction server.
- 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.

HCL Commerce Version 9.1.20.0 or later

GraphQL introspection configuration

Describes the introspection configuration option for the HCL Commerce GraphQL server and how it affects schema discovery and client tooling.

The HCL Commerce GraphQL provider creates and hosts a GraphQL server endpoint that delegates requests to a set of REST services defined by OpenAPI 3 requirements. For more information about the provider, see HCL Commerce GraphQL extensions.

GraphQL introspection allows a client to query the schema, including types, fields, queries, and mutations, by using special fields such as schema and type. This capability is used by many GraphQL developer tools to provide auto-complete, schema exploration, and code generation.

The HCL Commerce GraphQL server exposes an introspection configuration setting in the main configuration file (opts.yaml) that is included in the container. For more information about the configuration file and how to obtain the default version, see Changing GraphQL server configuration.

By default, introspection remains enabled for backward compatibility:

introspection: true (default) — GraphQL introspection is enabled. Developer tools and clients that depend on runtime schema discovery can query the schema.
introspection: false — GraphQL introspection is disabled. Introspection queries that use schema or type no longer return schema details.

The introspection flag is provided so that customers can decide whether to disable introspection based on their own risk assessment and operational requirements. Disabling introspection can reduce schema discoverability from the endpoint, but it does not prevent schema information from being inferred through other means (for example, inspection of browser-based client code or network traffic).

For step-by-step instructions, see Disabling GraphQL introspection.

To learn about the potential impacts of disabling introspection and how to recover if issues occur, see GraphQL introspection: potential impacts and fallback options.