@hcl-software/dxclient

v223.0.0

Published

2 months ago

DXClient is a CLI tool to manage tasks such as deploying portlets, script applications and themes easily from source development environments to target HCL DX deployments. This tool is capable of taking artifacts developed locally and deploying them into

Downloads

0High
0Medium
0Low

DXClient

DXClient is a command line tool featuring a single, unified interface to all HCL 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.

DXClient comes with two deployment options:

One option is the DXClient container package. DXClient is packaged as a container that can be run using OCI-based runtimes such as Docker or Podman. It is available as a container image with HCL DX 9.5 CF196 and later releases.
The alternative deployment option is DXClient as native JavaScript code. Customers who want to rely on this deployment option need to install their own Node.js and NPM runtime environment in the correct version and must install necessary dependencies as needed.

Important Note related to DXClient version & distribution: DXClient is now available free to download/install through NpmJS and harbor repositories. Following the decision to openly distribute DXClient, we have changed the current versioning format of DXClient from 1.xx.x to .x.x. For example, the last release version of DXClient was "1.29.0" but the upcoming release is reformatted to "221.0.0". The number 221 is synonymous with the CF Number version of DX deployments.

This document is for the native JS (non-container) version of DXClient

Requirements

To use these tools you will need:

Node.js must be installed on your workstation. It is tested using the LTS versions of Node.js.
Note: You can verify that Node.js is installed by running the following commands:
node -v

Install DXClient with package from HCL Software Portal

Complete the following steps to install the DXClient tool to your local development workstation or automation server.

Download the DXClient.zip file (DXClient_VX_XXXXXXXX-XXXX.zip) to a local directory on the local workstation from your HCL Digital Experience 9.5 CF196 or higher entitlements on the HCL Software License Portal.
run make install to install all dependencies In case of windows OS run make_install.bat to install all dependencies

(Optional)Run the below command in case you prefer to link your application to the local npm module in your machine (Refer to the Notes section before you proceed).

For Linux and Apple MacOS platforms

 make link

For Microsoft Windows platforms:

make_link.bat

Notes:
Avoid using make link command when scripting deployments from an automation server (e.g. in pipelines) as there is a chance of picking up the wrong dependencies during tool version upgrades.

Use the command below to run the application.
For Linux and Apple MacOS platforms

./bin/dxclient

For Microsoft Windows platforms:

node bin/dxclient

Run 'dxclient -V' to verify that the dxclient command line is installed.
A folder named 'store' will be created in your working directory.

You will be able to find the configuration, logger, output, and sample files under location - /store. If you require to create a new configuration, set the environment variable VOLUME_DIR to the desired directory name and run your task. For example:

"Linux and Apple macOS"

 ```
 bash
 export VOLUME_DIR=storeForScriptApplication

 # or if you want spaces in its value, enclose it in double quotes ("")
 export VOLUME_DIR="store for script application"
 ```

"Microsoft Windows"

 ```
 batch
 set VOLUME_DIR=storeForScriptApplication

 :: or if you want spaces in its value
 set VOLUME_DIR=store for script application
 ```

 !!!important
     Do not enclose the value of `VOLUME_DIR` in double quotes ("") in Windows. This produces errors when executing DXClient commands.

The VOLUME_DIR requires read and write access permissions. Set appropriate permissions for the VOLUME_DIR as per user/group/owner.

"Linux and Apple macOS"

 ```
 bash
 chmod xxx <working-directory>/<VOLUME_DIR>

 # where xxx is a 3-digit number where each digit can be anything from 0 to 7.
 # Ref: https://wiki.archlinux.org/title/File_permissions_and_attributes#Numeric_method
 ```

"Microsoft Windows"

 ```
 1. Right click `<working-directory>/<VOLUME_DIR>` directory > "Properties" > "Security" Tab.
 2. Set the appropriate permission for the folder.
 ```

You can find the configuration, logger, and output files under <working-directory>/<VOLUME_DIR>.

Common command arguments can be pre-configured inside the config.json file available under the <working-directory>/<VOLUME_DIR> folder. A sample configuration file that can be used on on-premises platforms in standalone, cluster (default-config.json), or Kubernetes (default-config-kube.json) platforms is also available under /samples/sample-configurations for reference. If you want to override any of the parameters in the config.json, add them in your command line.

DXClient uninstall

To uninstall the DXClient tool, follow the commands below.

For Linux and Apple MacOS platforms:

make clean

For Microsoft Windows platforms:

make uninstall.bat

To unlink the DXClient tool, follow the commands below.

For Linux and Apple MacOS platforms:

make unlink

For Microsoft Windows platforms:

make_unlink.bat

Install/Uninstall DXClient from NpmJS registry

Use npm install @hcl-software/dxclient command to install the latest version of DXClient.

Use npm install -g @hcl-software/dxclient command to install DXClient globally.

Use npm uninstall @hcl-software/dxclient command to uninstall.

