### Verify DXClient Installation Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md Run this command to confirm that the DXClient tool is successfully installed and to display its version. A valid version output indicates a successful setup, allowing you to proceed with CI/CD actions. ```shell dxclient -V ``` ```cmd dxclient.bat -V ``` -------------------------------- ### Get Detailed Help for a Specific DXClient Command Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md Use this command to display detailed help and usage information for a specific DXClient command. Replace `[command]` with the name of the command you need assistance with. ```shell dxclient help [command] ``` -------------------------------- ### Start DAM Staging Resync with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to start a resynchronization process for Digital Asset Management (DAM) staging. It helps in bringing environments back into sync after discrepancies are found. ```APIDOC dxclient manage-dam-staging start-staging-resync [options] ``` -------------------------------- ### Display DXClient Main Help Document Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md These commands display the main help document for the DXClient tool, providing an overview of available commands and general usage information. ```shell dxclient ``` ```shell dxclient -h, --help ``` -------------------------------- ### Run DXClient Application Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md Execute the appropriate DXClient script to launch the application on your operating system. Ensure the `IMAGE_TAG` and `IMAGE_NAME` variables are correctly configured before running. ```shell dxclient ``` ```cmd dxclient.bat ``` -------------------------------- ### Get All DAM Staging Subscribers with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to retrieve details for all subscribers configured for Digital Asset Management (DAM) staging. It provides an overview of active subscriptions. ```APIDOC dxclient manage-dam-staging get-all-subscribers [options] ``` -------------------------------- ### Trigger DAM Staging with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to trigger the Digital Asset Management (DAM) staging process. It initiates the synchronization of DAM assets. ```APIDOC dxclient manage-dam-staging trigger-staging [options] ``` -------------------------------- ### Display DXClient Version Number Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command shows the currently installed version number of the DXClient tool. ```shell dxclient -V, --version ``` -------------------------------- ### Check DXClient and DX Core Version Compatibility Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md Use this command to assess the compatibility between your installed DXClient version and the HCL DX Core server version. Maintaining compatibility is critical for expected functionality and to avoid issues with CI/CD operations. ```shell dxclient version-compat ``` ```cmd dxclient.bat version-compat ``` -------------------------------- ### Get Syndication Failed Report with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes and retrieves a report detailing failed syndication operations within the HCL Digital Experience environment. It helps in monitoring and troubleshooting content synchronization issues. ```APIDOC dxclient manage-syndicator get-syndication-report [options] ``` -------------------------------- ### Pull DXClient Docker Image Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command pulls the DXClient Docker image from the HCL Container Registry. Users must replace `IMAGE_TAG` with the specific version tag obtained from the provided tables to get the desired DXClient version. ```shell docker pull hclcr.io/dx-public/dxclient:IMAGE_TAG ``` -------------------------------- ### List All DAM Schemas with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to list all existing Digital Asset Management (DAM) schemas configured within the HCL Digital Experience environment. ```APIDOC dxclient list-dam-schemas [options] ``` -------------------------------- ### Manage Resource Environment Provider with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command allows for the creation, update, or deletion of custom properties associated with an existing Resource Environment Provider in HCL Digital Experience. ```APIDOC dxclient resource-env-provider [options] ``` -------------------------------- ### Register DAM Staging Subscriber with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to register a subscriber for Digital Asset Management (DAM) staging. It enables content synchronization for DAM assets. ```APIDOC dxclient manage-dam-staging register-dam-subscriber [options] ``` -------------------------------- ### Show DXClient Version Compatibility Details Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command displays compatibility details between DX Core and DXClient versions. Optional `[command]` and `[options]` can be used to refine the compatibility check for a specific command or with additional parameters. ```shell dxclient version-compat [command] [options] ``` -------------------------------- ### dxclient Command-Line Interface (CLI) API Documentation Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This section details the various commands available within the 'dxclient' utility. Each entry describes a specific command, its purpose, and indicates if it accepts additional options. This serves as an API-like reference for interacting with the HCL Digital Experience platform via the command line. ```APIDOC dxclient CLI Commands: - Command: dxclient Description: Help document for the commands usage - Command: dxclient version-compat Description: Command to show version compatibility details - Command: dxclient accept-license Description: Command to explicitly accept the license without prompt - Command: dxclient deploy-portlet [options] Description: Command to execute the deploy portlet action - Command: dxclient undeploy-portlet [options] Description: Command to execute the undeploy portlet action - Command: dxclient xmlaccess [options] Description: Command to execute the xmlaccess action - Command: dxclient deploy-scriptapplication [options] Description: Command to execute the deploy script application action - Command: dxclient undeploy-scriptapplication [options] Description: Command to execute the undeploy script application action - Command: dxclient restore-scriptapplication [options] Description: Command to execute the restore script application action - Command: dxclient deploy-theme [options] Description: Command to execute the deploy theme action - Command: dxclient undeploy-theme [options] Description: Command to execute the undeploy theme action - Command: dxclient deploy-application [options] Description: Command to execute the deploy application action - Command: dxclient undeploy-application [options] Description: Command to execute the undeploy application action - Command: dxclient manage-syndicator [options] Description: Command to execute the syndicator action - Command: dxclient manage-subscriber [options] Description: Command to execute the subscriber action - Command: dxclient restart-dx-core [options] Description: Command to execute the DX Core restart action - Command: dxclient mls-export [options] Description: Command to export content of a WCM Library for translation ``` -------------------------------- ### Import Personalization Rules with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command is used to import personalization rules into a target HCL Digital Experience server. It facilitates the deployment or restoration of personalization configurations. ```APIDOC dxclient pzn-import [options] ``` -------------------------------- ### Export Personalization Rules with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command is used to export personalization rules from a target HCL Digital Experience server. It allows for backup or migration of personalization configurations. ```APIDOC dxclient pzn-export [options] ``` -------------------------------- ### dxclient Command-Line Interface Overview Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This section lists various `dxclient` commands used for managing different aspects of the HCL Digital Experience server, such as creating credential vaults, exporting/importing WCM libraries and DAM assets, generating reports, restarting pods, and performing LiveSync operations. ```APIDOC dxclient create-credential-vault [options] - Command to create credential vault in the DX server dxclient wcm-library-export [options] - Command to export the wcm libraries from the target server dxclient wcm-library-import [options] - Command to import the wcm libraries from the target server dxclient dx-core-configuration-reports [options] - Command to generate any dx core configuration reports dxclient manage-dam-assets export-assets [options] - Command to export the dam assets dxclient manage-dam-assets validate-assets [options] - Command to validate the dam assets dxclient manage-dam-assets import-assets [options] - Command to import the dam assets dxclient restart-core-pods [options] - Command to execute the Restart Core Pods action (for Kubernetes deployments) dxclient livesync push-theme [options] - Command for watching a theme folder path live and syncs it in DX Server dxclient livesync pull-theme [options] - Command for downloading theme files from DX Server to a target local theme folder dxclient livesync pull-wcm-design-library [options] - Command for downloading WCM Design Library files from DX Server to a target local folder dxclient livesync push-wcm-design-library [options] - Command watching a WCM Design Library folder path live and syncs it in DX Server ``` -------------------------------- ### Delete DAM Schema with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command is used to execute the action of deleting a Digital Asset Management (DAM) schema from the HCL Digital Experience environment. ```APIDOC dxclient delete-dam-schema [options] ``` -------------------------------- ### Common Options for dxclient Commands Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md These attributes can be used with various `dxclient` commands to specify connection details such as hostname, protocol, username, password, and port for connecting to the target server. These options are crucial for authenticating and establishing a connection to the HCL Digital Experience environment. ```APIDOC -hostname [value] - Use this attribute to specify the hostname of the target server -dxConnectProtocol [value] - Use this attribute to specify the protocol with which to connect to the CW server -dxConnectUsername [value] - Use this attribute to specify the username that is required for authenticating to the cw_profile -dxConnectPassword [value] - Use this attribute to specify the password that is required for authenticating to the cw_profile -dxConnectPort [value] - Use this attribute to specify the port number of the cw_profile (for Kubernetes Environment dxConnectPort is 443) ``` -------------------------------- ### Find DAM Staging Mismatch with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to find any mismatches in Digital Asset Management (DAM) staging. It helps identify discrepancies between source and target environments. ```APIDOC dxclient manage-dam-staging find-staging-mismatch [options] ``` -------------------------------- ### Manage Virtual Portal Tasks with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command is used to manage various virtual portal-related tasks within the HCL Digital Experience server. It provides administrative capabilities for virtual portal configurations. ```APIDOC dxclient manage-virtual-portal [options] ``` -------------------------------- ### Import MLS Content with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command is used to import translated content (MLS - Multi-Lingual Support) into the HCL Digital Experience (DX) environment. It facilitates the integration of localized content. ```APIDOC dxclient mls-import [options] ``` -------------------------------- ### Deregister DAM Staging Subscriber with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to deregister a subscriber from Digital Asset Management (DAM) staging. It stops content synchronization for DAM assets. ```APIDOC dxclient manage-dam-staging deregister-dam-subscriber [options] ``` -------------------------------- ### Update DAM Staging Secrets with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to update secrets related to Digital Asset Management (DAM) staging. It ensures secure communication and access for staging operations. ```APIDOC dxclient manage-dam-staging update-secrets [options] ``` -------------------------------- ### Generate DAM Staging Mismatch Report with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command generates a report detailing any mismatches found during the Digital Asset Management (DAM) staging process. The report assists in troubleshooting and resolving synchronization issues. ```APIDOC dxclient manage-dam-staging get-staging-mismatch-report [options] ``` -------------------------------- ### Delete DAM Staging Mismatch with dxclient Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command executes the action to delete records of Digital Asset Management (DAM) staging mismatches. It helps in clearing out resolved or irrelevant mismatch entries. ```APIDOC dxclient manage-dam-staging delete-staging-mismatch [options] ``` -------------------------------- ### Uninstall DXClient Docker Image Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This command removes the DXClient Docker image from your local system, effectively uninstalling the tool. Replace `IMAGE_TAG` with the specific tag of the DXClient image you wish to remove. ```shell docker rmi hclcr.io/dx-public/dxclient:IMAGE_TAG ``` -------------------------------- ### Configure DXClient Image Variables Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md Update the `IMAGE_NAME` and `IMAGE_TAG` variables in the DXClient script files to match the Docker image pulled from HCL Open Harbor. This configuration is crucial for the DXClient application to locate the correct Docker image. ```shell IMAGE_NAME="hclcr.io/dx-public/dxclient" IMAGE_TAG="v95_CF225_20250203-2238" ``` ```cmd SET IMAGE_NAME=hclcr.io/dx-public/dxclient SET IMAGE_TAG=v95_CF225_20250203-2238 ``` -------------------------------- ### Configure dxclient Logger Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/README.md This section describes how to enable or disable logging for `dxclient` by modifying the `enableLogger` parameter in the `config.json` file. When enabled, log files are generated in the `store/logs/` directory, providing detailed insights into `dxclient` operations. ```APIDOC // To enable logger in config.json "enableLogger": true // To disable logger in config.json "enableLogger": false // Logger file location store/logs/ ``` -------------------------------- ### Jenkins Pipeline Parameters for HCL DXClient Deployment Source: https://github.com/hcl-tech-software/dxclient-scripts/blob/main/samples/sample-pipeline-files/README.md This section lists the parameters required to configure Jenkins jobs for deploying HCL Digital Experience (DX) assets using the dxclient tool. Parameters include deployment targets, artifact sources, authentication credentials, and specific asset details for portlets, themes, and script applications. ```APIDOC Parameter: DEPLOY_PORTLET Value: Select this to deploy the portlet Notes: Parameter: DEPLOY_THEME Value: Select this to deploy the theme Notes: Parameter: DEPLOY_SCRIPT_APPLICATION Value: Select this to deploy the script application Notes: Parameter: AGENT_LABEL Value: Jenkins agent label Notes: Determines on which agents the pipeline can run Parameter: ARTIFACTORY_URL Value: URL to dxclient docker image file Notes: docker image will be pulled out from this URL Parameter: REPO_PATH Value: Repo path of the dxclient docker image Notes: docker image will be pulled out from this folder Parameter: IMAGE_TAG Value: docker image tag Notes: docker image will be pulled out using this image tag Parameter: ARTIFACT_PATH Value: URL (except filenames) for artifacts to be deployed Notes: Artifacts fetched via curl Parameter: ARTIFACT_CREDENTIALS_ID Value: Credentials ID in Jenkins store Notes: User name / password credentials needed to access artifact URLs Parameter: DX_HOST Value: Host name or IP address of DX server Notes: Artifacts will be deployed to this server Parameter: DX_PROTOCOL Value: Protocol to connect to DX server Notes: http or https Parameter: DX_PORT Value: Port to connect to DX server Notes: Port for the DX main profile Parameter: DX_CREDENTIALS_ID Value: Credentials ID in Jenkins store Notes: User name / password credentials needed to access DX server Parameter: DXCONNECT_HOST Value: Host name or IP address of the DXConnect servlet (route change only in case of Open Shift Kubernetes Environment. For other case, this parameter should be same as DX_HOST) Notes: Hostname for the DX Configuration Wizard profile Parameter: DXCONNECT_PORT Value: Port to connect to DXConnect servlet Notes: Port for the DX config wizard profile Parameter: DXCONNECT_CREDENTIALS_ID Value: Credentials ID in Jenkins store Notes: User name / password credentials needed to access DX server config wizard profile Parameter: XML_CONFIG_PATH Value: URL path to the config servlet for xmlaccess Notes: Defaults to '/wps/config' Parameter: CONTENT_HANDLER_PATH Value: Alternate path for the portal context root or the content handler servlet Notes: Default to /wps/mycontenthandler/ Parameter: DX_PROFILE_NAME Value: Profile name of the DX server Notes: Parameter: DX_PROFILE_PATH Value: Profile path of the DX server Notes: Parameter: DX_SOAP_PORT Value: Soap Port number of the DX server Notes: Parameter: PORTLET_WAR_ARTIFACT_NAME Value: Filename of WAR to deploy the portlet Notes: Required for deploy portlet Parameter: PORTLET_XML_ARTIFACT_NAME Value: Filename of xmlaccess script used to deploy the portlet Notes: Required for deploy portlet Parameter: THEME_EAR_APPLICATION_NAME Value: Application name for the EAR file to deploy the theme Notes: Required for EAR theme deployment Parameter: THEME_EAR_ARTIFACT_NAME Value: File name of EAR application to deploy theme Notes: Required for EAR theme deployment Parameter: THEME_REGISTRATION_FILE Value: File name of XML file to register the theme Notes: Required for theme registration Parameter: THEME_NAME Value: WEBDAV theme name Notes: Required for WEBDAV theme deployment Parameter: THEME_ARTIFACT_NAME Value: WEBDAV theme zip file name Notes: Required for WEBDAV theme deployment Parameter: SCRIPT_APP_ARTIFACT_NAME Value: Filename of zipped script application to deploy Notes: Required for deploy script application Parameter: MAIN_HTML_FILE Value: File name of Main HTML file within the script application Notes: Required for deploy script application Parameter: WCM_SITE_AREA Value: SiteArea of the Script Application content Notes: Required for deploy script application Parameter: CONTENT_NAME Value: Name of the Script Application instance to be created or updated Notes: Required for deploy script application ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.