Home
HCL Digital Experience 9.5 [Legacy content]
Docker and Containerization
Find topic information about Docker and Containerization for HCL Digital Experience.
Containerization
Learn more about HCL Digital Experience 9.5 Containerization and Deployment.
Digital Experience on containerized platforms
Learn how to deploy HCL Digital Experience as a cloud-native platform and optimize business-critical digital experiences for your customers.
Digital Experience application deployment
This section outlines features and functionality delivered as part of continuous integration and continuous delivery for HCL Digital Experience.
Deploy DX components using HCL DXClient and DXConnect
HCL Digital Experience (DX) 9.5 CF19 and later releases include a DXClient toolset, and DXConnect servlet that provides developers and administrators with an approach to deploy changes or improvements to the DX platform, and partially automate the development and delivery process.
DXClient Artifact Types
This section provides information about the artifact types that are currently supported by the DXClient tool.

HCL Digital Experience 9.5 [Legacy content]
- Overview
  HCL Digital Experience provides a single access point to web content and applications, while it delivers differentiated, personalized experiences for each user across multiple touchpoints, such as web, mobile, hybrid mobile/web applications, and more.
- Supported migration paths
  Migration is supported between equivalent HCL Digital Experience offerings.
- Supported installation and upgrade paths
  Installation and upgrade is supported between equivalent HCL Digital Experience offerings.
- Getting the software
  New and existing users need to register at the HCL Software License Portal and download their entitled HCL Digital Experience package(s).
- Creating your website
  Review the following topics to understand how to create your website using the latest HCL Digital Experience.
- Installing HCL Digital Experience
  Review the planning information on HCL Digital Experience, then select your operating system and installation pattern that most reflects your business needs.
- Configuring
  Run the following tasks after you install and deploy HCL Digital Experience. They address tasks that are typically run one time and have a global effect. Some configuration changes are made more frequently or do not have a global effect. These tasks are addressed in the Administering section.
- Backup and restore
  Backup and recovery of data files and databases is an essential operation for any business system, particularly for data and applications that run in production environments. Create and follow a plan for backing up and recovering data on all tiers of your HCL Digital Experience deployment. IBM Installation Manager must also be included in backup and recovery planning. If you back up the HCL Portal file structure and then install a fix pack, your HCL Digital Experience and IBM Installation Manager become out of sync after you restore the HCL Portal file system. This condition is not recoverable.
- Migrating
  Successful migration requires significant planning and preparation, understanding the tools that are involved, and careful execution of the appropriate steps in the order provided.
- Integrating
  Integrate HCL Digital Experience with software such as HCL Sametime to enable your users to collaborate more easily. You can also use the unified task list portlet to integrate HCL with your backend business process software, such as IBM Process Server.
- Administering
  Use the administration tools that are provided with the HCL Digital Experience to do various day-to-day administration tasks.
- Securing
  Security tasks include setting up property extension databases and custom user repositories, configuring and activating SSL, and configuring authentication. In addition, tasks such as activating Federal Information Processing Standards (FIPS) and NIST SP800-131a security modules and configuring external security managers such as Security Access Manager might be required to secure your portal environment.
- Monitoring
  HCL Portal includes tools and features to help you monitor the portal site.
- Setting up a website
  Setting up a website includes, creating pages, adding navigation, setting up search, and adding content to the site. Themes are used to customize the portal's look-and-feel. Out-of-the-box templates and the site wizard can help you set up your portal site faster. You can add wikis and blogs to your site and let users tag and rate content on your site.
- Staging to production
  During portal solution development, the solution is initially developed, tested, and refined on one server or a limited number of servers. The solution is deployed later on live systems, referred to as the production environment. The process of moving the solution from the development environment to the production environment is called staging.
- Developing
  This section includes developer documentation on extending applications and development assets for HCL Portal and HCL Web Content Manager.