This option to install/uninstall are avaialble from HCL DX 9.5 CF221 deployment. The latest version you install will be "221.0.0".

Note: To install dxclient on a Windows OS in an empty folder, first create an empty package.json file before running the npm install commands.

Additional Information

The attribute -dxConnectHostname has been deprecated (since CF202) and removed (since CF210) and must be replaced with -hostname wherever necessary.
The attribute -targetServerHostname, -targetServerPort,-targetServerUsername,-targetServerPassword & -targetServerProfileName has been deprecated (since CF202) and removed (since CF210) and must be replaced with -targetHostname, -targetDxConnectPort,-targetDxConnectUsername,-targetDxConnectPassword & -targetDxProfileName respectively wherever necessary.
If deploying or importing huge CICD artifacts using DXClient to the Kubernetes environment, you might receive failure or request pending messages while you run the ceratin tasks. This might happen because of the connection getting closed by the load balancer 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 artifact has been deployed/imported or the server is up, as the request was already triggered from the client-side. In cases of request pending you are expected to receive a requestId which you can use to check the status of response later. Find troubleshooting tips here.
The maximum input file size allowed in DXClient is 256 MB currently. This limitation will be addressed in one of the future releases.
As of CF213, the property DXCONNECT_MAX_MEMORY_SIZE_MB in DXC_ConfigSettings Resource Environment Provider has been removed. Refer DXC_ConfigSettings for more details.

Verify the DXClient installation

Successful installation of the DXClient tool can be checked using the "dxclient -V" command which should show the version of the DX Client tool installed.

Once installed, commands can be executed using the DXClient tool to perform CI / CD actions on HCL DX 9.5 servers.

Important: The DXClient version is mostly forward and backward compatible with the DX CF versions. However, in some cases, it might not work as expected if the CF versions are different. Make sure that the CF versions of both DXClient and DX Core are the same in your installation. You may use "dxclient version-compat" to check version compatibility between DX Core and DXClient.

DXClient Release Timelines & Updates

If connecting to an HCL DX 9.5 CF19 deployment, the DXClient tool provides commands supporting the following artifact types along with the documentation -

deploy/undeploy portlets
deploy script applications
xmlaccess
restore script application

If connecting to an HCL DX 9.5 CF192 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation -

undeploy script applications
deploy themes (EAR & WebDAV based)

If connecting to an HCL DX 9.5 CF193 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation -

restart application
deploy application
manage syndicator
manage subscriber

If connecting to an HCL DX 9.5 CF195 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

undeploy theme

If connecting to an HCL DX 9.5 CF196 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

shared library

If connecting to an HCL DX 9.5 CF197 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Get Syndication failed report
Delete DAM schema

If connecting to an HCL DX 9.5 CF198 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Resource Environment Provider Updates - Create,update and delete
Create/import/export/list of virtual portal
Import and Export PZN
List DAM schemas

If connecting to an HCL DX 9.5 CF199 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Resource Environment Provider Updates - Export and Import
Create Credential Vault Slot
Create Syndication Relation
DAM Staging - Register, Deregister and Trigger

If connecting to an HCL DX 9.5 CF200 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

WCM Libraries - Export and Import
DX Core Configuration Reports - summary-report

If connecting to an HCL DX 9.5 CF201 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

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.

If connecting to an HCL DX 9.5 CF202 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

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

If connecting to an HCL DX 9.5 CF207 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Support to set different Container Runtimes.

If connecting to an HCL DX 9.5 CF208 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Get all subscribers details for DAM staging

If connecting to an HCL DX 9.5 CF209 deployment, the DXClient tool provides commands supporting the following additional artifact types along with the documentation

Restart Core Pods in a Kubernetes Deployment

If connecting to an HCL DX 9.5 CF210 deployment, following changes are to be expected.

Removed paramaters deprecated during CF201 & CF202 deployment.
added ability to export/import wcm libraries in Virtual Portal.

If connecting to an HCL DX 9.5 CF211 deployment, following changes are to be expected.

Deploy and Undeploy Applications

If connecting to an HCL DX 9.5 CF213 deployment, following changes are to be expected.

Livesync of WebDAV based Themes

If connecting to an HCL DX 9.5 CF214 deployment, following changes are to be expected.

Livesync Improvements
- List themes during Pull theme in case themeName is not provided.
- Livesync is now supported in scaled DX environment setups

If connecting to an HCL DX 9.5 CF216 deployment, following changes are to be expected.

Show Version compatibility details between DXCore and DXClient

If connecting to an HCL DX 9.5 CF219 deployment, following changes are to be expected.

Enabled multiple environment configuration in node version

If connecting to an HCL DX 9.5 CF221 deployment, following changes are to be expected.

DXClient Version Type(Node/Container) information available using help/version-compat commands
A one time license agreement click-through is enabled. To skip the prompt, use "accept-license" command.
DXClient will be openly distributed in NpmJS & harbor repository.
In DAM Staging tasks, the parameters dxWASUsername, dxWASPassword, targetServerWASUsername, and targetServerWASPassword are now deprecated and should no longer be used.

