Digital Experience applications

This section provides information about the deployment & undeployment of DX application artifacts by using the DXClient tool.

Deploy Application

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

Command description

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

The following EAR file will be deployed into the WebSphere Application Server: Deployable EAR
Help command

This command shows the help information for deploy-application command usage:
```
dxclient deploy-application -h
```
Command options

Use this attribute to specify the hostname of the target server:
```
-hostname <value>
```
Use this attribute to specify the protocol with which to connect to the server:
```
-dxProtocol <value>
```
Use this attribute to specify the port on which to connect to the server (for Kubernetes Environment dxPort is 443):
```
-dxPort <value>
```
Use this attribute to specify the username that is required for authenticating with the server:
```
-dxUsername <value> 
```
Use this attribute to specify the password that is required for authenticating with the server:
```
-dxPassword <value>
```
Use this attribute and retrigger the command to check the status of any previous request that was incomplete:
```
-requestId <Unique ID of a previously triggered deploy application request>
```
Required options for application deployment

Use this attribute to specify the hostname of the target DX server:
```
-hostname <value>
```
Use this attribute to specify the port number of the cw_profile (e.g. for Kubernetes Environment, dxConnectPort is 443):
```
-dxConnectPort <value>
```
Use this attribute to specify the username that is required for authenticating to the cw_profile:
```
-dxConnectUsername <value>
```
Use this attribute to specify the password that is required for authenticating to the cw_profile:
```
-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 EAR file path that is required while executing the deploy application task:
```
–applicationFile <Absolute or relative path to deployable ear file>
```
Use this attribute to specify the application name:
```
-applicationName <value>
```
Use this attribute and retrigger the command to check the status of any previous request that was incomplete:
```
-requestId <Unique ID of a previously triggered request>
```
The values passed through the command line command override the default values:

Example

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

Undeploy Application

The undeploy-application command is used to undeploy the EAR file from the WebSphere Application Server.

Command description

This command undeploys the application from WAS. Users can opt to store backup by setting the 'enable-backup' parameter to true.
```
dxclient undeploy-application
```
Help command

This command shows the help information for undeploy-application command usage:
```
dxclient undeploy-application -h
```
Command options

Use this attribute to specify the hostname of the target server:
```
-hostname <value>
```
Use this attribute to specify the protocol with which to connect to the server:
```
-dxProtocol <value>
```
Use this attribute to specify the port on which to connect to the server (for Kubernetes Environment dxPort is 443):
```
-dxPort <value>
```
Use this attribute to specify the username that is required for authenticating with the server:
```
-dxUsername <value> 
```
Use this attribute to specify the password that is required for authenticating with the server:
```
-dxPassword <value>
```
Use this attribute to specify the hostname of the target DX server:
```
-hostname <value>
```
Use this attribute to specify the port number of the cw_profile (e.g. for Kubernetes Environment, dxConnectPort is 443):
```
-dxConnectPort <value>
```
Use this attribute to specify the username that is required for authenticating to the cw_profile:
```
-dxConnectUsername <value>
```
Use this attribute to specify the password that is required for authenticating to the cw_profile:
```
-dxConnectPassword <value>
```
Use this attribute to specify the Soap port of the DX server:
```
-dxSoapPort <Soap port of the DX 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>
```
Use this attribute to specify the application name:
```
-applicationName <value>
```
Use this attribute to set the flag to enable taking a backup of the application to be undeployed. the default is false.
```
-enable-backup <value>
```
The values passed through the command line command override the default values:

Example

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

HCLSoftware U learning materials

For an introduction and a demo on using DX for developers, go to DX for Developers (Advanced). To try it out yourself, refer to DX Setup Local Java Development Environment Lab.