- Docker and Containerization
  Find topic information about Docker and Containerization for HCL Digital Experience.
  - Docker overview
    HCL Digital Experience 9.5 supports deployments on Docker and popular Kubernetes platforms. Learn more about the latest list of container images and supported deployment platforms.
  - Containerization
    Learn more about HCL Digital Experience 9.5 Containerization and Deployment.
    - Containerization overview
      Learn more about the containerization architecture, including the supported container platforms in deploying HCL Digital Experience images for your environment.
    - Requirements and limitations
      This section describes the requirements to deploy the HCL Digital Experience 9.5 images to container platforms and current limitations.
    - DX Kubernetes support matrix
    - Digital Experience on containerized platforms
      Learn how to deploy HCL Digital Experience as a cloud-native platform and optimize business-critical digital experiences for your customers.
      - Docker image list
      - dxctl
        Learn how to use dxctl for custom HCL Digital Experience 9.5 container deployments
      - Helm-based deployment
      - Red Hat OpenShift
        Learn how to deploy HCL Digital Experience (DX) 9.5 to Red Hat OpenShift platform.
      - Amazon Elastic Kubernetes Service (Amazon EKS)
        Learn how to deploy, find, understand, and customize the different releases of HCL Digital Experience 9.5 containers, along with Ambassador to Kubernetes, as verified in Amazon Elastic Kubernetes Service (Amazon EKS).
      - Microsoft Azure Kubernetes Service (AKS)
        Learn how to deploy HCL Digital Experience (DX) 9.5 CF182 and later container release along with Ambassador to Kubernetes, as verified in Microsoft Azure Kubernetes Service (AKS).
      - Google Kubernetes Engine (GKE)
        Learn how to deploy different releases of HCL Digital Experience (DX) containers, along with the Ambassador, to Kubernetes as verified in Google Kubernetes Engine (GKE).
      - Install Experience API, Content Composer, and Digital Asset Management
        This section provides a high-level overview of the architecture and the steps to install, configure, and update the HCL Digital Experience 9.5 components: Experience API, Content Composer, and Digital Asset Management.
      - Docker and Container initialization performance
        Beginning with from HCL Digital Experience 9.5 Container Update CF192 release, container DX applications initialization performance is improved. Review the following guidance for information, defaults, and options to manage container applications initialization performance when deployed to Docker, Red Hat OpenShift, and Kubernetes platforms.
      - Customizing your container deployment
        This section outlines the customization options when deploying HCL Digital Experience Container.
      - Container administration
        The information in this section enables administrators to manage select operations performance controls, and to update and replace their HCL Digital Experience 9.5 container images with the latest 9.5 container update release.
      - Digital Experience application deployment
        This section outlines features and functionality delivered as part of continuous integration and continuous delivery for HCL Digital Experience.
        Deploying Container artifact updates with minimal operations downtime
        This topic provides guidance to update artifacts in HCL Digital Experience container deployments while minimizing operations downtime.
        Managing staging to production operations
        If you create an HCL Digital Experience 9.5 container staging server in Kubernetes, do the following steps to publish your Digital Asset Management repository items to a production HCL Digital Experience 9.5 container deployment in Kubernetes.
        Deploying Custom Code to HCL Digital Experience in OpenShift
        This section outlines deploying custom code to HCL Digital Experience in OpenShift.
        HCL DX 9.5 On-premises to Container staging
        This section describes how to move from an existing HCL Portal environment to a containerized Digital Experience environment.
        Deploy DX components using HCL DXClient and DXConnect
        HCL Digital Experience (DX) 9.5 CF19 and later releases include a DXClient toolset, and DXConnect servlet that provides developers and administrators with an approach to deploy changes or improvements to the DX platform, and partially automate the development and delivery process.
        DXClient
        DXClient is a tool that helps developers and administrators manage tasks, such as uploading one or more portlets or Script Applications, from source development environments to target HCL DX 9.5 deployments. This tool is capable of taking artifacts developed locally and deploying them to DX 9.5 servers deployed to supported on-premises platforms in standalone, cluster, or farm-topologies and supported Kubernetes platforms.
        DXClient Artifact Types
        This section provides information about the artifact types that are currently supported by the DXClient tool.
        Portlets
        This topic provides information about the deployment and undeployment of portlets.
        Script applications
        This topic provides information about the deployment, undeployment, and restoration of script applications.
        XML Access
        This topic provides information about the xmlaccess command that is used to export or import portlet configurations.
        Themes
        This topic provides information about the deployment and undeployment of themes artifacts.
        Digital Experience applications
        This section provides information about the deployment of DX application artifacts by using the DXClient tool.
        DX Core server
        This topic provides information about restarting the DX Core server and on creating core server configuration report using the DXClient tool. The dx-core-configuration-reportscommand is used to generate the differential reports on various core configurations between two DX server nodes.
        WCM libraries
        This section provides information about how to export and import WCM libraries using DXClient.
        Web Content Syndicators and Subscribers
        The section provides information about using the DXClient process to automate the management of Web Content Manager Syndicators, Subscribers, and get-syndication reports. For more information on the process and settings of the Web Content Manager Syndicators and Subscribers, see panel_help/wcm_syndication.html.
        Shared library
        Shared libraries are jar files representing code that is shared across multiple components of the customer, for example, portlets, themes, preprocessors, and others.
        Troubleshooting DXClient
        Logs can be enabled and disabled as desired by DX developers and administrators through configuration options in the config.json file of DXClient. The log files can be viewed inside the logs folder within the DXClient installation folder.
        DXConnect
        DXConnect is a servlet-based internal application deployed on top of IBM WebSphere Application Server in the HCL DX 9.5 CF19 and later releases, under the Configuration Wizard profile - cw_profile. DXConnect enables the DXClient tool to connect over an HTTP or HTTPS connection from a client development machine or remote server to a source or target HCL DX 9.5 server to execute certain tasks requested via DXClient commands. This topic covers the DXConnect installation and configuration instructions.
        Sample Pipelines for the node package file
        This topic describes how to install the DXClient tool in a pipeline, by providing a few sample pipelines such as pipelines for deploying a portlet, theme, and script application. It is designed to be run from a Jenkins job with the following parameters:
        Sample Pipelines for the Docker image file
        This sample shows how to pull DXClient docker image from the given artifactory, run the DXClient tool in the docker and then deploy a portlet, theme, and script application. It is designed to be run from a Jenkins job that provides the following parameters:
      - Troubleshooting cloud container
        This section lists the basics of troubleshooting the containerized image or your deployment.
    - Hybrid Deployment