DXClient configuration

Common command arguments that are listed in config.json can be pre-configured via this file. The common arguments could also be provided through command line. If so, it will override the values in config.json and execute.

A sample configuration file that could be used on-premises platforms in standalone, cluster platforms is also available under samples/sample-configurations/default-config.json for reference.

DXClient Commands

make link: To create a symlinks to global npm folder for Microsoft Windows platforms
make_link.bat : To create a symlinks to global npm folder
make unlink: To remove the symlink created by the make link
make_unlink.bat: To remove the symlink created by the make link for Microsoft Windows platforms
make install: To install all dependency
make_install.bat : To install all dependencies of windows OS
make uninstall: To uninstall the package and dependency
make_uninstall.bat: To uninstall the package and dependency of windows OS

To list the artifact details, run

dxclient                                        - help document for the commands usage
dxclient accept-license							- command to skip prompt of click-through license acceptance agreement.
dxclient version-compat							- command to show version compatibility details between DX Core and DXClient
dxclient deploy-portlet [options]               - command to execute the deploy portlet action
dxclient undeploy-portlet [options]             - command to execute the undeploy portlet action
dxclient xmlaccess [options]                    - command to execute the xmlaccess action
dxclient deploy-scriptapplication [options]     - command to execute the deploy script application action
dxclient undeploy-scriptapplication [options]   - command to execute the undeploy script application action
dxclient restore-scriptapplication [options]    - command to execute the restore script application action
dxclient deploy-theme [options]                 - command to execute the deploy theme action  
dxclient undeploy-theme [options]               - command to execute the undeploy theme action
dxclient deploy-application [options]           - command to execute the deploy application action
dxclient undeploy-application [options]         - command to execute the undeploy application action
dxclient manage-syndicator [options]            - command to execute the syndicator action
dxclient manage-subscriber [options]            - command to execute the subscriber action
dxclient restart-dx-core [options]              - command to execute the DX Core restart action
dxclient mls-export  [options]                  - command to export content of a WCM Library for translation
dxclient mls-import  [options]                  - command to import the translated contents into the DX
dxclient manage-syndicator get-syndication-report [options] - command to execute the syndication failed report
dxclient delete-dam-schema  [options]           - command to execute the delete dam schema action
dxclient list-dam-schemas  [options]            - command to execute the list of all dam schema action
dxclient pzn-export [options]                   - command to export the pzn rules from the target server
dxclient pzn-import [options]                   - command to import the pzn rules into the target server
dxclient resource-env-provider [options]        - command to create, update or delete a custom property from an existing Resource Environment  Provider
dxclient manage-virtual-portal [options]        - command to manage virtual portal tasks in the DX server
dxclient manage-dam-staging register-dam-subscriber [options] - command to execute the register subscriber action
dxclient manage-dam-staging trigger-staging [options] - command to execute the trigger staging action
dxclient manage-dam-staging deregister-dam-subscriber  [options] - command to execute the deregister subscriber action
dxclient manage-dam-staging get-all-subscribers [options] - command to execute the get subscribers details action
dxclient manage-dam-staging update-secrets [options] - command to execute the update secrets action
dxclient manage-dam-staging find-staging-mismatch [options] - command to execute the find mismatch action
dxclient manage-dam-staging get-staging-mismatch-report [options] - command to generate staging mismatch report
dxclient manage-dam-staging start-staging-resync [options] - command to execute the staging resync action
dxclient manage-dam-staging delete-staging-mismatch [options] - command to execute the delete staging mismatch action
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 Help commands

The following commands show the Help documents for DXClient command usage.

Use the following commands to display the Help document for DXClient:

dxclient

dxclient -h, --help

Use the following command to display the DXClient version number:

dxclient -V, --version

Use the following command to skip prompt of click-through license acceptance agreement:

dxclient accept-license

Use the following command to display the detailed help for a specific command:

dxclient help [command]

Use the following command to show version compatibility details between DX Core and DXClient:

dxclient version-compat [command] [options]

Command options

-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)

1. Deploy Portlet

Deploy-portlet command is used to deploy new or updated portlets to target DX Servers using the provided input xmlaccess file and path of the deployable war.

Commands Description

dxclient deploy-portlet
This command invokes the deploy-portlet tool inside the DXClient. The deploy-portlet dxtool uses the provided files and execute the deploy portlets task using the above available endpoints.

Help command This command shows the help document on the deploy-portlet command usage:

dxclient deploy-portlet -h

Required files Xml file: This xml file should contain the definition of the web application along with the details of the portlet(s) to be deployed. The web archive file path referred to in this file inside the URL element is ignored, but the URL element itself must exist as it is dynamically replaced when the command is executed. A sample XML file for deploying portlet(s) can be found in the samples directory of DXClient (samples/DeployPortlet.xml) or in DX server located in the following directory: PortalServer_root/doc/xml-samples/DeployPortlet.xml.

