Themes | HCL Digital Experience

Deploy theme

The deploy-theme command is used to deploy a theme (EAR and WebDAV based) from a source client or server environment to a target HCL DX 9.5 CF192 or later server using the provided theme registration XML file, deployable EAR file, and WebDAV theme collection.

Required files

Theme Registration XML file: This XML file is required to register the theme into DX Server.

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

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

Notes: This command can execute below one or more tasks together:

1. Theme Registration
2. Theme EAR deployment
3. WebDAV theme collection

Command

dxclient deploy-theme -xmlFile <path> -applicationFile <path> -applicationName <application name> 
-themeName <theme collection name> -themePath <folder/zip path of theme collection>

Help command

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

dxclient deploy-theme -h

Common Command options

Use this attribute to specify the protocol with which to connect to the DX server (wp_profile):

-dxProtocol <value>

Use this attribute to specify the hostname of the target DX server:

-hostname <value>

Use this attribute to specify the port on which to connect to the DX server (wp_profile):

-dxPort <value>

Use this attribute to specify the username to authenticate with the DX server (wp_profile):

-dxUsername <value>

Use this attribute to specify the password for the user in the dxUsername attribute:

-dxPassword <value>

Use this attribute and re-trigger the command to check the status of any previous request that was incomplete.

-requestId <Unique ID of a previously triggered deploy theme request>

Required options for Theme Registration

Use this attribute to specify the local path to the theme registration XML file:

-xmlFile <Absolute or relative path to theme registration xml input file>

Use this attribute to specify the path to DX configuration endpoint (for example, /wps/config):

-xmlConfigPath <value>

Note: For theme registration, a backup of the complete DX configuration export (not including users) is taken and placed in store/outputFiles/themes/backup/foldername folder.

Required options for Theme EAR deployment

Use this attribute to specify the Configuration Wizard Console port number:

-dxConnectPort <value>

Use this attribute to specify the hostname of the target DX server:

-hostname <value>

Use this attribute to specify the Configuration Wizard Administrator username that is required for authenticating with the DXConnect application:

-dxConnectUsername <value>

Use this attribute to specify the Configuration Wizard Administrator password that is required for authenticating with the DXConnect application:

-dxConnectPassword <value>

Use this attribute to specify Soap port of the DX server:

-dxSoapPort <Soap port of the DX server> 

Specify either the dxProfileName or dxProfilePath of the DX core server:

• Use this attribute to specify the profile name of the DX core server (for example: wp_profile):

  -dxProfileName <Profile name of the DX core server>

OR

• Use this attribute to specify the profile path of the DX server (for example: /opt/HCL/wp_profile):

  -dxProfilePath <Path of the DX core server profile> 

Use this attribute to specify the theme EAR file path that is required while executing the deploy theme task:

–applicationFile <Absolute or relative path to deployable theme ear file> 

Use this attribute to specify the theme application name:

-applicationName <value> 

Required options for creating/updating WebDAV theme collection

Use this attribute to specify the theme name of the collection created under WebDAV server in DX:

-themeName <value>

Use this attribute to specify the theme file path that contains all static files to be pushed into DX theme, it accepts either folder or zip file path of the WebDAV theme collection:

-themePath <value>

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

-contenthandlerPath <value>

Notes:

• For new WebDAV theme collection, DXClient tool adds the provided collection (folder/zip) to the WebDAV file store.
• For existing WebDAV theme collection, the existing theme collection is replaced by the provided theme collection during the update. To get the latest theme collection from the DX server, see Exporting content from the filestore and make modifications on the same folder to get it updated in the DX Server WebDAV file store.
• For WebDAV theme collection update, a backup of the existing theme collection is taken and placed in store/outputFiles/themes/backup/foldername folder.

Log files from command execution can be found in the logs directory of the DXClient installation.

Example:

dxclient deploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -hostname <hostname> -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> 

Undeploy theme

The backup of EAR is placed in store/outputFiles/themes/backup/application.

dxclient undeploy-theme -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -hostname <hostname> -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>