- Practitioner Studio
  Practitioner Studio is a newly designed user experience for HCL Digital Experience. Please see the following pages to understand how the new navigation is organized.
- HCL Experience API
  This shows developers how to provision, configure, and use the HCL Experience API with the HCL Digital Experience 9.5 platform.
- HCL Content Composer
  The HCL Content Composer delivers simplified processes for creating and managing Digital Experience site content.
- HCL Digital Asset Management
  HCL Digital Asset Management (DAM) adds a central platform to store and include rich media assets in Digital Experience site content to present engaging, consistently branded experiences across digital channels.
- The Woodburn Studio demo site
  The Woodburn Studio is a website that demonstrates the use of some of the popular HCL Digital Experience features.
- Reference
  View information that can help you use our product documentation including terms of use, trademarks, and more.

DXClient Artifact Types | HCL Digital Experience

This section provides information about the artifact types that are currently supported by the DXClient tool.

Limitations:

If deploying CICD artifacts using DXClient to the Red Hat OpenShift environment, you might receive failure messages while you run the deploy-theme, deploy-application, or restart-dx-core commands. This might happen because of a connection getting closed due to timeout before the response is ready. In such situations, before re-triggering the request, we advise you to check your target server to verify if the application has been deployed or the server is up, as the request was already triggered from the client-side.

The following list shows some of the deprecated parameters and the new parameters that replace them in CF201 and later releases. It is recommended that you start using the new parameters because the old parameters are removed starting in CF210.

-dxConnectHostname replaced by -hostname
-targetServerHostname replaced by -targetHostname
-targetServerPort replaced by -targetDxConnectPort
-targetServerUsername replaced by -targetDxConnectUsername
-targetServerPassword replaced by -targetDxConnectPassword
-targetServerProfileName replaced by -targetDxProfileName

Note: The attribute -dxConnectHostname is deprecated in CF202 and later releases. It is recommended that you start using the replacement parameter -hostname starting from CF202 wherever necessary.