Portlet Application web archive file:This web archive .war file should contain the necessary portlet artifacts for deployment. Reference the Importing WAR files[https://help.hcltechsw.com/digital-experience/8.5/admin-system/adxmlref_import_war.html] for more details.

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-xmlConfigPath <value>
	Use this attribute to specify the path to DX configuration endpoint

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the 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)

-xmlFile <xml file name with absolute path of the xmlaccess input file>
	Use this attribute to specify the xml file that will be used while executing the deploy portlet task. For an example, see the DeployPortlet.xml file in the directory dxclient/samples/sample-xml-files/

-warFile <war file name with absolute path of the deployable war file> 
 	Use this attribute to specify the path of the war file to be deployed. For an example, see the WelcomePortlet.war file in the directory dxclient/samples/sample-xml-files/

**Note:** Mandatory parameters xmlFile and warFile should be passed into the command line.

Example Usage:

dxclient deploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -xmlFile <xml-file-with-path> -warFile <war-file-with-path>

2. Undeploy Portlet

Undeploy-portlet command is used to undeploy the deployed portlets in the target DX Servers.

Note: Undeploy-portlet will take the back up of deployed portlet application's xml file and application(EAR) if user has given enableBackup as true. By default enableBackup is set to true and placed in the <working-directory>/store/outputFiles/portlets/backup/undeploy-portlet/. In case if undeployed portlet is required, then the user can restore the portlet WAR file from the downloaded portlet application EAR file along with the exported deployable portlet application XML file.

Commands Description

dxclient undeploy-portlet
This command invokes the undeploy-portlet tool inside the DXClient. The undeploy-portlet dxtool uses the provided files and execute the undeploy portlet task.

Help command This command shows the help information for undeploy-portlet command usage:

dxclient undeploy-portlet -h

Required files

Xml file: This file should contain the definition of the web application along with the undeploy portlet details.

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-xmlConfigPath <value>
	Use this attribute to specify the path to DX configuration endpoint

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

-xmlFile <xml file name with absolute path of the xmlaccess input file>
	Use this attribute to specify the xml file that will be used while executing the deploy portlet task. For an example, see the UndeployPortlet.xml file in the directory `<working-directory>/samples/sample-xml-files/`

-enableBackup <value>
 Use this attribute to take the backup of portlet application before undeploying it

Commands required when enableBackup is set to true

-dxConnectPort <value>
	Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)

-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

-dxSoapPort <Soap port of the DX server> 
    Use this attribute to specify Soap port of the DX server

-dxProfileName <Profile name of the DX core server> 
    Use this attribute to specify the profile name of the DX core server

-dxProfilePath <Profile path of the DX core server> 
    Use this attribute to specify the profile path of the DX core server

Note: Mandatory parameter xmlFile should be passed into the command line.

Example Usage:

dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path>

Example Usage with dxProfileName and when enableBackup is set to true:

dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -enableBackup true -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX core server profile>

Example Usage with dxProfilePath and when enableBackup is set to true:

dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -enableBackup true -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfilePath <Profile path of the DX core server profile>

3. XML Access

The xmlaccess command is used to export or import pages or portlet configurations from a target HCL DX 9.5 CF 19 or higher server using a provided input XMLAccess file.

Command Description:

dxclient xmlaccess -xmlFile <path>

Help command This command shows the help information for xmlaccess command usage:

dxclient xmlaccess -h

Required files

Xml file: This XML file should contain the configuration update or export operation for the web application

Command options

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the DX server (wp_profile):

-hostname <value>
	Use this attribute to specify the hostname of the target DX server:

-dxPort <value>
	Use this attribute to specify the port on which to connect to the DX server (wp_profile),for Kubernetes Environment dxPort is 443:

-xmlConfigPath <value>
	Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config):

-dxUsername <value>
	Use this attribute to specify the username to authenticate with the DX server (wp_profile):

-dxPassword <value>
	Use this attribute to specify the password for the user in the "dxUsername" attribute:

-xmlFile <Absolute or relative path to xmlaccess input file>
	Use this attribute to specify the local path to the XMLAccess file. Sample Files for creating or deleting pages can be found under the directory `dxclient/samples/sample-xml-files/`:

Note: Mandatory parameter xmlFile should be passed into the command line.

Example usage:

dxclient xmlaccess -xmlFile <xml-file-with-path>

4. Deploy Script Application

Deploy Script Application dxtool is used to deploy the script based applications either from local or source environments to different target environments. This tool will push files that are associated with script-based applications to a Script Application instance in a Web Content Manager Site Library by running below commands.

Commands Description

dxclient deploy-scriptapplication

This command invokes the deploy-script-application tool inside the DXClient. This dxtool uses the provided files and executes the deploy script application task to the provided target DX server.

Help command This command shows the help document on the deploy-scriptapplication command:

dxclient deploy-scriptapplication pull -h

