DXClient

DXClient is a command line tool featuring a single, unified interface to all HCL Digital Experience (DX) automation and CI/CD-related tasks. It helps developers manage several DX tasks such as uploading one or more portlets, Script Applications, and themes. Administrators can manage WCM libraries, PZN rules, shared libraries, etc.

DXClient can take artifacts developed locally and deploy them to HCL DX servers independently of whether these are deployed on-premises platforms in standalone, cluster, or farm-topologies, or in a container environment.

DXClient is meant to be the one-stop, platform-independent solution that lets you integrate HCL DX with any automation infrastructure of your choice.

• Installing DXClient
  This topic describes how to install, upgrade, verify, and uninstall DXClient.
• Configuring DXClient
  This topic describes how to configure DXClient in your HCL DX environment.
• DXClient commands
  This topic describes the different commands you can use in DXClient.
• DXClient artifact types
  This topic provides information about the artifact types that are currently supported by DXClient.
• Sample pipeline settings using DXClient
  This topic provides sample pipelines for use with DXClient
• Troubleshooting DXClient
  This topic describes how to troubleshoot DXClient issues.
• Limitations
  This topic describes the limitations of DXClient.
• DXConnect
  This topic describes DXConnect, an application that 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.

Architecture

The following image illustrates the DXClient Architecture diagram:

What's New and release history

Latest updates

For CF229, a few NPM libraries have been upgraded for code maintenance. These changes have no impact on the current workings of DXClient.

For a complete history of features added in each release, refer to the Feature Release History section.

Feature release history

Note

Refer to the list of features that were released in the following HCL DX 9.5 releases:

• HCL DX 9.5 CF230 release: **V230.0.0

  • XMLAccess parameter xmlAccessOutputFileName added for filename for the XMLAccess output.

• HCL DX 9.5 CF229 release: **V229.0.0

  • NPM libraries are upgraded for code maintenance.

• HCL DX 9.5 CF227 release: **V227.0.0

  • Livesync is enabled for Style-sheet Components under WCM Design Library.

• HCL DX 9.5 CF226 release: **V226.0.0

  • Enabled TLS certificate validation while using DXClient.

• HCL DX 9.5 CF225 release: **V225.0.0

  • Livesync is enabled for Presentation Template under WCM Design Library.

• HCL DX 9.5 CF224 release: **V224.0.0

  • New DXClient LiveSync sub-commands: LiveSync push-wcm-design-library and pull-wcm-design-library
  • Livesync is enabled for HTML Components under WCM Design Library.

• HCL DX 9.5 CF221 release: **V221.0.0

  • A one-time license agreement prompt is enabled. To skip the prompt, use the accept-license command.
  • DXClient is now openly distributed in NpmJS and Harbor repository.
  • In DAM Staging tasks, the parameters dxWASUsername, dxWASPassword, targetServerWASUsername, and targetServerWASPassword are now deprecated and should no longer be used.
  • The DAM Reindexing process involves indexing all existing assets while revalidating stale indexes. For more information on how to trigger DAM Reindexing, refer to DXClient commands.

• HCL DX 9.5 CF219 release: **V1.28.0

  • Enabled multiple environment configuration in node version

• HCL DX 9.5 CF216 release: **V1.25.0

  • Shows version compatibility details between DX Core and DXClient
  • Resync DAM Staging environments
  • Delete staging mismatch

• HCL DX 9.5 CF215 release: **V1.24.0

  • Find staging mismatch
  • Download mismatch report

• HCL DX 9.5 CF214 release: **V1.23.0

  • Lists all WebDAV themes when you pull themes and themeName is not provided.
  • LiveSync is supported in scaled DX environment setups.
  • LiveSync Improvements

• HCL DX 9.5 CF213 release: **V1.22.0

  • LiveSync

• HCL DX 9.5 CF211 release: **V1.20.0

  • Deploy and Undeploy Applications

• HCL DX 9.5 CF210 release: **V1.19.0

  • Removed parameters deprecated during CF201 and CF202 deployment.

  • Added additional attribute - virtualPortalContext. Exporting and Importing WCM libraries

• HCL DX 9.5 CF209 release: **V1.18.0

  • Restart All Core Pods in Kubernetes Deployment

• HCL DX 9.5 CF208 release: **V1.17.0

  • Get all subscribers details for DAM staging

• HCL DX 9.5 CF207 release: **V1.16.0

  • Support to set different Container Runtime.

• HCL DX 9.5 CF202 release: **V1.11.0

  • Deprecated parameter dxConnectHostname. It is recommended that you start using the replacement parameter -hostname starting from CF202 wherever necessary.
  • DAM Assets Export and import

• HCL DX 9.5 CF201 release: **V1.10.0

  • An optional parameter requestId added to Deploy theme, Deploy application, Restart DX Core server, and Manage virtual portals.

  • Retrieve feature added to the Resource environment provider.

  • Accessing ConfigWizard in container environment

  • Note that a few parameters are deprecated and replaced with new parameters in the DX Core configuration reports. For information, see DX Core server configuration report.

• HCL DX 9.5 CF200 release: **V1.9.0

  • Exporting and Importing WCM libraries
  • DX Core server configuration report

• HCL DX 9.5 CF199 release: **V1.8.0

  • DAM Staging
  • Create credential vault slot
  • Create syndication relation
  • Export and import multiple resource environment providers
  • Specify the context root for exporting and importing personalization rules

• HCL DX 9.5 CF198 release: **V1.7.0

  • List DAM schemas
  • Personalization export and import rules
  • Resource environment provider
  • Manage virtual portals

• HCL DX 9.5 CF197 release: **V1.6.0

  • Undeploy portlets
  • Deploy and undeploy themes
  • Deploy application
  • manage get-syndication report
  • Restart Core
  • Delete DAM schema

• HCL DX 9.5 CF196 release: **V1.5.0

  • Shared library

• HCL DX 9.5 CF195 release: **V1.4.0

  • Undeploy theme
  • MLS export and import of WCM library

• HCL DX 9.5 CF193 release: **V1.2.0

  • Restart DX Core server
  • Deploy Application
  • Managing syndicators
  • Managing subscribers

• HCL DX 9.5 CF192 release: **V1.1.0

  • Undeploy script applications
  • Deploy theme (EAR and WebDAV based)

• HCL DX 9.5 CF19 release: **V1.0.0

  • Deploy Portlets
  • Deploy script applications
  • XML Access
  • Restore Script Application

HCLSoftware U Learning Materials

To get an introduction to development for HCL DX, go to HCL DX for Developers (Beginners). Ensure you setup the DXClient that allows you to develop locally using the DXClient for Beginners Lab.

For an introduction and a demo on DX staging, go to Staging for Beginners.

To learn how to use staging tools such as DXClient, Syndication, XMLAccess, ReleaseBuilder/Solution Installer, and ConfigEngine, go to Staging for Intermediate Users. You can try it out using the Staging Lab for Intermediate Users and corresponding Staging Lab Resources.