Home
Documentation
This Help Center provides documentation on all aspects of the HCL Commerce+ Transaction Server product, from installation and deployment to operating and customization.
Reference
Topics in the Reference section contain all of the Commerce+ Transaction Server reference documentation.
REST API
The REST API reference describes the available endpoints for customizing the system. Essential information such as the resource path, descriptions of each operation, and samples of the request and response payloads is provided.
Setting up a local Swagger instance
You can use a local Swagger instance to review and test new REST APIs.

Documentation
This Help Center provides documentation on all aspects of the HCL Commerce+ Transaction Server product, from installation and deployment to operating and customization.
- Overview
  Welcome to the HCL Commerce+ Transaction Server overview. Explore these feature overviews to learn how Commerce+ Transaction Server operates. Refer to the related links listed at the end of each topic to access expanded product documentation.
- Deploying
  This section provides details on deploying HCL Commerce+ Transaction Server. It explains how to download the Docker images and Git bundles that comprise the product, how to create a minimal environment, and how to plan for a full deployment. It details supported software versions, patches, and configurations to ensure the platform performs well.
- Migrating
  The following topics show how to migrate an existing HCL Commerce Version 9.1 environment to Commerce+ Transaction Server.
- Operating
  The topics in this section focus on tasks that are performed by business users, marketers, and customer support representatives to connect with partners and attract and satisfy customers.
- Administering
  The site administrator performs the tasks needed to support day to day operations of the Commerce+ Transaction Server site.
- Extending
  Using Commerce+ Transaction Server's xC programming model, you can use HCL-provided extension points to extend existing Commerce logic. You can implement these extensions with the xC Customization toolkit provided by HCL. Commerce+ also provides Packaged Business Capability integrations that extend the product's reach and functionality.
- Securing
  These topics describe the security features of Commerce+ Transaction Server 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 Commerce+ Transaction Server site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with Commerce+ Transaction Server, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the Commerce+ Transaction Server reference documentation.
  - REST API
    The REST API reference describes the available endpoints for customizing the system. Essential information such as the resource path, descriptions of each operation, and samples of the request and response payloads is provided.
    - Setting up a local Swagger instance
      You can use a local Swagger instance to review and test new REST APIs.
    - Testing REST APIs
      Commerce+ Transaction Server supports the OpenAPI 3.0 specification from Version 9.1.6.0 onwards. You can use the Swagger specification to test any RESTful APIs that are documented in OAS files.
    - Administrative REST API
      You can use the Commerce+ Transaction Server administrative API to complete administrative tasks for managing your site. The Administrative API contains a list of resources that are provided for creating, retrieving, changing, and deleting data to administer your site globalization capabilities, organizations, and more.
    - Solr Search REST API
      These API's can be used to create and administer search capabilities and features, such as to create facets, define search fields, field properties, and more.
    - Storefront REST API
      Commerce+ Transaction Server Storefront REST API documentation contains a list of resources that are provided by the Commerce+ Transaction Server REST API for retrieving, changing, and deleting data related to a store. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
    - Externalized customization
      You can use the Commerce+ Transaction Server xC API to extend the behavior of HCL Commerce controller or task commands. These APIs provides a range of resources for extending capabilities related to orders, payments, users, and more.
  - Mapping of REST services to storefront checkout actions
    The Aurora starter store uses REST services throughout the checkout process. The actions for each page map to a REST service.
  - REST service annotations
    Commerce+ Transaction Server REST services and Search REST services are annotated so you view and test the APIs with Swagger, an interactive REST service interface. The REST Discovery API generates a list of REST resources and APIs by parsing annotations on a resource handler. By documenting your custom REST resource handlers with the same annotation standards as Commerce+ Transaction Server REST services, your custom REST services can be viewed and tested with Swagger.
  - Run Engine commands
    The following Run Engine commands are available by default for you to configure the applications that are running inside the containers.
  - Commerce+ Transaction Server database schema
    The Commerce+ Transaction Server database model was designed for data integrity and optimal performance. Commerce+ Transaction Server provides several hundred tables that store Commerce+ Transaction Server instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
  - Tag: eMarketingSpotCache
    You can include the wcf:eMarketingSpotCache tag within an e-Marketing Spot JSP fragment to indicate that the JSP fragment is to be dynamically cached. This tag dynamically sets dependency IDs for e-Marketing Spot cache entries.
  - Payments subsystem
    In Commerce+ Transaction Server, payment processing uses the Payments subsystem.
  - Commerce+ Transaction Server web services
    Commerce+ Transaction Server provides many web services.
  - Utilities
    In Commerce+ Transaction Server utilities are scripts that perform operations such as loading access control policies, loading store data, and cleaning the database of obsolete objects. In runtime environments, run utilities from the Utility server Docker container. In the development environment, run utilities from the bin directory.
  - Messaging system URLs
    The following URLs relate to the Messaging system.
  - Scheduler URLs
    The server subsystem consists of functions that are associated with URLs that are run by the scheduler.

Setting up a local Swagger instance

You can use a local Swagger instance to review and test new REST APIs.

Use the following instructions to install a local instance of the browser-based, open source Swagger Editor to design document REST APIs created using the Swagger Specification. The editor works alongside the Swagger User Interface, which you also install locally. Pre-built Docker containers are available for both tools, so you can install them easily on any Docker-enabled server.

Deploying Swagger Editor: To deploy the Swagger editor container, run the following Docker Commands:
- Pull: docker pull swaggerapi/swagger-editor
- Run: docker run -d -p 5440:8080 swaggerapi/swagger-editor
To access the swagger editor, navigate to http://localhost:5440/

Deploying Swagger User Interface: To deploy the Swagger User Interface container, run the following Docker Commands.
- Pull: docker pull swaggerapi/swagger-ui
- Run: docker run -d -p 5440:8080 swaggerapi/swagger-editor
To access the Swagger User Interface, navigate to http://localhost:5440/

Ensure that you whitelist the Swagger editor/UI domain by adding it in your CORS configuration.

For more information about using Swagger to view and validate new REST APIs, see Testing REST APIs.