dxclient deploy-scriptapplication push -h

Command options

push [OPTIONS]          
	Create or update the content of a Script Application in the DX server
pull [OPTIONS]          
	Downloads the content of a Script Application present in the DX server

Required options - Pull command

-dxProtocol <value>
	Use this attribute to specify the protocol of the target server.
-hostname <value>
	Use this attribute to specify the hostname of the target server.
-dxPort <value>
	Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
-dxUsername <value> 
    The name of the dxUsername for authentication.
-dxPassword <value>
    The password of the dxUsername for authentication.
-wcmContentID <value>
    WCM content ID of the Script Application instance.
-virtualPortalContext <value>
	The context of the virtual portal that contains the Script Application instance that you want to create or update.
-projectContext <value>
	The context of the portal project that manages the publication of changes to the Script Application content.

Required options - Push command

-dxProtocol <value>
	Use this attribute to specify the protocol of the target server.
-hostname <value>
	Use this attribute to specify the hostname of the target server.
-dxPort <value>
	Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
-dxUsername <value> 
    The name of the dxUsername for authentication.
-dxPassword <value>
    The password of the dxUsername for authentication.
-wcmContentName <value>
    Name of the Script Application instance to be created or updated.
-wcmContentPath <value>
    Full WCM path of the Script Application instance to be created or updated.
	You cannot use this argument with -wcmSiteArea and -wcmContentName.
-wcmContentID <value>
    WCM content ID only if you are updating an existing Script Application instance on a portal page.
-wcmContentTitle <value>
    Sets or updates the title of the Script Application instance.
-wcmSiteArea <value>
	SiteArea of the Script Application content.
-contenthandlerPath <value>
	The path to the contenthandler servlet on the Script Application server.
-contentRoot <value>
    Absolute or relative path to the Script Application's content.
-virtualPortalContext <value>
	The context of the virtual portal that contains the Script Application instance that you want to create or update.
-projectContext <value>
	The context of the portal project that manages the publication of changes to the Script Application content.
-prebuiltZip <value>
    Path to an existing compressed file that provides the content to be pushed to the portal instead of the -contentRoot option. 
	Note: When -prebuiltZip is specified, the main HTML file path must be relative to the top-level directory in the compressed file.
-mainHtmlFile <value>
   	Path to the main HTML file of the Script Application. 

**Note:** Mandatory parameters contentRoot and prebuiltZip should be passed into the command line.

Example Usage:

Script Application Pull , execute

dxclient deploy-scriptapplication pull -wcmContentID <wcmContentID> 

The outputfile for pull will be generated inside store/outputFiles/sp-pull-output

If the options are configured in dist/configuration/config.json, then execute  

dxclient deploy-scriptapplication pull

dxclient deploy-scriptapplication push , execute

dxclient deploy-scriptapplication push  -contentRoot /temp -wcmSiteArea "Script Application Library/Script Applications/" -wcmContentName DemoScriptApplication

If the options are configured in dist/configuration/config.json, then execute  

dxclient deploy-scriptapplication push

5. Deploy Theme

Deploy-theme command is used to create and update the existing theme into target DX Servers using the provided theme registration xml file, deployable EAR file and WebDAV theme collection.

Commands Description

dxclient deploy-theme
This command invokes the deploy-theme tool inside the DXClient. This command uses the provided files and execute the deploy theme task.

Help command This command shows the help document on the deploy-theme command usage:

dxclient deploy-theme -h

Required files

Theme Registration XML file: This XML file is required to register the theme into DX Server and should contain the details of the theme. The xml file referred in this file should be made reachable while executing the deploy theme task.

Theme deployable EAR file: This EAR file containing theme data will be used for deploying it into  the WebSphere Application Server.

WebDAV theme collection: The theme collection folder/zip will be used to create or update the collection in WebDAV file store of the DX Server.

This command can execute below one or more tasks together:

Theme Registration
Theme EAR deployment
WebDAV theme collection

Common Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

Required options for Theme Registration:

-xmlFile <xml file name with absolute path of the xmlaccess input file>
	Use this attribute to specify the theme registration xml file that will be used while executing the deploy theme task. For an example, see the Theme-registration.xml file in the directory dxclient/samples/sample-xml-files/

-xmlConfigPath <value>
	Use this attribute to specify the path to DX configuration endpoint

Required options for Theme EAR deployment:

-dxConnectPort <value>
	Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)

-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

-dxSoapPort <Soap port of the DX server> 
    Use this attribute to specify Soap port of the DX server

-dxProfileName <Profile name of the DX core server> 
    Use this attribute to specify the profile name of the DX core server

-dxProfilePath <Profile Path of the DX core server> 
    Use this attribute to specify the profile path of the DX core server

–applicationFile <Absolute or relative path to deployable theme ear file> 
    Use this attribute to specify the theme ear file path that is required while executing the deploy theme task

-applicationName <value> 
    Use this attribute to specify the theme application name

Required options for creating/updating WebDAV theme collection:

-themeName <value>
 Use this attribute to specify the theme name of the collection created under WebDav server in DX
 
-themePath <value>
 Use this attribute to specify the theme file path that contains all static files to be pushed into DX theme

-contenthandlerPath <value>
 Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):

Optional arguments: 

 -requestId <Unique Id of a previously triggered deploy theme request>
 	Use this attribute and retrigger the command to check the status of any previous request that was incomplete.

**Note:** Mandatory parameters applicationFile, applicationName, themeName, themePath and xmlFile should be passed into the command line.

Example Usage with dxProfileName:

dxclient deploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationFile <application-file-with-path> -applicationName <application name> -themeName <theme-name> -themePath <theme-path> -dxProfileName <Profile name of the DX core server>

Example Usage with dxProfilePath:

dxclient deploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationFile <application-file-with-path> -applicationName <application name> -themeName <theme-name> -themePath <theme-path> -dxProfilePath <Profile path of the DX core server>

6. Undeploy Theme

undeploy-theme command is used to undeploy EAR application and undeploy WebDAV and unregister the registered theme from target DX server.

Note: If user sets the enableBackup as true then undeploy-theme will take the back up of deployed EAR theme,WebDAV theme collection and complete DX configuration export(not including users) and placed it in the backup folder. When the user is downloading EAR, WeDAV and XML to backup we seprate it by store/outputFiles/themes/backup/foldername.

example for backup of EAR, it is placed in store/outputFiles/themes/backup/application.

In case if undeployed theme is required,then user can restore the theme back using the back up files.

Commands Description

dxclient undeploy-theme
This command invokes the undeploy-theme tool inside the DXClient. This command uses the provided files and execute the undeploy theme task.

Required files

Theme Unregistration XML file: This XML file is required to unregister the theme into DX Server and should contain the details of the theme. The xml file referred in this file should be made reachable while executing the undeploy theme task.

This command can execute below one or more tasks together:

Theme Unregistration
Theme EAR undeploy
WebDAV theme collection undeploy

Common Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

-contenthandlerPath <value>
 Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):

-enableBackup <value>
 Use this attribute to take the backup before undeploying theme

**Note** : User can sets the sets the enableBackup as true to take backup before undeploying, enableBackup is set to false by default.

Required options for Theme Unregistration:

-xmlFile <xml file name with absolute path of the xmlaccess input file>
	Use this attribute to specify the theme registration xml file that will be used while executing the undeploy theme task. For an example, see the Theme-registration.xml file in the directory dxclient/samples/

-xmlConfigPath <value>
	Use this attribute to specify the path to DX configuration endpoint

Required options for Theme EAR and WebDAV undeployment:

-dxConnectPort <value>
	Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)

-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

-dxSoapPort <Soap port of the DX server> 
    Use this attribute to specify Soap port of the DX server

-dxProfileName <Profile name of the DX core server profile> 
    Use this attribute to specify the profile name of the DX core server

-dxProfilePath <Profile path of the DX core server profile> 
    Use this attribute to specify the profile path of the DX core server

-applicationName <value> 
    Use this attribute to specify the EAR application name

-themeName <value>
 Use this attribute to specify the theme name of the collection created under WebDAV
 
**Note:** Mandatory parameters applicationName, themeName and xmlFile should be passed into the command line.

Example Usage with dxProfileName:

dxclient undeploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationName <application name> -themeName <theme-name> -enableBackup <enable-backup> -dxProfileName <Profile name of the DX core server profile>

Example Usage with dxProfilePath:

dxclient undeploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -xmlFile <xml-file-with-path> -applicationName <application name> -themeName <theme-name> -enableBackup <enable-backup> -dxProfilePath <Profile path of the DX core server profile>

7. Undeploy Script Application

Undeploy Script Application command is used to un-deploy an existing or delete the newly deployed script application from the target DX Server.

Note: Undeploy script application will take the back up of an already deployed script application, if user has set "enableBackup" as true in the configuration file and deletes it. The backup files are placed under the store/outputFiles/scriptApplications/backup/{wcmContentId} by default.

Commands Description

dxclient undeploy-scriptapplication
This command invokes the undeploy-scriptapplication tool inside the DXClient. The undeploy-scriptapplication dxtool uses the provided files and execute the undeploy scriptapplication task.

Help command This command shows the help information for undeploy-scriptapplication command usage:

dxclient undeploy-scriptapplication -h

Required command options

-hostname <value>
	Use this attribute to specify the hostname of the target server.

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server.

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443).

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server.

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server.

-wcmContentID <value>
    WCM content ID only if you are updating an existing Script Application instance on a portal page.

-contenthandlerPath <value>
	The path to the contenthandler servlet on the Script Application server.

-virtualPortalContext <value>
	The context of the virtual portal that contains the Script Application instance that you want to create or update.

-projectContext <value>
	The context of the portal project that manages the publication of changes to the Script Application content.

-f
 The -f flag is to delete the Script Application forcefully overstepping the prompt.

Example Usage:

dxclient undeploy-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -f

8.Restore Script Application

Restore Script Application command is used to restore the script application into one of its previous versions already present in the target DX Server.

Commands Description

dxclient restore-scriptapplication
This command invokes the restore-scriptapplication tool inside the DXClient. The restore-scriptapplication dxtool uses the provided files and execute the restore scriptapplication task.

Help command This command shows the help information for restore-scriptapplication command usage:

dxclient restore-scriptapplication -h

Required command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

-wcmContentID <value>
    WCM content ID only if you are updating an existing Script Application instance on a portal page.

-contenthandlerPath <value>
	The path to the contenthandler servlet on the Script Application server.

-virtualPortalContext <value>
	The context of the virtual portal that contains the Script Application instance that you want to create or update.

-projectContext <value>
	The context of the portal project that manages the publication of changes to the Script Application content.

-versionName <value>
	Use this attribute to specify the versionname that is restore version of Script Application.
	Note: When -versionName is not specified, the script application will rollback to the previous version default.
-restoreAsPublished <value>
	Use this attribute to specify the restore as a draft or replace the published version of Script Application.

Example Usage:

dxclient restore-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -versionName <versionName> -restoreAsPublished <restoreAsPublished>

9. Export Content of a WCM Library

The export command is used to export the content of a wcm library for translation into a .csv file at the location specified by the user.

Commands Description

dxclient mls-export
The export command would create a new .csv file with an auto-generated file name in a file path specified by the user every-time the export command is run.

Required command options

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the DX server

-hostname <value>
	Use this attribute to specify the hostname of the DX server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the DX server

-contenthandlerPath <value>
	Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

-wcmLibraryId <value>
    WCM library ID(s) within quotation("") to export the contents of the library. For multiple WCM library ids, enter separated by comma.

-wcmLibraryName <value>
    Provide the WCM library name(s) within quotation("") to export the contents of the library. For multiple WCM library name, enter separated by comma. 

-lastModifiedAfter <value>
    Last modified after will give the contents of WCM library id and name from specified date and time in GMT format.

-wcmProjectName <value>
    Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.

-exportPath <value>
		The path to the exports the wcm contents of a library.

-virtualPortalContext <value>
		The context of the virtual portal from which mls library should be exported.

**Note:** Mandatory parameter exportPath should be passed into the command line.

Example Usage:

To Export contents from Library :
dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> 
-contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmLibraryId <wcmLibraryId> -wcmLibraryName <wcmLibraryName> -lastModifiedAfter <lastModifiedAfter> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>

To Export contents from Project :
dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> 
-contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmProjectName <wcmProjectName> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>

10. Import Translated Contents into DX

The import command is used to import the translated contents into DX at the location specified by the user.

Commands Description

dxclient mls-import
The import command imports the translated contents into DX and It would overwrite any translations which are already present in the content of the environment.

Required command options

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the DX server

-hostname <value>
	Use this attribute to specify the hostname of the DX server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the DX server 

-contenthandlerPath <value>
	Use this attribute to specify the context root on which to connect to the DX server

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

-importPath <value>
	The path(s) (separated by comma) to import the translated contents into DX.

-wcmProjectName <value>
	Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.

-forceImport <value>
	Optional attribute: Flag to forcefully import the content. This allows the import process to proceed even if the content is modified in the DX since the last export. (e.g. true or false)

-virtualPortalContext <value>
	The context of the virtual portal to which mls library should be imported.

**Note:** Mandatory parameter importPath should be passed into the command line.

Example Usage:

dxclient mls-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> 
-contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -importPath <importPath> -wcmProjectName <wcmProjectName> -virtualPortalContext <virtualPortalContext>

11. Deploy Application

Deploy-application command is used to deploy EAR file into the WebSphere Application Server.

Commands Description

dxclient deploy-application
This command invokes the deploy-application tool inside the DXClient. This command uses the provided files and execute the deploy application task.

Help command This command shows the help information for deploy-application command usage:

dxclient deploy-application -h

Required files

Deployable EAR file: This EAR file will be used for deploying it into  the WebSphere Application Server.

Common Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server

-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server

-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)

-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server

-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server

Required options for application deployment:

-dxConnectPort <value>
	Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)

-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

-dxSoapPort <Soap port of the DX server> 
    Use this attribute to specify Soap port of the DX server

-dxProfileName <Profile name of the DX core server> 
    Use this attribute to specify the profile name of the DX core server

-dxProfilePath <Profile path of the DX core server> 
    Use this attribute to specify the profile path of the DX core server

–applicationFile <Absolute or relative path to deployable ear file> 
    Use this attribute to specify the ear file path that is required while executing the deploy application task

-applicationName <value> 
    Use this attribute to specify the application name

Optional arguments:

-requestId <Unique Id of a previously triggered deploy application request>
 	Use this attribute and retrigger the command to check the status of any previous request that was incomplete.

**Note:** Mandatory parameters applicationFile and applicationName should be passed into the command line.

Example Usage with dxProfileName:

dxclient deploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationFile <application-file-with-path> -applicationName <application name> -dxProfileName <Profile name of the DX core server>

Example Usage with dxProfilePath:

dxclient deploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationFile <application-file-with-path> -applicationName <application name> -dxProfilePath <Profile path of the DX core server>

12. Restart DX Core

restart-dx-core command is used to restart the DX Core server. Note: It is not recommended to run this command in Kubernetes based deployments. To restart all the pods, use the Kubernetes interfaces like kubectl.

Commands Description

dxclient restart-dx-core
This command invokes the restart-dx-core tool inside the DXClient and executes the DX Core restart action.

Help command This command shows the help information for restart-dx-core command usage:

dxclient restart-dx-core -h

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server
-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the DX Core
-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the DX Core
-dxConnectPort <value>
	Use this attribute to specify the port number of the cw_profile
-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
-dxProfileName <Profile name of the DX core server> 
    Use this attribute to specify the profile name of the DX Core server
-dxProfilePath <Profile path of the DX core server> 
    Use this attribute to specify the profile path of the DX Core server

Optional arguments:
-requestId <Unique Id of a previously triggered restart request>
	Use this attribute and retrigger the command to check the status of any previous request that was incomplete.

Example Usage with dxProfileName:

dxclient restart-dx-core -hostname <host-name> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX core server>

Example Usage with dxProfilePath:

dxclient restart-dx-core -hostname <host-name> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfilePath <Profile path of the DX core server>

13. Manage Syndicator

manage-syndicator command is used to enable/disable syndicator in the target server.

Commands Description

dxclient manage-syndicator
This command invokes the manage-syndicator tool inside the DXClient. The manage-syndicator dxtool is used to enable/disable syndicator.

Help command This command shows the help information for manage-syndicator command usage:

dxclient manage-syndicator -h

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server
-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server
-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server
-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server
-contenthandlerPath <value>
 Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
-UUID <value>
	Use this attribute to specify the UUID of the syndicator instance
-enable <value>
	Use this attribute to specify the enable/disable the syndicator instance. This value can be true or false. If true then enable the syndicator otherwise it will disable the syndicator

Example Usage:

dxclient manage-syndicator -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>

14. Manage Subscriber

manage-subscriber command is used to enable/disable subscriber in the target server.

Commands Description

dxclient manage-subscriber
This command invokes the manage-subscriber tool inside the DXClient. The manage-subscriber dxtool is used to enable/disable subscriber.

Help command This command shows the help information for manage-subscriber command usage:

dxclient manage-subscriber -h

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server
-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server
-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server
-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server
-contenthandlerPath <value>
 Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
-UUID <value>
	Use this attribute to specify the UUID of the subscriber instance
-enable <value>
	Use this attribute to specify the enable/disable the subscriber instance. This value can be true or false. If true then enable the subscriber otherwise it will disable the subscriber

Example Usage:

dxclient manage-subscriber -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>

15. Manage-syndicator get-syndication-report

Manage-syndicator get-syndication-report command is used to fetch the syndicator failed reports.

Commands Description

dxclient manage-syndicator get-syndication-report
This command invokes the report generation of items that failed to syndicate in DX through DXClient. If the user provides syndicator UUID it will fetch the report of items that failed to syndicate with respect to the UUID, otherwise, it will display items that failed to syndicate for all syndicators present in the DX environment provided. The report is available in HTML format.

Help command This command shows the help information for manage-syndicator get-syndication-report command usage:

dxclient  manage-syndicator get-syndication-report -h

Command options

-hostname <value>
	Use this attribute to specify the hostname of the target server
-dxProtocol <value>
	Use this attribute to specify the protocol with which to connect to the server
-dxPort <value>
	Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
-dxUsername <value> 
	Use this attribute to specify the username that is required for authenticating with the server
-dxPassword <value>
	Use this attribute to specify the password that is required for authenticating with the server
-contenthandlerPath <value>
    Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
-UUID <value>
	Use this attribute to specify the UUID of the syndicator instance

Example Usage with UUID:

dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID>

Example Usage without UUID:

dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtoc

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

DXClient

Requirements

Install DXClient with package from HCL Software Portal

Notes:

DXClient uninstall

Install/Uninstall DXClient from NpmJS registry

Additional Information

Verify the DXClient installation

DXClient Release Timelines & Updates

DXClient configuration

DXClient Commands

DXClient Help commands

1. Deploy Portlet

2. Undeploy Portlet

3. XML Access

4. Deploy Script Application

5. Deploy Theme

6. Undeploy Theme

7. Undeploy Script Application

8.Restore Script Application

9. Export Content of a WCM Library

10. Import Translated Contents into DX

11. Deploy Application

12. Restart DX Core

13. Manage Syndicator

14. Manage Subscriber

15. Manage-syndicator get-syndication-report