@hcl-software/dxclient 225.0.0 → 227.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (156) hide show
  1. package/README.md +211 -3215
  2. package/dist/configuration/versionConfigMap.json +3 -0
  3. package/dist/package.json +4 -4
  4. package/dist/packages/admintasks/src/commands/createCredentialVault.js +0 -1
  5. package/dist/packages/admintasks/src/commands/createCredentialVault.js.map +1 -1
  6. package/dist/packages/admintasks/src/commands/createSyndicationRelation.js +0 -1
  7. package/dist/packages/admintasks/src/commands/createSyndicationRelation.js.map +1 -1
  8. package/dist/packages/admintasks/src/commands/createVirtualPortal.js +0 -1
  9. package/dist/packages/admintasks/src/commands/createVirtualPortal.js.map +1 -1
  10. package/dist/packages/admintasks/src/commands/differentialReport.js +0 -1
  11. package/dist/packages/admintasks/src/commands/differentialReport.js.map +1 -1
  12. package/dist/packages/admintasks/src/commands/exportVirtualPortal.js +0 -1
  13. package/dist/packages/admintasks/src/commands/exportVirtualPortal.js.map +1 -1
  14. package/dist/packages/admintasks/src/commands/exportWCMLibrary.js +1 -2
  15. package/dist/packages/admintasks/src/commands/exportWCMLibrary.js.map +1 -1
  16. package/dist/packages/admintasks/src/commands/importVirtualPortal.js +0 -1
  17. package/dist/packages/admintasks/src/commands/importVirtualPortal.js.map +1 -1
  18. package/dist/packages/admintasks/src/commands/importWCMLibrary.js +0 -1
  19. package/dist/packages/admintasks/src/commands/importWCMLibrary.js.map +1 -1
  20. package/dist/packages/admintasks/src/commands/listVirtualPortals.js +0 -1
  21. package/dist/packages/admintasks/src/commands/listVirtualPortals.js.map +1 -1
  22. package/dist/packages/admintasks/src/commands/pznRulesExport.js +0 -1
  23. package/dist/packages/admintasks/src/commands/pznRulesExport.js.map +1 -1
  24. package/dist/packages/admintasks/src/commands/pznRulesImport.js +0 -1
  25. package/dist/packages/admintasks/src/commands/pznRulesImport.js.map +1 -1
  26. package/dist/packages/admintasks/src/commands/resEnvProviderActions.js +0 -1
  27. package/dist/packages/admintasks/src/commands/resEnvProviderActions.js.map +1 -1
  28. package/dist/packages/admintasks/src/commands/restartCorePods.js +0 -1
  29. package/dist/packages/admintasks/src/commands/restartCorePods.js.map +1 -1
  30. package/dist/packages/admintasks/src/commands/restartDXCore.js +0 -1
  31. package/dist/packages/admintasks/src/commands/restartDXCore.js.map +1 -1
  32. package/dist/packages/dam/src/commands/createSecrets.js +0 -1
  33. package/dist/packages/dam/src/commands/createSecrets.js.map +1 -1
  34. package/dist/packages/dam/src/commands/deleteDAMStagingMismatch.js +0 -1
  35. package/dist/packages/dam/src/commands/deleteDAMStagingMismatch.js.map +1 -1
  36. package/dist/packages/dam/src/commands/deleteSchema.js +0 -1
  37. package/dist/packages/dam/src/commands/deleteSchema.js.map +1 -1
  38. package/dist/packages/dam/src/commands/exportAssets.js +0 -1
  39. package/dist/packages/dam/src/commands/exportAssets.js.map +1 -1
  40. package/dist/packages/dam/src/commands/findDAMStagingMismatch.js +0 -1
  41. package/dist/packages/dam/src/commands/findDAMStagingMismatch.js.map +1 -1
  42. package/dist/packages/dam/src/commands/importAssets.js +0 -1
  43. package/dist/packages/dam/src/commands/importAssets.js.map +1 -1
  44. package/dist/packages/dam/src/commands/listSchema.js +0 -1
  45. package/dist/packages/dam/src/commands/listSchema.js.map +1 -1
  46. package/dist/packages/dam/src/commands/stagingMismatchReport.js +0 -1
  47. package/dist/packages/dam/src/commands/stagingMismatchReport.js.map +1 -1
  48. package/dist/packages/dam/src/commands/stagingResync.js +0 -1
  49. package/dist/packages/dam/src/commands/stagingResync.js.map +1 -1
  50. package/dist/packages/dam/src/commands/subscriberDeRegistration.js +0 -1
  51. package/dist/packages/dam/src/commands/subscriberDeRegistration.js.map +1 -1
  52. package/dist/packages/dam/src/commands/subscriberDetails.js +0 -1
  53. package/dist/packages/dam/src/commands/subscriberDetails.js.map +1 -1
  54. package/dist/packages/dam/src/commands/subscriberRegistration.js +0 -1
  55. package/dist/packages/dam/src/commands/subscriberRegistration.js.map +1 -1
  56. package/dist/packages/dam/src/commands/triggerDAMStaging.js +0 -1
  57. package/dist/packages/dam/src/commands/triggerDAMStaging.js.map +1 -1
  58. package/dist/packages/dam/src/commands/triggerDamReindexing.js +0 -1
  59. package/dist/packages/dam/src/commands/triggerDamReindexing.js.map +1 -1
  60. package/dist/packages/dam/src/commands/updateSecrets.js +0 -1
  61. package/dist/packages/dam/src/commands/updateSecrets.js.map +1 -1
  62. package/dist/packages/dam/src/import/renditions.js +3 -0
  63. package/dist/packages/dam/src/import/renditions.js.map +1 -1
  64. package/dist/packages/deployportlet/src/commands/deployPortlet.js +0 -1
  65. package/dist/packages/deployportlet/src/commands/deployPortlet.js.map +1 -1
  66. package/dist/packages/deployportlet/src/commands/undeployPortlet.js +0 -1
  67. package/dist/packages/deployportlet/src/commands/undeployPortlet.js.map +1 -1
  68. package/dist/packages/deployportlet/src/commands/xmlaccess.js +0 -1
  69. package/dist/packages/deployportlet/src/commands/xmlaccess.js.map +1 -1
  70. package/dist/packages/deployscriptapplication/src/commands/list.js +78 -75
  71. package/dist/packages/deployscriptapplication/src/commands/pull.js +0 -1
  72. package/dist/packages/deployscriptapplication/src/commands/pull.js.map +1 -1
  73. package/dist/packages/deployscriptapplication/src/commands/push.js +0 -1
  74. package/dist/packages/deployscriptapplication/src/commands/push.js.map +1 -1
  75. package/dist/packages/deployscriptapplication/src/commands/restoreScriptApplication.js +0 -1
  76. package/dist/packages/deployscriptapplication/src/commands/restoreScriptApplication.js.map +1 -1
  77. package/dist/packages/deployscriptapplication/src/commands/undeployScriptApplication.js +0 -1
  78. package/dist/packages/deployscriptapplication/src/commands/undeployScriptApplication.js.map +1 -1
  79. package/dist/packages/deploytheme/src/commands/deployApplication.js +0 -1
  80. package/dist/packages/deploytheme/src/commands/deployApplication.js.map +1 -1
  81. package/dist/packages/deploytheme/src/commands/deployTheme.js +0 -2
  82. package/dist/packages/deploytheme/src/commands/deployTheme.js.map +1 -1
  83. package/dist/packages/deploytheme/src/commands/undeployApplication.js +0 -1
  84. package/dist/packages/deploytheme/src/commands/undeployApplication.js.map +1 -1
  85. package/dist/packages/deploytheme/src/commands/undeployTheme.js +0 -2
  86. package/dist/packages/deploytheme/src/commands/undeployTheme.js.map +1 -1
  87. package/dist/packages/livesync/src/commands/pullTheme.js +0 -1
  88. package/dist/packages/livesync/src/commands/pullTheme.js.map +1 -1
  89. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.d.ts +2 -2
  90. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.js +35 -14
  91. package/dist/packages/livesync/src/commands/pullWcmDesignLibrary.js.map +1 -1
  92. package/dist/packages/livesync/src/commands/pushTheme.js +0 -1
  93. package/dist/packages/livesync/src/commands/pushTheme.js.map +1 -1
  94. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.d.ts +4 -1
  95. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.js +206 -76
  96. package/dist/packages/livesync/src/commands/pushWcmDesignLibrary.js.map +1 -1
  97. package/dist/packages/livesync/src/errors/CommandLineMessages_en.json +57 -28
  98. package/dist/packages/livesync/src/messages/messages_en.json +12 -8
  99. package/dist/packages/livesync/src/services/livesyncUtils.d.ts +3 -2
  100. package/dist/packages/livesync/src/services/livesyncUtils.js +19 -4
  101. package/dist/packages/livesync/src/services/livesyncUtils.js.map +1 -1
  102. package/dist/packages/livesync/src/services/metadataServices.d.ts +26 -5
  103. package/dist/packages/livesync/src/services/metadataServices.js +56 -12
  104. package/dist/packages/livesync/src/services/metadataServices.js.map +1 -1
  105. package/dist/packages/livesync/src/services/ongoingSyncServices.d.ts +3 -0
  106. package/dist/packages/livesync/src/services/ongoingSyncServices.js +170 -71
  107. package/dist/packages/livesync/src/services/ongoingSyncServices.js.map +1 -1
  108. package/dist/packages/livesync/src/services/styleSheetComponentWcmServices.d.ts +5 -0
  109. package/dist/packages/livesync/src/services/styleSheetComponentWcmServices.js +138 -0
  110. package/dist/packages/livesync/src/services/styleSheetComponentWcmServices.js.map +1 -0
  111. package/dist/packages/livesync/src/services/wcmContext/initialSync.d.ts +6 -0
  112. package/dist/packages/livesync/src/services/wcmContext/initialSync.js +39 -0
  113. package/dist/packages/livesync/src/services/wcmContext/initialSync.js.map +1 -0
  114. package/dist/packages/livesync/src/services/wcmContext/stylesheetComponent.d.ts +8 -0
  115. package/dist/packages/livesync/src/services/wcmContext/stylesheetComponent.js +268 -0
  116. package/dist/packages/livesync/src/services/wcmContext/stylesheetComponent.js.map +1 -0
  117. package/dist/packages/livesync/src/services/wcmContext/wcmLibraryContext.d.ts +17 -0
  118. package/dist/packages/livesync/src/services/wcmContext/wcmLibraryContext.js +20 -0
  119. package/dist/packages/livesync/src/services/wcmContext/wcmLibraryContext.js.map +1 -0
  120. package/dist/packages/livesync/src/services/wcmRestV2Services.js +1 -0
  121. package/dist/packages/livesync/src/services/wcmRestV2Services.js.map +1 -1
  122. package/dist/packages/livesync/src/types/EventQueueItem.type.d.ts +3 -2
  123. package/dist/packages/livesync/src/types/WCMDesignLibraryCache.type.d.ts +6 -3
  124. package/dist/packages/livesync/src/types/WcmRestApiV2.type.d.ts +23 -1
  125. package/dist/packages/mls_exim/src/export/mlsExport.js +14 -8
  126. package/dist/packages/mls_exim/src/export/mlsExport.js.map +1 -1
  127. package/dist/packages/mls_exim/src/export/mlsExport.ts +17 -10
  128. package/dist/packages/mls_exim/src/import/mlsImport.js +3 -3
  129. package/dist/packages/mls_exim/src/import/mlsImport.js.map +1 -1
  130. package/dist/packages/mls_exim/src/import/mlsImport.ts +5 -5
  131. package/dist/packages/sharedlibrary/src/commands/delete.js +0 -1
  132. package/dist/packages/sharedlibrary/src/commands/delete.js.map +1 -1
  133. package/dist/packages/sharedlibrary/src/commands/upload.js +0 -1
  134. package/dist/packages/sharedlibrary/src/commands/upload.js.map +1 -1
  135. package/dist/packages/sharedlibrary/src/services/sharedLibraryServices.js +6 -0
  136. package/dist/packages/sharedlibrary/src/services/sharedLibraryServices.js.map +1 -1
  137. package/dist/packages/syndication/src/commands/subscriber.js +0 -1
  138. package/dist/packages/syndication/src/commands/subscriber.js.map +1 -1
  139. package/dist/packages/syndication/src/commands/syndicator.js +0 -1
  140. package/dist/packages/syndication/src/commands/syndicator.js.map +1 -1
  141. package/dist/packages/syndication/src/commands/syndicatorFailedItem.js +0 -1
  142. package/dist/packages/syndication/src/commands/syndicatorFailedItem.js.map +1 -1
  143. package/dist/src/errors/CommandLineMessages_en.json +2 -1
  144. package/dist/src/index.js +2 -1
  145. package/dist/src/index.js.map +1 -1
  146. package/dist/src/services/apiServices.js +6 -0
  147. package/dist/src/services/apiServices.js.map +1 -1
  148. package/dist/src/services/requestService.js +6 -0
  149. package/dist/src/services/requestService.js.map +1 -1
  150. package/dist/src/utils/constants.d.ts +7 -3
  151. package/dist/src/utils/constants.js +11 -2
  152. package/dist/src/utils/constants.js.map +1 -1
  153. package/dist/src/utils/utils.d.ts +1 -0
  154. package/dist/src/utils/utils.js +10 -1
  155. package/dist/src/utils/utils.js.map +1 -1
  156. package/package.json +4 -4
package/README.md CHANGED
@@ -6,342 +6,86 @@ DXClient can take artifacts developed locally and deploy them to HCL DX servers
6
6
 
7
7
  DXClient is meant to be the one-stop, platform-independent solution that lets you integrate HCL DX with any automation infrastructure of your choice.
8
8
 
9
- DXClient comes with two deployment options:
10
-
11
- 1. 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.
12
-
13
- **Warning** - Recent changes to Podman introduced by RedHat have caused a compatibility issue with the container implementation of DXClient. HCL is currently investigating how this might be resolved. Until further notice, Docker is recommended for using the DXClient container implementation.
14
-
15
- 2. 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.
16
-
17
- **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 <CFNumber>.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.
9
+ ## Table of Contents
10
+ - [DXClient](#dxclient)
11
+ - [Deployment Options](#deployment-options)
12
+ - [Native JavaScript Code Installation Options](#native-javascript-code-installation-options)
13
+ - [Verify the DXClient Installation](#verify-the-dxclient-installation)
14
+ - [DXClient Configuration](#dxclient-configuration)
15
+ - [Configuring TLS Certificate Validation for Secure Connections](#configuring-tls-certificate-validation-for-secure-connections)
16
+ - [DXClient Help Commands](#dxclient-help-commands)
17
+ - [All Available Commands](#all-available-commands)
18
+ - [Command Options](#command-options)
19
+ - [Logger Enablement](#logger-enablement)
20
+ - [Enable Logger](#enable-logger)
21
+ - [Disable Logger](#disable-logger)
22
+ - [DXClient Release Timelines & Updates](#dxclient-release-timelines--updates)
23
+ - [DXClient Documentation](#dxclient-documentation)
24
+
25
+ ## Deployment Options
26
+
27
+ 1. This documentation, recommended for **local developers and admins**, is for the Native JavaScript Code Installation Option of DXClient.
28
+
29
+ 2. One other option is the DXClient container package which is preferred for **CI/CD automation** scenarios. 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. More information could be found in the [dxclient-scripts](https://github.com/HCL-TECH-SOFTWARE/dxclient-scripts).
30
+
31
+ **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 CFNumber.x.x. For example, the old release version of DXClient was "1.29.0" but the upcoming releases is reformatted to "221.0.0". The number 221 is synonymous with the CF Number version of DX deployments.
18
32
 
19
33
  **This document is for the native JS (non-container) version of DXClient**
20
34
 
21
- # Requirements
22
- To use these tools you will need:
23
- - Node.js must be installed on your workstation. It is tested using the LTS versions of Node.js.
24
-
25
- Note: You can verify that Node.js is installed by running the following commands:
26
-
27
- `node -v`
28
-
29
- # Install DXClient with package from HCL Software Portal
30
-
31
- Complete the following steps to install the DXClient tool to your local development workstation or automation server.
32
-
33
- 1. 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.
34
- 2. run `make install` to install all dependencies
35
- In case of windows OS run `make_install.bat` to install all dependencies
36
-
37
- (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).
38
-
39
- For Linux and Apple MacOS platforms
40
- ```
41
- make link
42
- ```
43
-
44
- For Microsoft Windows platforms:
45
-
46
- ```
47
- make_link.bat
48
- ```
49
-
50
- > ### Notes:
51
- > 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.
52
-
53
- 3. Use the command below to run the application.
54
-
55
- For Linux and Apple MacOS platforms
56
-
57
- ```
58
- ./bin/dxclient
59
- ```
60
-
61
- For Microsoft Windows platforms:
62
-
63
- ```
64
- node bin/dxclient
65
- ```
66
-
67
- 4. Run 'dxclient -V' to verify that the dxclient command line is installed.
68
-
69
- 5. A folder named 'store' will be created in your working directory.
70
-
71
- 6. You will be able to find the configuration, logger, output, and sample files under location - <working-directory>/store.
72
- 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:
73
-
74
- "Linux and Apple macOS"
75
-
76
- ```
77
- bash
78
- export VOLUME_DIR=storeForScriptApplication
79
-
80
- # or if you want spaces in its value, enclose it in double quotes ("")
81
- export VOLUME_DIR="store for script application"
82
- ```
83
-
84
- "Microsoft Windows"
85
-
86
- ```
87
- batch
88
- set VOLUME_DIR=storeForScriptApplication
89
-
90
- :: or if you want spaces in its value
91
- set VOLUME_DIR=store for script application
92
- ```
35
+ ## Native JavaScript Code Installation Options
93
36
 
94
- !!!important
95
- Do not enclose the value of `VOLUME_DIR` in double quotes ("") in Windows. This produces errors when executing DXClient commands.
37
+ 1. **From NpmJS Registry**:
38
+ 1. To install globally (Recommended): `npm install -g @hcl-software/dxclient`
39
+ 2. To install locally: `npm install @hcl-software/dxclient`
40
+ 3. To uninstall: `npm uninstall @hcl-software/dxclient`
96
41
 
97
- 7. The `VOLUME_DIR` requires read and write access permissions. Set appropriate permissions for the `VOLUME_DIR` as per user/group/owner.
42
+ 2. **From HCL Software Portal**:
43
+ - Download the DXClient.zip file from your HCL Digital Experience 9.5 CF196 or higher entitlements.
44
+ - Run `make install` to install all dependencies (for Windows, run `make_install.bat`).
45
+ - (Optional but recommended) Link your application to the local npm module: `make link` (for Windows, run `make_link.bat`), this will make your dxclient available globally.
46
+ - Run `dxclient -V` to verify the installation.
98
47
 
99
- "Linux and Apple macOS"
100
-
101
- ```
102
- bash
103
- chmod xxx <working-directory>/<VOLUME_DIR>
104
-
105
- # where xxx is a 3-digit number where each digit can be anything from 0 to 7.
106
- # Ref: https://wiki.archlinux.org/title/File_permissions_and_attributes#Numeric_method
107
- ```
108
-
109
- "Microsoft Windows"
110
-
111
- ```
112
- 1. Right click `<working-directory>/<VOLUME_DIR>` directory > "Properties" > "Security" Tab.
113
- 2. Set the appropriate permission for the folder.
114
- ```
115
-
116
- You can find the configuration, logger, and output files under `<working-directory>/<VOLUME_DIR>`.
117
-
118
- 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 <working-directory>/samples/sample-configurations for reference. If you want to override any of the parameters in the config.json, add them in your command line.
119
-
120
- ## DXClient uninstall
121
-
122
- To uninstall the DXClient tool, follow the commands below.
123
-
124
- For Linux and Apple MacOS platforms:
125
-
126
- ```
127
- make clean
128
- ```
129
-
130
- For Microsoft Windows platforms:
131
-
132
- ```
133
- make uninstall.bat
134
- ```
135
-
136
- To unlink the DXClient tool, follow the commands below.
137
-
138
- For Linux and Apple MacOS platforms:
139
-
140
- ```
141
- make unlink
142
- ```
143
-
144
- For Microsoft Windows platforms:
145
-
146
- ```
147
- make_unlink.bat
148
- ```
149
-
150
- # Install/Uninstall DXClient from NpmJS registry
151
-
152
- Use `npm install @hcl-software/dxclient` command to install the latest version of DXClient.
153
-
154
- Use `npm install -g @hcl-software/dxclient` command to install DXClient globally.
155
-
156
- Use `npm uninstall @hcl-software/dxclient` command to uninstall.
157
-
158
- This option to install/uninstall are avaialble from HCL DX 9.5 CF221 deployment. The latest version you install will be "221.0.0".
159
-
160
- > **Note:**
161
- > To install dxclient on a Windows OS in an empty folder, first create an empty `package.json` file before running the npm install commands.
162
-
163
- ## Additional Information
164
-
165
- 1. The attribute `-dxConnectHostname` has been deprecated (since CF202) and removed (since CF210) and must be replaced with `-hostname` wherever necessary.
166
- 2. 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.
167
- 3. 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](troubleshooting_dxclient.md#troubleshooting-for-some-known-issues).
168
- 4. The maximum input file size allowed in DXClient is 256 MB currently. This limitation will be addressed in one of the future releases.
169
- 5. As of CF213, the property `DXCONNECT_MAX_MEMORY_SIZE_MB` in DXC_ConfigSettings Resource Environment Provider has been removed. Refer [DXC_ConfigSettings](dxconnect.md#resource-environment-provider-property-for-dxconnect) for more details.
170
-
171
48
  ## Verify the DXClient installation
172
49
 
173
- 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.
50
+ 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 (Option 1.1). Use "`./node_modules/.bin/dxclient -V`" when installed locally (Option 1.2).
174
51
 
175
52
  Once installed, commands can be executed using the DXClient tool to perform CI / CD actions on HCL DX 9.5 servers.
176
53
 
177
- **Important:**
178
- 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.
179
- You may use "`dxclient version-compat`" to check version compatibility between DX Core and DXClient.
180
-
181
- ### DXClient Release Timelines & Updates
182
-
183
- 1. If connecting to an HCL DX 9.5 CF19 deployment, the DXClient tool provides commands supporting the following artifact types along with the documentation -
184
- * deploy/undeploy portlets
185
- * deploy script applications
186
- * xmlaccess
187
- * restore script application
188
-
189
- 2. 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 -
190
- * undeploy script applications
191
- * deploy themes (EAR & WebDAV based)
192
-
193
- 3. 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 -
194
- * restart application
195
- * deploy application
196
- * manage syndicator
197
- * manage subscriber
198
-
199
- 4. 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
200
- * undeploy theme
201
-
202
- 5. 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
203
- * shared library
204
-
205
- 6. 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
206
- * Get Syndication failed report
207
- * Delete DAM schema
208
-
209
- 7. 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
210
- * Resource Environment Provider Updates - Create,update and delete
211
- * Create/import/export/list of virtual portal
212
- * Import and Export PZN
213
- * List DAM schemas
214
-
215
- 8. 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
216
- * Resource Environment Provider Updates - Export and Import
217
- * Create Credential Vault Slot
218
- * Create Syndication Relation
219
- * DAM Staging - Register, Deregister and Trigger
220
-
221
- 9. 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
222
- * WCM Libraries - Export and Import
223
- * DX Core Configuration Reports - summary-report
224
-
225
- 10. 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
226
- * An optional parameter requestId added to Deploy theme, Deploy application, Restart DX Core server, and Manage virtual portals.
227
- * Retrieve feature added to the Resource environment provider.
228
- * Accessing ConfigWizard in container environment
229
- 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.
230
-
231
- 11. 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
232
- * Deprecated parameter dxConnectHostname. It is recommended that you start using the replacement parameter -hostname starting from CF202 wherever necessary.
233
- * DAM Assets Export & import
234
-
235
- 12. 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
236
- * Support to set different Container Runtimes.
237
-
238
- 13. 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
239
- * Get all subscribers details for DAM staging
240
-
241
- 14. 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
242
- * Restart Core Pods in a Kubernetes Deployment
243
-
244
- 15. If connecting to an HCL DX 9.5 CF210 deployment, following changes are to be expected.
245
- * Removed paramaters deprecated during CF201 & CF202 deployment.
246
- * added ability to export/import wcm libraries in Virtual Portal.
54
+ > **Important:**
55
+ > 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.
247
56
 
248
- 16. If connecting to an HCL DX 9.5 CF211 deployment, following changes are to be expected.
249
- * Deploy and Undeploy Applications
250
-
251
- 17. If connecting to an HCL DX 9.5 CF213 deployment, following changes are to be expected.
252
- * Livesync of WebDAV based Themes
253
-
254
- 18. If connecting to an HCL DX 9.5 CF214 deployment, following changes are to be expected.
255
- * Livesync Improvements
256
- - List themes during Pull theme in case themeName is not provided.
257
- - Livesync is now supported in scaled DX environment setups
258
-
259
- 19. If connecting to an HCL DX 9.5 CF216 deployment, following changes are to be expected.
260
- * Show Version compatibility details between DXCore and DXClient
261
-
262
- 20. If connecting to an HCL DX 9.5 CF219 deployment, following changes are to be expected.
263
- * Enabled multiple environment configuration in node version
57
+ ## DXClient configuration
264
58
 
265
- 21. If connecting to an HCL DX 9.5 CF221 deployment, following changes are to be expected.
266
- * DXClient Version Type(Node/Container) information available using help/version-compat commands
267
- * A one time license agreement click-through is enabled. To skip the prompt, use "accept-license" command.
268
- * DXClient will be openly distributed in NpmJS & harbor repository.
269
- * In DAM Staging tasks, the parameters dxWASUsername, dxWASPassword, targetServerWASUsername, and targetServerWASPassword are now deprecated and should no longer be used.
59
+ 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. This json file will be generated in the store folder that is created where you executed the dxclient command.
270
60
 
271
- 22. If connecting to an HCL DX 9.5 CF224 release, following changes are to be expected.
272
- * New DXClient LiveSync Sub-Commands: LiveSync push-wcm-design-library | pull-wcm-design-library
61
+ A sample configuration file that could be used on-premises platforms in standalone, cluster platforms is also available under [here](https://github.com/HCL-TECH-SOFTWARE/dxclient-scripts/blob/main/samples/sample-configurations/default-config.json) for reference.
273
62
 
274
- 24. If connecting to an HCL DX 9.5 CF225 release, following changes are to be expected.
275
- * Livsync enabled for Presentation Template under WCM Design Library.
63
+ ### Configuring TLS Certificate Validation for Secure Connections
276
64
 
277
- ## DXClient configuration
65
+ As part of our ongoing efforts to improve security and maintain best practices in our development and production environments, we have made a key change in the way we handle TLS (Transport Layer Security) connections while using DXClient from CF226. You can still trust custom certificates (e.g., self-signed or third-party CAs), without disabling validation entirely.
278
66
 
279
- 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.
67
+ **Step 1: Obtain the Certificate**
68
+ Ensure you have the .pem certificate file that you wish to add to the trust store. It must contain the whole content of both key and certificate files.
280
69
 
281
- 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.
70
+ **Step 2: Add the certificate**
71
+ You have two ways to add/set the Certificate file.
72
+ a. Using NODE_EXTRA_CA_CERTS
73
+ By enabling NODE_EXTRA_CA_CERTS, we now provide a secure way to add custom trusted certificates. To use the NODE_EXTRA_CA_CERTS environment variable, you need to specify the path to a PEM file that contains the key & certificate details. Here's how you can configure it in your local or production environment:
282
74
 
283
- ### DXClient Commands
284
- - `make link`: To create a symlinks to global npm folder for Microsoft Windows platforms
285
- - `make_link.bat` : To create a symlinks to global npm folder
286
- - `make unlink`: To remove the symlink created by the make link
287
- - `make_unlink.bat`: To remove the symlink created by the make link for Microsoft Windows platforms
288
- - `make install`: To install all dependency
289
- - `make_install.bat` : To install all dependencies of windows OS
290
- - `make uninstall`: To uninstall the package and dependency
291
- - `make_uninstall.bat`: To uninstall the package and dependency of windows OS
75
+ "Linux and Apple macOS"
76
+ ```
77
+ export NODE_EXTRA_CA_CERTS=/Users/myUser/my-cert.pem
78
+ ```
79
+ "Microsoft Windows"
80
+ ```
81
+ set NODE_EXTRA_CA_CERTS=C:\Users\myUser\my-cert.pem
82
+ ```
292
83
 
293
- To list the artifact details, run
84
+ b. Add certificate to the trust store on your OS.
294
85
 
295
- ```
296
- dxclient - help document for the commands usage
297
- dxclient accept-license - command to skip prompt of click-through license acceptance agreement.
298
- dxclient version-compat - command to show version compatibility details between DX Core and DXClient
299
- dxclient deploy-portlet [options] - command to execute the deploy portlet action
300
- dxclient undeploy-portlet [options] - command to execute the undeploy portlet action
301
- dxclient xmlaccess [options] - command to execute the xmlaccess action
302
- dxclient deploy-scriptapplication [options] - command to execute the deploy script application action
303
- dxclient undeploy-scriptapplication [options] - command to execute the undeploy script application action
304
- dxclient restore-scriptapplication [options] - command to execute the restore script application action
305
- dxclient deploy-theme [options] - command to execute the deploy theme action
306
- dxclient undeploy-theme [options] - command to execute the undeploy theme action
307
- dxclient deploy-application [options] - command to execute the deploy application action
308
- dxclient undeploy-application [options] - command to execute the undeploy application action
309
- dxclient manage-syndicator [options] - command to execute the syndicator action
310
- dxclient manage-subscriber [options] - command to execute the subscriber action
311
- dxclient restart-dx-core [options] - command to execute the DX Core restart action
312
- dxclient mls-export [options] - command to export content of a WCM Library for translation
313
- dxclient mls-import [options] - command to import the translated contents into the DX
314
- dxclient manage-syndicator get-syndication-report [options] - command to execute the syndication failed report
315
- dxclient delete-dam-schema [options] - command to execute the delete dam schema action
316
- dxclient list-dam-schemas [options] - command to execute the list of all dam schema action
317
- dxclient pzn-export [options] - command to export the pzn rules from the target server
318
- dxclient pzn-import [options] - command to import the pzn rules into the target server
319
- dxclient resource-env-provider [options] - command to create, update or delete a custom property from an existing Resource Environment Provider
320
- dxclient manage-virtual-portal [options] - command to manage virtual portal tasks in the DX server
321
- dxclient manage-dam-staging register-dam-subscriber [options] - command to execute the register subscriber action
322
- dxclient manage-dam-staging trigger-staging [options] - command to execute the trigger staging action
323
- dxclient manage-dam-staging deregister-dam-subscriber [options] - command to execute the deregister subscriber action
324
- dxclient manage-dam-staging get-all-subscribers [options] - command to execute the get subscribers details action
325
- dxclient manage-dam-staging update-secrets [options] - command to execute the update secrets action
326
- dxclient manage-dam-staging find-staging-mismatch [options] - command to execute the find mismatch action
327
- dxclient manage-dam-staging get-staging-mismatch-report [options] - command to generate staging mismatch report
328
- dxclient manage-dam-staging start-staging-resync [options] - command to execute the staging resync action
329
- dxclient manage-dam-staging delete-staging-mismatch [options] - command to execute the delete staging mismatch action
330
- dxclient create-credential-vault [options] - command to create credential vault in the DX server
331
- dxclient wcm-library-export [options] - command to export the wcm libraries from the target server
332
- dxclient wcm-library-import [options] - command to import the wcm libraries from the target server
333
- dxclient dx-core-configuration-reports [options] - command to generate any dx core configuration reports
334
- dxclient manage-dam-assets export-assets [options] - command to export the dam assets
335
- dxclient manage-dam-assets validate-assets [options] - command to validate the dam assets
336
- dxclient manage-dam-assets import-assets [options] - command to import the dam assets
337
- dxclient restart-core-pods [options] - command to execute the Restart Core Pods action (for Kubernetes deployments)
338
- dxclient livesync push-theme [options] - command for watching a theme folder path live and syncs it in DX Server
339
- dxclient livesync pull-theme [options] - command for downloading theme files from DX Server to a target local theme folder
340
- dxclient livesync push-wcm-design-library [options] - command for watching a WCM Design Library folder path live and syncs it in DX Server
341
- dxclient livesync pull-wcm-design-library [options] - command for downloading WCM Design Library files from DX Server to a target local folder
86
+ **Note** In local or development environments, you may want to disable this security feature to allow connections to services with self-signed or invalid certificates. By setting NODE_TLS_REJECT_UNAUTHORIZED to 0, you can bypass certificate validation. This can be useful for testing, but it should never be used in production environments because it can expose your application to potential security risks.
342
87
 
343
- ```
344
- ### DXClient Help commands
88
+ ## DXClient Help commands
345
89
 
346
90
  The following commands show the Help documents for DXClient command usage.
347
91
 
@@ -361,12 +105,6 @@ Use the following command to display the DXClient version number:
361
105
  dxclient -V, --version
362
106
  ```
363
107
 
364
- Use the following command to skip prompt of click-through license acceptance agreement:
365
-
366
- ```
367
- dxclient accept-license
368
- ```
369
-
370
108
  Use the following command to display the detailed help for a specific command:
371
109
 
372
110
  ```
@@ -379,2956 +117,214 @@ Use the following command to show version compatibility details between DX Core
379
117
  dxclient version-compat [command] [options]
380
118
 
381
119
  ```
382
- Command options
383
- ```
384
- -hostname <value>
385
- Use this attribute to specify the hostname of the target server
386
-
387
- -dxConnectProtocol <value>
388
- Use this attribute to specify the protocol with which to connect to the CW server
389
-
390
- -dxConnectUsername <value>
391
- Use this attribute to specify the username that is required for authenticating to the cw_profile
392
-
393
- -dxConnectPassword <value>
394
- Use this attribute to specify the password that is required for authenticating to the cw_profile
395
-
396
- -dxConnectPort <value>
397
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
398
- ```
399
-
400
- ### 1. Deploy Portlet
401
-
402
- 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.
403
-
404
- Commands Description
405
- ```
406
- dxclient deploy-portlet
407
- 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.
408
- ```
409
-
410
- **Help command**
411
- This command shows the help document on the `deploy-portlet` command usage:
412
- ```
413
- dxclient deploy-portlet -h
414
- ```
415
- **Required files**
416
- 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.
417
-
418
- 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.
419
-
420
- **Command options**
421
- ```
422
- -hostname <value>
423
- Use this attribute to specify the hostname of the target server
424
-
425
- -dxProtocol <value>
426
- Use this attribute to specify the protocol with which to connect to the server
427
-
428
- -dxPort <value>
429
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
430
-
431
- -xmlConfigPath <value>
432
- Use this attribute to specify the path to DX configuration endpoint
433
-
434
- -dxUsername <value>
435
- Use this attribute to specify the username that is required for authenticating with the server
436
-
437
- -dxPassword <value>
438
- Use this attribute to specify the password that is required for authenticating with the server
439
-
440
- -dxConnectUsername <value>
441
- Use this attribute to specify the username that is required for authenticating to the cw_profile
442
-
443
- -dxConnectPassword <value>
444
- Use this attribute to specify the password that is required for authenticating to the cw_profile
445
-
446
- -dxConnectPort <value>
447
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
448
-
449
- -xmlFile <xml file name with absolute path of the xmlaccess input file>
450
- 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/
451
-
452
- -warFile <war file name with absolute path of the deployable war file>
453
- 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/
454
-
455
- **Note:** Mandatory parameters xmlFile and warFile should be passed into the command line.
456
- ```
457
-
458
- Example Usage:
459
- ```
460
- 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>
461
- ```
462
-
463
- ### 2. Undeploy Portlet
464
-
465
- Undeploy-portlet command is used to undeploy the deployed portlets in the target DX Servers.
466
-
467
- **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.
468
-
469
- Commands Description
470
- ```
471
- dxclient undeploy-portlet
472
- This command invokes the undeploy-portlet tool inside the DXClient. The undeploy-portlet dxtool uses the provided files and execute the undeploy portlet task.
473
- ```
474
-
475
- **Help command**
476
- This command shows the help information for `undeploy-portlet` command usage:
477
- ```
478
- dxclient undeploy-portlet -h
479
- ```
480
- **Required files**
481
- ```
482
- Xml file: This file should contain the definition of the web application along with the undeploy portlet details.
483
- ```
484
- **Command options**
485
- ```
486
- -hostname <value>
487
- Use this attribute to specify the hostname of the target server
488
-
489
- -dxProtocol <value>
490
- Use this attribute to specify the protocol with which to connect to the server
491
-
492
- -dxPort <value>
493
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
494
-
495
- -xmlConfigPath <value>
496
- Use this attribute to specify the path to DX configuration endpoint
497
-
498
- -dxUsername <value>
499
- Use this attribute to specify the username that is required for authenticating with the server
500
-
501
- -dxPassword <value>
502
- Use this attribute to specify the password that is required for authenticating with the server
503
-
504
- -xmlFile <xml file name with absolute path of the xmlaccess input file>
505
- 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/`
506
-
507
- -enableBackup <value>
508
- Use this attribute to take the backup of portlet application before undeploying it
509
- ```
510
-
511
- Commands required when enableBackup is set to true
512
- ```
513
- -dxConnectPort <value>
514
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
515
-
516
- -dxConnectUsername <value>
517
- Use this attribute to specify the username that is required for authenticating to the cw_profile
518
-
519
- -dxConnectPassword <value>
520
- Use this attribute to specify the password that is required for authenticating to the cw_profile
521
-
522
- -dxSoapPort <Soap port of the DX server>
523
- Use this attribute to specify Soap port of the DX server
524
-
525
- -dxProfileName <Profile name of the DX core server>
526
- Use this attribute to specify the profile name of the DX core server
527
-
528
- -dxProfilePath <Profile path of the DX core server>
529
- Use this attribute to specify the profile path of the DX core server
530
- ```
531
- **Note:** Mandatory parameter xmlFile should be passed into the command line.
532
-
533
- Example Usage:
534
- ```
535
- dxclient undeploy-portlet -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path>
536
- ```
537
- Example Usage with dxProfileName and when enableBackup is set to true:
538
- ```
539
- 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>
540
- ```
541
- Example Usage with dxProfilePath and when enableBackup is set to true:
542
- ```
543
- 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>
544
- ```
545
-
546
- ### 3. XML Access
547
-
548
- 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.
549
-
550
- Command Description:
551
- ```
552
- dxclient xmlaccess -xmlFile <path>
553
- ```
554
-
555
- **Help command**
556
- This command shows the help information for `xmlaccess` command usage:
557
- ```
558
- dxclient xmlaccess -h
559
- ```
560
- **Required files**
561
- ```
562
- Xml file: This XML file should contain the configuration update or export operation for the web application
563
- ```
564
- **Command options**
565
- ```
566
- -dxProtocol <value>
567
- Use this attribute to specify the protocol with which to connect to the DX server (wp_profile):
568
-
569
- -hostname <value>
570
- Use this attribute to specify the hostname of the target DX server:
571
-
572
- -dxPort <value>
573
- Use this attribute to specify the port on which to connect to the DX server (wp_profile),for Kubernetes Environment dxPort is 443:
574
-
575
- -xmlConfigPath <value>
576
- Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config):
577
-
578
- -dxUsername <value>
579
- Use this attribute to specify the username to authenticate with the DX server (wp_profile):
580
-
581
- -dxPassword <value>
582
- Use this attribute to specify the password for the user in the "dxUsername" attribute:
583
-
584
- -xmlFile <Absolute or relative path to xmlaccess input file>
585
- 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/`:
586
-
587
- ```
588
- **Note:** Mandatory parameter xmlFile should be passed into the command line.
589
-
590
- Example usage:
591
- ```
592
- dxclient xmlaccess -xmlFile <xml-file-with-path>
593
- ```
594
-
595
- ### 4. Deploy Script Application
596
-
597
- 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.
598
-
599
- Commands Description
600
- ```
601
- dxclient deploy-scriptapplication
602
-
603
- 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.
604
- ```
605
- **Help command**
606
- This command shows the help document on the `deploy-scriptapplication` command:
607
- ```
608
- dxclient deploy-scriptapplication pull -h
609
-
610
- dxclient deploy-scriptapplication push -h
611
- ```
612
- **Command options**
613
- ```
614
- push [OPTIONS]
615
- Create or update the content of a Script Application in the DX server
616
- pull [OPTIONS]
617
- Downloads the content of a Script Application present in the DX server
618
- ```
619
- **Required options - Pull command**
620
- ```
621
- -dxProtocol <value>
622
- Use this attribute to specify the protocol of the target server.
623
- -hostname <value>
624
- Use this attribute to specify the hostname of the target server.
625
- -dxPort <value>
626
- Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
627
- -dxUsername <value>
628
- The name of the dxUsername for authentication.
629
- -dxPassword <value>
630
- The password of the dxUsername for authentication.
631
- -wcmContentID <value>
632
- WCM content ID of the Script Application instance.
633
- -virtualPortalContext <value>
634
- The context of the virtual portal that contains the Script Application instance that you want to create or update.
635
- -projectContext <value>
636
- The context of the portal project that manages the publication of changes to the Script Application content.
637
- ```
638
-
639
- **Required options - Push command**
640
- ```
641
- -dxProtocol <value>
642
- Use this attribute to specify the protocol of the target server.
643
- -hostname <value>
644
- Use this attribute to specify the hostname of the target server.
645
- -dxPort <value>
646
- Use this attribute to specify the port of the target server(for Kubernetes Environment dxPort is 443).
647
- -dxUsername <value>
648
- The name of the dxUsername for authentication.
649
- -dxPassword <value>
650
- The password of the dxUsername for authentication.
651
- -wcmContentName <value>
652
- Name of the Script Application instance to be created or updated.
653
- -wcmContentPath <value>
654
- Full WCM path of the Script Application instance to be created or updated.
655
- You cannot use this argument with -wcmSiteArea and -wcmContentName.
656
- -wcmContentID <value>
657
- WCM content ID only if you are updating an existing Script Application instance on a portal page.
658
- -wcmContentTitle <value>
659
- Sets or updates the title of the Script Application instance.
660
- -wcmSiteArea <value>
661
- SiteArea of the Script Application content.
662
- -contenthandlerPath <value>
663
- The path to the contenthandler servlet on the Script Application server.
664
- -contentRoot <value>
665
- Absolute or relative path to the Script Application's content.
666
- -virtualPortalContext <value>
667
- The context of the virtual portal that contains the Script Application instance that you want to create or update.
668
- -projectContext <value>
669
- The context of the portal project that manages the publication of changes to the Script Application content.
670
- -prebuiltZip <value>
671
- Path to an existing compressed file that provides the content to be pushed to the portal instead of the -contentRoot option.
672
- Note: When -prebuiltZip is specified, the main HTML file path must be relative to the top-level directory in the compressed file.
673
- -mainHtmlFile <value>
674
- Path to the main HTML file of the Script Application.
675
-
676
- **Note:** Mandatory parameters contentRoot and prebuiltZip should be passed into the command line.
677
- ```
678
-
679
- Example Usage:
680
- ```
681
- Script Application Pull , execute
682
-
683
- dxclient deploy-scriptapplication pull -wcmContentID <wcmContentID>
684
-
685
- The outputfile for pull will be generated inside store/outputFiles/sp-pull-output
686
-
687
- If the options are configured in dist/configuration/config.json, then execute
688
-
689
- dxclient deploy-scriptapplication pull
690
-
691
- dxclient deploy-scriptapplication push , execute
692
-
693
- dxclient deploy-scriptapplication push -contentRoot /temp -wcmSiteArea "Script Application Library/Script Applications/" -wcmContentName DemoScriptApplication
694
-
695
- If the options are configured in dist/configuration/config.json, then execute
696
-
697
- dxclient deploy-scriptapplication push
698
- ```
699
-
700
- ### 5. Deploy Theme
701
-
702
- 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.
703
-
704
- Commands Description
705
- ```
706
- dxclient deploy-theme
707
- This command invokes the deploy-theme tool inside the DXClient. This command uses the provided files and execute the deploy theme task.
708
- ```
709
- **Help command**
710
- This command shows the help document on the `deploy-theme` command usage:
711
- ```
712
- dxclient deploy-theme -h
713
- ```
714
- **Required files**
715
- ```
716
- 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.
717
-
718
- Theme deployable EAR file: This EAR file containing theme data will be used for deploying it into the WebSphere Application Server.
719
-
720
- 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.
721
- ```
722
-
723
- This command can execute below one or more tasks together:
724
- 1. Theme Registration
725
- 2. Theme EAR deployment
726
- 3. WebDAV theme collection
727
-
728
- **Common Command options**
729
- ```
730
- -hostname <value>
731
- Use this attribute to specify the hostname of the target server
732
-
733
- -dxProtocol <value>
734
- Use this attribute to specify the protocol with which to connect to the server
735
-
736
- -dxPort <value>
737
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
738
-
739
- -dxUsername <value>
740
- Use this attribute to specify the username that is required for authenticating with the server
741
-
742
- -dxPassword <value>
743
- Use this attribute to specify the password that is required for authenticating with the server
744
-
745
- Required options for Theme Registration:
746
-
747
- -xmlFile <xml file name with absolute path of the xmlaccess input file>
748
- 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/
749
120
 
750
- -xmlConfigPath <value>
751
- Use this attribute to specify the path to DX configuration endpoint
121
+ ## All available commands
122
+
123
+ | Command | Description |
124
+ |-------------------------------------------------------------------|--------------------------------------------------------|
125
+ | [dxclient](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/) | Help document for the commands usage |
126
+ | [dxclient version-compat](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/versionCompat/) | Command to show version compatibility details |
127
+ | [dxclient accept-license](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/#dxclient-information-commands) | Command to explicitly accept the license without prompt|
128
+ | [dxclient deploy-portlet](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/portlets/#deploy-portlets) [options] | Command to execute the deploy portlet action |
129
+ | [dxclient undeploy-portlet](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/portlets/#undeploy-portlets) [options] | Command to execute the undeploy portlet action |
130
+ | [dxclient xmlaccess](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/xmlaccess/) [options] | Command to execute the xmlaccess action |
131
+ | [dxclient deploy-scriptapplication](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/scriptapplications/#deploy-script-applications) [options] | Command to execute the deploy script application action|
132
+ | [dxclient undeploy-scriptapplication](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/scriptapplications/#undeploy-script-applications) [options] | Command to execute the undeploy script application action|
133
+ | [dxclient restore-scriptapplication](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/scriptapplications/#restore-script-application) [options] | Command to execute the restore script application action|
134
+ | [dxclient deploy-theme](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/themes/#deploy-theme) [options] | Command to execute the deploy theme action |
135
+ | [dxclient undeploy-theme](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/themes/#undeploy-theme) [options] | Command to execute the undeploy theme action |
136
+ | [dxclient deploy-application](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/deployapplication/) [options] | Command to execute the deploy application action |
137
+ | [dxclient undeploy-application](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/deployapplication/#undeploy-application) [options] | Command to execute the undeploy application action |
138
+ | [dxclient manage-syndicator](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/syndicatorsandsubscribers/) [options] | Command to execute the syndicator action |
139
+ | [dxclient manage-subscriber](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/syndicatorsandsubscribers/#managing-subscribers) [options] | Command to execute the subscriber action |
140
+ | [dxclient restart-dx-core](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/dxcoreserver/) [options] | Command to execute the DX Core restart action |
141
+ | [dxclient mls-export](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/wcm_mls_export_import/) [options] | Command to export content of a WCM Library for translation|
142
+ | [dxclient mls-import](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/wcm_mls_export_import/) [options] | Command to import the translated contents into the DX |
143
+ | [dxclient manage-syndicator get-syndication-report](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/syndicatorsandsubscribers/#manage-syndicator-get-syndication-report) [options] | Command to execute the syndication failed report|
144
+ | [dxclient delete-dam-schema](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/usage/managing_dam/damschemas/#deleting-dam-schemas) [options] | Command to execute the delete dam schema action |
145
+ | [dxclient list-dam-schemas](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/usage/managing_dam/damschemas/#listing-dam-schemas) [options] | Command to execute the list of all dam schema action |
146
+ | [dxclient pzn-export](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/personalization/) [options] | Command to export the pzn rules from the target server |
147
+ | [dxclient pzn-import](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/personalization/#import-pzn-rules) [options] | Command to import the pzn rules into the target server |
148
+ | [dxclient resource-env-provider](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/resourceenvironments/) [options] | Command to create, update or delete a custom property from an existing Resource Environment Provider|
149
+ | [dxclient manage-virtual-portal](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/virtualportals/) [options] | Command to manage virtual portal tasks in the DX server |
150
+ | [dxclient manage-dam-staging register-dam-subscriber](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_subscription_staging/#registering-or-deregistering-for-dam-staging) [options] | Command to execute the register subscriber action|
151
+ | [dxclient manage-dam-staging trigger-staging](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_subscription_staging/#managing-dam-staging) [options] | Command to execute the trigger staging action|
152
+ | [dxclient manage-dam-staging deregister-dam-subscriber](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_subscription_staging/#registering-or-deregistering-for-dam-staging) [options] | Command to execute the deregister subscriber action|
153
+ | [dxclient manage-dam-staging get-all-subscribers](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_subscription_staging/#getting-all-subscribers-details-for-dam-staging) [options] | Command to execute the get subscribers details action|
154
+ | [dxclient manage-dam-staging update-secrets](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_subscription_staging/#updating-secrets-for-dam-staging) [options] | Command to execute the update secrets action|
155
+ | [dxclient manage-dam-staging find-staging-mismatch](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_staging_mismatch/) [options] | Command to execute the find mismatch action|
156
+ | [dxclient manage-dam-staging get-staging-mismatch-report](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_staging_mismatch/#download-mismatch-report) [options] | Command to generate staging mismatch report|
157
+ | [dxclient manage-dam-staging start-staging-resync](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_staging_mismatch/#staging-resync) [options] | Command to execute the staging resync action|
158
+ | [dxclient manage-dam-staging delete-staging-mismatch](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/configuration/staging_dam/dam_staging_mismatch/#delete-staging-mismatch) [options] | Command to execute the delete staging mismatch action|
159
+ | [dxclient create-credential-vault](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/credentialvaultslot/) [options] | Command to create credential vault in the DX server |
160
+ | [dxclient wcm-library-export](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/wcmlibraries/) [options] | Command to export the wcm libraries from the target server|
161
+ | [dxclient wcm-library-import](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/wcmlibraries/#import-wcm-libraries) [options] | Command to import the wcm libraries from the target server|
162
+ | [dxclient dx-core-configuration-reports](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/dxcoreserver/#dx-core-server-configuration-report) [options] | Command to generate any dx core configuration reports|
163
+ | [dxclient manage-dam-assets export-assets](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/usage/managing_dam/dam_exim/#export-dam-assets) [options] | Command to export the dam assets |
164
+ | [dxclient manage-dam-assets validate-assets](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/usage/managing_dam/dam_exim/#validate-exported-dam-assets) [options] | Command to validate the dam assets |
165
+ | [dxclient manage-dam-assets import-assets](https://opensource.hcltechsw.com/digital-experience/latest/manage_content/digital_assets/usage/managing_dam/dam_exim/#import-dam-assets) [options] | Command to import the dam assets |
166
+ | [dxclient restart-core-pods](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/dxcoreserver/#restart-dx-core-pods) [options] | Command to execute the Restart Core Pods action (for Kubernetes deployments)|
167
+ | [dxclient livesync push-theme](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/livesync/) [options] | Command for watching a theme folder path live and syncs it in DX Server|
168
+ | [dxclient livesync pull-theme](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/livesync/#livesync-pull-theme) [options] | Command for downloading theme files from DX Server to a target local theme folder|
169
+ | [dxclient livesync pull-wcm-design-library](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/livesync/#livesync-pull-wcm-design-library) [options] | Command for downloading WCM Design Library files from DX Server to a target local folder|
170
+ | [dxclient livesync push-wcm-design-library](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/dxclient_artifact_types/livesync/#livesync-push-wcm-design-library) [options] | Command watching a WCM Design Library folder path live and syncs it in DX Server|
171
+
172
+ ## Command options
173
+
174
+ | Attribute | Description |
175
+ |----------------------------|-----------------------------------------------------------------------------|
176
+ | -hostname [value] | Use this attribute to specify the hostname of the target server |
177
+ | -dxConnectProtocol [value] | Use this attribute to specify the protocol with which to connect to the CW server |
178
+ | -dxConnectUsername [value] | Use this attribute to specify the username that is required for authenticating to the cw_profile |
179
+ | -dxConnectPassword [value] | Use this attribute to specify the password that is required for authenticating to the cw_profile |
180
+ | -dxConnectPort [value] | Use this attribute to specify the port number of the cw_profile (for Kubernetes Environment dxConnectPort is 443) |
181
+
182
+ ## Logger enablement
183
+
184
+ ### Enable Logger
185
+
186
+ Logger can be enabled by setting parameter "enableLogger": true in the `config.json` file. If logger enabled then logger file will be generate in logs folder of the dxclient.
752
187
 
753
- Required options for Theme EAR deployment:
754
-
755
- -dxConnectPort <value>
756
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
757
-
758
- -dxConnectUsername <value>
759
- Use this attribute to specify the username that is required for authenticating to the cw_profile
188
+ If logger enabled then logger file will be available in the below location:
189
+ `store/logs/`
760
190
 
761
- -dxConnectPassword <value>
762
- Use this attribute to specify the password that is required for authenticating to the cw_profile
191
+ ### Disable Logger
763
192
 
764
- -dxSoapPort <Soap port of the DX server>
765
- Use this attribute to specify Soap port of the DX server
193
+ Logger can be disabled by setting parameter "enableLogger":false in the `config.json` file
766
194
 
767
- -dxProfileName <Profile name of the DX core server>
768
- Use this attribute to specify the profile name of the DX core server
195
+ ### DXClient Release Timelines & Updates
769
196
 
770
- -dxProfilePath <Profile Path of the DX core server>
771
- Use this attribute to specify the profile path of the DX core server
197
+ <details>
198
+ <summary>Show Changelog Details</summary>
199
+
200
+ 1. If connecting to an HCL DX 9.5 CF19 deployment, the DXClient tool provides commands supporting the following artifact types along with the documentation
772
201
 
773
- –applicationFile <Absolute or relative path to deployable theme ear file>
774
- Use this attribute to specify the theme ear file path that is required while executing the deploy theme task
202
+ - deploy/undeploy portlets
203
+ - deploy script applications
204
+ - xmlaccess
205
+ - restore script application
775
206
 
776
- -applicationName <value>
777
- Use this attribute to specify the theme application name
207
+ 2. 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
778
208
 
779
- Required options for creating/updating WebDAV theme collection:
209
+ - undeploy script applications
210
+ - deploy themes (EAR & WebDAV based)
780
211
 
781
- -themeName <value>
782
- Use this attribute to specify the theme name of the collection created under WebDav server in DX
783
-
784
- -themePath <value>
785
- Use this attribute to specify the theme file path that contains all static files to be pushed into DX theme
212
+ 3. 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
786
213
 
787
- -contenthandlerPath <value>
788
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):
214
+ - restart application
215
+ - deploy application
216
+ - manage syndicator
217
+ - manage subscriber
789
218
 
790
- Optional arguments:
219
+ 4. 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
791
220
 
792
- -requestId <Unique Id of a previously triggered deploy theme request>
793
- Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
221
+ - undeploy theme
794
222
 
795
- **Note:** Mandatory parameters applicationFile, applicationName, themeName, themePath and xmlFile should be passed into the command line.
796
- ```
223
+ 5. 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
797
224
 
798
- Example Usage with dxProfileName:
799
- ```
800
- 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>
801
- ```
802
- Example Usage with dxProfilePath:
803
- ```
804
- 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>
805
- ```
225
+ - shared library
806
226
 
807
- ### 6. Undeploy Theme
227
+ 6. 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
808
228
 
809
- undeploy-theme command is used to undeploy EAR application and undeploy WebDAV and unregister the registered theme from target DX server.
229
+ - Get Syndication failed report
230
+ - Delete DAM schema
810
231
 
811
- **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`.
232
+ 7. 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
812
233
 
813
- example for backup of EAR, it is placed in `store/outputFiles/themes/backup/application`.
234
+ - Resource Environment Provider Updates - Create,update and delete
235
+ - Create/import/export/list of virtual portal
236
+ - Import and Export PZN
237
+ - List DAM schemas
814
238
 
815
- In case if undeployed theme is required,then user can restore the theme back using the back up files.
239
+ 8. 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
816
240
 
817
- Commands Description
818
- ```
819
- dxclient undeploy-theme
820
- This command invokes the undeploy-theme tool inside the DXClient. This command uses the provided files and execute the undeploy theme task.
821
- ```
822
- **Required files**
823
- ```
824
- 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.
241
+ - Resource Environment Provider Updates - Export and Import
242
+ - Create Credential Vault Slot
243
+ - Create Syndication Relation
244
+ - DAM Staging - Register, Deregister and Trigger
825
245
 
826
- ```
246
+ 9. 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
827
247
 
828
- This command can execute below one or more tasks together:
829
- 1. Theme Unregistration
830
- 2. Theme EAR undeploy
831
- 3. WebDAV theme collection undeploy
248
+ - WCM Libraries - Export and Import
249
+ - DX Core Configuration Reports - summary-report
832
250
 
833
- **Common Command options**
834
- ```
835
- -hostname <value>
836
- Use this attribute to specify the hostname of the target server
251
+ 10. 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
837
252
 
838
- -dxProtocol <value>
839
- Use this attribute to specify the protocol with which to connect to the server
253
+ - An optional parameter requestId added to Deploy theme, Deploy application, Restart DX Core server, and Manage virtual portals.
254
+ - Retrieve feature added to the Resource environment provider.
255
+ - Accessing ConfigWizard in container environment
256
+ 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.
840
257
 
841
- -dxPort <value>
842
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
258
+ 11. 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
843
259
 
844
- -dxUsername <value>
845
- Use this attribute to specify the username that is required for authenticating with the server
260
+ - Deprecated parameter dxConnectHostname. It is recommended that you start using the replacement parameter -hostname starting from CF202 wherever necessary.
261
+ - DAM Assets Export & import
846
262
 
847
- -dxPassword <value>
848
- Use this attribute to specify the password that is required for authenticating with the server
263
+ 12. 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
849
264
 
850
- -contenthandlerPath <value>
851
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler):
265
+ - Support to set different Container Runtimes.
852
266
 
853
- -enableBackup <value>
854
- Use this attribute to take the backup before undeploying theme
267
+ 13. 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
855
268
 
856
- **Note** : User can sets the sets the enableBackup as true to take backup before undeploying, enableBackup is set to false by default.
269
+ - Get all subscribers details for DAM staging
857
270
 
858
- Required options for Theme Unregistration:
271
+ 14. 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
859
272
 
860
- -xmlFile <xml file name with absolute path of the xmlaccess input file>
861
- 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/
273
+ - Restart Core Pods in a Kubernetes Deployment
862
274
 
863
- -xmlConfigPath <value>
864
- Use this attribute to specify the path to DX configuration endpoint
275
+ 15. If connecting to an HCL DX 9.5 CF210 deployment, following changes are to be expected.
865
276
 
866
- Required options for Theme EAR and WebDAV undeployment:
277
+ - Removed paramaters deprecated during CF201 & CF202 deployment.
278
+ - added ability to export/import wcm libraries in Virtual Portal.
867
279
 
868
- -dxConnectPort <value>
869
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
280
+ 16. If connecting to an HCL DX 9.5 CF211 deployment, following changes are to be expected.
870
281
 
871
- -dxConnectUsername <value>
872
- Use this attribute to specify the username that is required for authenticating to the cw_profile
282
+ - Deploy and Undeploy Applications
873
283
 
874
- -dxConnectPassword <value>
875
- Use this attribute to specify the password that is required for authenticating to the cw_profile
284
+ 17. If connecting to an HCL DX 9.5 CF213 deployment, following changes are to be expected.
876
285
 
877
- -dxSoapPort <Soap port of the DX server>
878
- Use this attribute to specify Soap port of the DX server
286
+ - Livesync of WebDAV based Themes
879
287
 
880
- -dxProfileName <Profile name of the DX core server profile>
881
- Use this attribute to specify the profile name of the DX core server
288
+ 18. If connecting to an HCL DX 9.5 CF214 deployment, following changes are to be expected.
882
289
 
883
- -dxProfilePath <Profile path of the DX core server profile>
884
- Use this attribute to specify the profile path of the DX core server
290
+ - Livesync Improvements
291
+ - List themes during Pull theme in case themeName is not provided.
292
+ - Livesync is now supported in scaled DX environment setups
885
293
 
886
- -applicationName <value>
887
- Use this attribute to specify the EAR application name
294
+ 19. If connecting to an HCL DX 9.5 CF216 deployment, following changes are to be expected.
888
295
 
889
- -themeName <value>
890
- Use this attribute to specify the theme name of the collection created under WebDAV
891
-
892
- **Note:** Mandatory parameters applicationName, themeName and xmlFile should be passed into the command line.
893
- ```
296
+ - Show Version compatibility details between DXCore and DXClient
894
297
 
895
- Example Usage with dxProfileName:
896
- ```
897
- 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>
898
- ```
899
- Example Usage with dxProfilePath:
900
- ```
901
- 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>
902
- ```
298
+ 20. If connecting to an HCL DX 9.5 CF219 deployment, following changes are to be expected.
903
299
 
904
- ### 7. Undeploy Script Application
300
+ - Enabled multiple environment configuration in node version
905
301
 
906
- Undeploy Script Application command is used to un-deploy an existing or delete the newly deployed script application from the target DX Server.
302
+ 21. If connecting to an HCL DX 9.5 CF221 deployment, following changes are to be expected.
907
303
 
908
- **Note:**
909
- 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.
304
+ - DXClient Version Type(Node/Container) information available using help/version-compat commands
305
+ - A one time license agreement click-through is enabled. To skip the prompt, use "accept-license" command.
306
+ - DXClient will be openly distributed in NPMJS & Harbor repository.
910
307
 
911
- Commands Description
912
- ```
913
- dxclient undeploy-scriptapplication
914
- This command invokes the undeploy-scriptapplication tool inside the DXClient. The undeploy-scriptapplication dxtool uses the provided files and execute the undeploy scriptapplication task.
915
- ```
916
- **Help command**
917
- This command shows the help information for `undeploy-scriptapplication` command usage:
918
- ```
919
- dxclient undeploy-scriptapplication -h
920
- ```
921
- **Required command options**
922
- ```
923
- -hostname <value>
924
- Use this attribute to specify the hostname of the target server.
308
+ 22. If connecting to an HCL DX 9.5 CF224 deployment, following changes are to be expected.
925
309
 
926
- -dxProtocol <value>
927
- Use this attribute to specify the protocol with which to connect to the server.
310
+ - LiveSync Pull and Push commands for WCM Design Library are now available for HTML and Folder Components.
928
311
 
929
- -dxPort <value>
930
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443).
312
+ 23. If connecting to an HCL DX 9.5 CF225 deployment, following changes are to be expected.
931
313
 
932
- -dxUsername <value>
933
- Use this attribute to specify the username that is required for authenticating with the server.
314
+ - LiveSync now supports Presentation Templates.
934
315
 
935
- -dxPassword <value>
936
- Use this attribute to specify the password that is required for authenticating with the server.
316
+ 24. If connecting to an HCL DX 9.5 CF226 deployment, following changes are to be expected.
937
317
 
938
- -wcmContentID <value>
939
- WCM content ID only if you are updating an existing Script Application instance on a portal page.
318
+ - DXClient no longer ignores certificates that cannot be properly validated when using Transport Layer Security (TLS) connections
319
+ - New documented limitations for LiveSync
320
+ - Updated scripts to pass certificates to container.
940
321
 
941
- -contenthandlerPath <value>
942
- The path to the contenthandler servlet on the Script Application server.
943
-
944
- -virtualPortalContext <value>
945
- The context of the virtual portal that contains the Script Application instance that you want to create or update.
946
-
947
- -projectContext <value>
948
- The context of the portal project that manages the publication of changes to the Script Application content.
949
-
950
- -f
951
- The -f flag is to delete the Script Application forcefully overstepping the prompt.
952
-
953
- ```
954
- Example Usage:
955
- ```
956
- dxclient undeploy-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -f
957
- ```
958
-
959
- ## 8.Restore Script Application
960
-
961
- Restore Script Application command is used to restore the script application into one of its previous versions already present in the target DX Server.
962
-
963
- Commands Description
964
- ```
965
- dxclient restore-scriptapplication
966
- This command invokes the restore-scriptapplication tool inside the DXClient. The restore-scriptapplication dxtool uses the provided files and execute the restore scriptapplication task.
967
- ```
968
- **Help command**
969
- This command shows the help information for `restore-scriptapplication` command usage:
970
- ```
971
- dxclient restore-scriptapplication -h
972
- ```
973
- **Required command options**
974
- ```
975
- -hostname <value>
976
- Use this attribute to specify the hostname of the target server
977
-
978
- -dxProtocol <value>
979
- Use this attribute to specify the protocol with which to connect to the server
980
-
981
- -dxPort <value>
982
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
983
-
984
- -dxUsername <value>
985
- Use this attribute to specify the username that is required for authenticating with the server
986
-
987
- -dxPassword <value>
988
- Use this attribute to specify the password that is required for authenticating with the server
989
-
990
- -wcmContentID <value>
991
- WCM content ID only if you are updating an existing Script Application instance on a portal page.
992
-
993
- -contenthandlerPath <value>
994
- The path to the contenthandler servlet on the Script Application server.
995
-
996
- -virtualPortalContext <value>
997
- The context of the virtual portal that contains the Script Application instance that you want to create or update.
998
-
999
- -projectContext <value>
1000
- The context of the portal project that manages the publication of changes to the Script Application content.
1001
-
1002
- -versionName <value>
1003
- Use this attribute to specify the versionname that is restore version of Script Application.
1004
- Note: When -versionName is not specified, the script application will rollback to the previous version default.
1005
- -restoreAsPublished <value>
1006
- Use this attribute to specify the restore as a draft or replace the published version of Script Application.
1007
-
1008
- ```
1009
- Example Usage:
1010
- ```
1011
- dxclient restore-scriptapplication -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmContentID <wcmContentID> -versionName <versionName> -restoreAsPublished <restoreAsPublished>
1012
- ```
1013
-
1014
- ### 9. Export Content of a WCM Library
1015
-
1016
- 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.
1017
-
1018
- Commands Description
1019
- ```
1020
- dxclient mls-export
1021
- 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.
1022
- ```
1023
- **Required command options**
1024
- ```
1025
- -dxProtocol <value>
1026
- Use this attribute to specify the protocol with which to connect to the DX server
1027
-
1028
- -hostname <value>
1029
- Use this attribute to specify the hostname of the DX server
1030
-
1031
- -dxPort <value>
1032
- Use this attribute to specify the port on which to connect to the DX server
1033
-
1034
- -contenthandlerPath <value>
1035
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1036
-
1037
- -dxUsername <value>
1038
- Use this attribute to specify the username that is required for authenticating with the server
1039
-
1040
- -dxPassword <value>
1041
- Use this attribute to specify the password that is required for authenticating with the server
1042
-
1043
- -wcmLibraryId <value>
1044
- WCM library ID(s) within quotation("") to export the contents of the library. For multiple WCM library ids, enter separated by comma.
1045
-
1046
- -wcmLibraryName <value>
1047
- Provide the WCM library name(s) within quotation("") to export the contents of the library. For multiple WCM library name, enter separated by comma.
1048
-
1049
- -lastModifiedAfter <value>
1050
- Last modified after will give the contents of WCM library id and name from specified date and time in GMT format.
1051
-
1052
- -wcmProjectName <value>
1053
- Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.
1054
-
1055
- -exportPath <value>
1056
- The path to the exports the wcm contents of a library.
1057
-
1058
- -virtualPortalContext <value>
1059
- The context of the virtual portal from which mls library should be exported.
1060
-
1061
- **Note:** Mandatory parameter exportPath should be passed into the command line.
1062
- ```
1063
-
1064
- Example Usage:
1065
- ```
1066
- To Export contents from Library :
1067
- dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1068
- -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmLibraryId <wcmLibraryId> -wcmLibraryName <wcmLibraryName> -lastModifiedAfter <lastModifiedAfter> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>
1069
-
1070
- To Export contents from Project :
1071
- dxclient mls-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1072
- -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -wcmProjectName <wcmProjectName> -exportPath <exportPath> -virtualPortalContext <virtualPortalContext>
1073
- ```
1074
-
1075
- ### 10. Import Translated Contents into DX
1076
-
1077
- The import command is used to import the translated contents into DX at the location specified by the user.
1078
-
1079
- Commands Description
1080
- ```
1081
- dxclient mls-import
1082
- 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.
1083
- ```
1084
-
1085
- **Required command options**
1086
- ```
1087
- -dxProtocol <value>
1088
- Use this attribute to specify the protocol with which to connect to the DX server
1089
-
1090
- -hostname <value>
1091
- Use this attribute to specify the hostname of the DX server
1092
-
1093
- -dxPort <value>
1094
- Use this attribute to specify the port on which to connect to the DX server
1095
-
1096
- -contenthandlerPath <value>
1097
- Use this attribute to specify the context root on which to connect to the DX server
1098
-
1099
- -dxUsername <value>
1100
- Use this attribute to specify the username that is required for authenticating with the server
1101
-
1102
- -dxPassword <value>
1103
- Use this attribute to specify the password that is required for authenticating with the server
1104
-
1105
- -importPath <value>
1106
- The path(s) (separated by comma) to import the translated contents into DX.
1107
-
1108
- -wcmProjectName <value>
1109
- Optional attribute: Provide the WCM project name within quotation("") to export the contents of the project.
1110
-
1111
- -forceImport <value>
1112
- 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)
1113
-
1114
- -virtualPortalContext <value>
1115
- The context of the virtual portal to which mls library should be imported.
1116
-
1117
- **Note:** Mandatory parameter importPath should be passed into the command line.
1118
-
1119
- ```
1120
- Example Usage:
1121
- ```
1122
- dxclient mls-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort>
1123
- -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -importPath <importPath> -wcmProjectName <wcmProjectName> -virtualPortalContext <virtualPortalContext>
1124
- ```
1125
- Editable fields in CSV files
1126
-
1127
- In the exported CSV file, you can only edit the following fields: **target**, **title**, and **description**.
1128
-
1129
- Maximum data length for importing the translated contents:
1130
- ```
1131
- Only ShortTextComponent element type has an explicit maximum data length defined as 250 characters. Import command would validate the length of the data for this particular element type before proceeding with the actual import flow. Any errors due to custom configuration of limits are caught by the import/export during the execution cycle and the error log is reported.
1132
- ```
1133
- CSV file length limits
1134
- ```
1135
- Only ShortTextComponent element type has an explicit maximum data length defined as 250 characters. And this limit is seen by users in the CSV file as new column called fieldLimit is added.
1136
- ```
1137
- Link field to see translators content
1138
- ```
1139
- User can just preview the link of the portal content directly from the CSV file as new column called previewLink is added.
1140
- ```
1141
- Content information data
1142
- ```
1143
- Content specific information rows namely title and description has been provided in the CSV file. User can edit the title and description of the content while importing the contents to portal.
1144
- ```
1145
-
1146
- ### 11. Deploy Application
1147
-
1148
- Deploy-application command is used to deploy EAR file into the WebSphere Application Server.
1149
-
1150
- Commands Description
1151
- ```
1152
- dxclient deploy-application
1153
- This command invokes the deploy-application tool inside the DXClient. This command uses the provided files and execute the deploy application task.
1154
- ```
1155
- **Help command**
1156
- This command shows the help information for `deploy-application` command usage:
1157
- ```
1158
- dxclient deploy-application -h
1159
- ```
1160
- **Required files**
1161
- ```
1162
- Deployable EAR file: This EAR file will be used for deploying it into the WebSphere Application Server.
1163
- ```
1164
- **Common Command options**
1165
- ```
1166
- -hostname <value>
1167
- Use this attribute to specify the hostname of the target server
1168
-
1169
- -dxProtocol <value>
1170
- Use this attribute to specify the protocol with which to connect to the server
1171
-
1172
- -dxPort <value>
1173
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1174
-
1175
- -dxUsername <value>
1176
- Use this attribute to specify the username that is required for authenticating with the server
1177
-
1178
- -dxPassword <value>
1179
- Use this attribute to specify the password that is required for authenticating with the server
1180
-
1181
- Required options for application deployment:
1182
-
1183
- -dxConnectPort <value>
1184
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1185
-
1186
- -dxConnectUsername <value>
1187
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1188
-
1189
- -dxConnectPassword <value>
1190
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1191
-
1192
- -dxSoapPort <Soap port of the DX server>
1193
- Use this attribute to specify Soap port of the DX server
1194
-
1195
- -dxProfileName <Profile name of the DX core server>
1196
- Use this attribute to specify the profile name of the DX core server
1197
-
1198
- -dxProfilePath <Profile path of the DX core server>
1199
- Use this attribute to specify the profile path of the DX core server
1200
-
1201
- –applicationFile <Absolute or relative path to deployable ear file>
1202
- Use this attribute to specify the ear file path that is required while executing the deploy application task
1203
-
1204
- -applicationName <value>
1205
- Use this attribute to specify the application name
1206
-
1207
- Optional arguments:
1208
-
1209
- -requestId <Unique Id of a previously triggered deploy application request>
1210
- Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1211
-
1212
- **Note:** Mandatory parameters applicationFile and applicationName should be passed into the command line.
1213
-
1214
- ```
1215
- Example Usage with dxProfileName:
1216
- ```
1217
- 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>
1218
- ```
1219
-
1220
- Example Usage with dxProfilePath:
1221
- ```
1222
- 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>
1223
- ```
1224
-
1225
- ### 12. Restart DX Core
1226
-
1227
- restart-dx-core command is used to restart the DX Core server.
1228
- **Note:** It is not recommended to run this command in Kubernetes based deployments. To restart all the pods, use the Kubernetes interfaces like kubectl.
1229
-
1230
- Commands Description
1231
- ```
1232
- dxclient restart-dx-core
1233
- This command invokes the restart-dx-core tool inside the DXClient and executes the DX Core restart action.
1234
- ```
1235
- **Help command**
1236
- This command shows the help information for `restart-dx-core` command usage:
1237
- ```
1238
- dxclient restart-dx-core -h
1239
- ```
1240
- **Command options**
1241
- ```
1242
- -hostname <value>
1243
- Use this attribute to specify the hostname of the target server
1244
- -dxUsername <value>
1245
- Use this attribute to specify the username that is required for authenticating with the DX Core
1246
- -dxPassword <value>
1247
- Use this attribute to specify the password that is required for authenticating with the DX Core
1248
- -dxConnectPort <value>
1249
- Use this attribute to specify the port number of the cw_profile
1250
- -dxConnectUsername <value>
1251
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1252
- -dxConnectPassword <value>
1253
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1254
- -dxProfileName <Profile name of the DX core server>
1255
- Use this attribute to specify the profile name of the DX Core server
1256
- -dxProfilePath <Profile path of the DX core server>
1257
- Use this attribute to specify the profile path of the DX Core server
1258
-
1259
- Optional arguments:
1260
- -requestId <Unique Id of a previously triggered restart request>
1261
- Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1262
-
1263
- ```
1264
- Example Usage with dxProfileName:
1265
- ```
1266
- 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>
1267
- ```
1268
- Example Usage with dxProfilePath:
1269
- ```
1270
- 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>
1271
- ```
1272
-
1273
- ### 13. Manage Syndicator
1274
-
1275
- manage-syndicator command is used to enable/disable syndicator in the target server.
1276
-
1277
- Commands Description
1278
- ```
1279
- dxclient manage-syndicator
1280
- This command invokes the manage-syndicator tool inside the DXClient. The manage-syndicator dxtool is used to enable/disable syndicator.
1281
- ```
1282
- **Help command**
1283
- This command shows the help information for `manage-syndicator` command usage:
1284
- ```
1285
- dxclient manage-syndicator -h
1286
- ```
1287
- **Command options**
1288
- ```
1289
- -hostname <value>
1290
- Use this attribute to specify the hostname of the target server
1291
- -dxProtocol <value>
1292
- Use this attribute to specify the protocol with which to connect to the server
1293
- -dxPort <value>
1294
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1295
- -dxUsername <value>
1296
- Use this attribute to specify the username that is required for authenticating with the server
1297
- -dxPassword <value>
1298
- Use this attribute to specify the password that is required for authenticating with the server
1299
- -contenthandlerPath <value>
1300
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1301
- -UUID <value>
1302
- Use this attribute to specify the UUID of the syndicator instance
1303
- -enable <value>
1304
- 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
1305
-
1306
- ```
1307
- Example Usage:
1308
- ```
1309
- dxclient manage-syndicator -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>
1310
- ```
1311
-
1312
- ### 14. Manage Subscriber
1313
-
1314
- manage-subscriber command is used to enable/disable subscriber in the target server.
1315
-
1316
- Commands Description
1317
- ```
1318
- dxclient manage-subscriber
1319
- This command invokes the manage-subscriber tool inside the DXClient. The manage-subscriber dxtool is used to enable/disable subscriber.
1320
- ```
1321
- **Help command**
1322
- This command shows the help information for `manage-subscriber` command usage:
1323
- ```
1324
- dxclient manage-subscriber -h
1325
- ```
1326
- **Command options**
1327
- ```
1328
- -hostname <value>
1329
- Use this attribute to specify the hostname of the target server
1330
- -dxProtocol <value>
1331
- Use this attribute to specify the protocol with which to connect to the server
1332
- -dxPort <value>
1333
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1334
- -dxUsername <value>
1335
- Use this attribute to specify the username that is required for authenticating with the server
1336
- -dxPassword <value>
1337
- Use this attribute to specify the password that is required for authenticating with the server
1338
- -contenthandlerPath <value>
1339
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1340
- -UUID <value>
1341
- Use this attribute to specify the UUID of the subscriber instance
1342
- -enable <value>
1343
- 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
1344
-
1345
- ```
1346
- Example Usage:
1347
- ```
1348
- dxclient manage-subscriber -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID> -enable <enable>
1349
- ```
1350
-
1351
- ### 15. Manage-syndicator get-syndication-report
1352
-
1353
- Manage-syndicator get-syndication-report command is used to fetch the syndicator failed reports.
1354
-
1355
- Commands Description
1356
- ```
1357
- dxclient manage-syndicator get-syndication-report
1358
- 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.
1359
- ```
1360
- **Help command**
1361
- This command shows the help information for `manage-syndicator get-syndication-report` command usage:
1362
- ```
1363
- dxclient manage-syndicator get-syndication-report -h
1364
- ```
1365
- **Command options**
1366
- ```
1367
- -hostname <value>
1368
- Use this attribute to specify the hostname of the target server
1369
- -dxProtocol <value>
1370
- Use this attribute to specify the protocol with which to connect to the server
1371
- -dxPort <value>
1372
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1373
- -dxUsername <value>
1374
- Use this attribute to specify the username that is required for authenticating with the server
1375
- -dxPassword <value>
1376
- Use this attribute to specify the password that is required for authenticating with the server
1377
- -contenthandlerPath <value>
1378
- Use this attribute to specify the path to the contenthandler servlet on the DX server (e.g. /wps/mycontenthandler)
1379
- -UUID <value>
1380
- Use this attribute to specify the UUID of the syndicator instance
1381
-
1382
- ```
1383
- Example Usage with UUID:
1384
- ```
1385
- dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath> -UUID <UUID>
1386
- ```
1387
- Example Usage without UUID:
1388
- ```
1389
- dxclient manage-syndicator get-syndication-report -dxProtocol <dxProtocol> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -contenthandlerPath <contenthandlerPath>
1390
- ```
1391
-
1392
- ### 16. Shared Library
1393
-
1394
- shared-library command is used to manage files in the shared library. The sub-command upload is used to `upload` jar files and sub-command `delete` is used to delete the files from the default shared library location provided below.
1395
- Default shared Library: DXCLib
1396
- Default shared library location: <dx-profile>/PortalServer/sharedLibrary
1397
-
1398
- Commands Description
1399
- ```
1400
- dxclient shared-library upload
1401
- This command invokes the shared library upload task inside the DXClient. This is used to upload jar files into the default shared library location.
1402
- ```
1403
- ```
1404
- dxclient shared-library delete
1405
- This command invokes the shared library delete task inside the DXClient. This is used to delete jar files from the default shared library location.
1406
- ```
1407
- **Help command**
1408
- This command shows the help information for `shared-library upload` command usage:
1409
- ```
1410
- dxclient shared-library upload -h
1411
- ```
1412
- This command shows the help information for `shared-library delete` command usage:
1413
- ```
1414
- dxclient shared-library delete -h
1415
- ```
1416
- **Command options**
1417
- ```
1418
- -hostname <value>
1419
- Use this attribute to specify the hostname of the target server
1420
- -dxConnectPort <value>
1421
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1422
- -dxConnectUsername <value>
1423
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1424
- -dxConnectPassword <value>
1425
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1426
- -dxProfileName <Profile name of the DX core server>
1427
- Use this attribute to specify the profile name of the DX Core server
1428
-
1429
- Command option for Upload
1430
- -libFilePath <value>
1431
- Use this attribute to specify the path to a jar/zip file or folder containing jars in it.
1432
-
1433
- Command option for Delete
1434
- -libFileNames <value>
1435
- Use this attribute to specify the names of the jar files present in the shared library location on the server (e.g. "abc.jar,sample.jar,test.jar")
1436
-
1437
- **Note:** Mandatory parameter libFilePath should be passed into the command line.
1438
- For upload, The folder/zip should contain only jars files that are to be uploaded to the default shared library location
1439
-
1440
- ```
1441
- Example Usage:
1442
- ```
1443
- dxclient shared-library upload -hostname <host-name> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -libFilePath <path to jar/zip/Folder>
1444
-
1445
- dxclient shared-library delete -hostname <host-name> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -libFileNames <file names>
1446
- ```
1447
-
1448
- ### 17. Delete DAM schema
1449
-
1450
- Delete-dam-schema command is used to delete inactive DAM schema from persistence.
1451
-
1452
- Commands Description
1453
- ```
1454
- dxclient delete-dam-schema
1455
- ```
1456
- **Help command**
1457
- This command shows the help information for `delete-dam-schema` command usage:
1458
- ```
1459
- dxclient delete-dam-schema -h
1460
- ```
1461
- **Command options**
1462
- ```
1463
- -dxProtocol <value>
1464
- Use this attribute to specify the protocol with which to connect to the server
1465
- -hostname <value>
1466
- Use this attribute to specify the hostname of the target server
1467
- -dxUsername <value>
1468
- Use this attribute to specify the username that is required for authenticating with the server
1469
- -dxPassword <value>
1470
- Use this attribute to specify the password that is required for authenticating with the server
1471
- -damAPIPort <value>
1472
- Use this attribute to specify the port number of the DAM server(for Kubernetes Environment default port is 443 )
1473
- -ringAPIPort <value>
1474
- Use this attribute to specify the port number of the DX Core API server(for Kubernetes Environment default port is 443 )
1475
- -damAPIVersion <value>
1476
- Use this attribute to specify the API Version number of DAM(for Kubernetes Environment default port is 443 )
1477
- -ringAPIVersion <value>
1478
- Use this attribute to specify the API Version number of DX Core(for Kubernetes Environment default port is 443 )
1479
- -schemaVersion <value>
1480
- Use this attribute to specify the DAM Schema Version(for Kubernetes Environment default port is 443 )
1481
- Note : In case if the user do not enter the schemaVersion, it will prompt the user with a list of inactive schemas to select from and proceed forward.
1482
- ```
1483
-
1484
- Example Usage:
1485
- ```
1486
- dxclient delete-dam-schema -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -ringAPIVersion <ringAPIVersion> -damAPIVersion <damAPIVersion> -schemaVersion <schemaVersion>
1487
- ```
1488
-
1489
- ### 18. List DAM schema
1490
-
1491
- list-dam-schemas command is used to list of all DAM schema.
1492
-
1493
- Commands Description
1494
- ```
1495
- dxclient list-dam-schemas
1496
- ```
1497
- **Help command**
1498
- This command shows the help information for `list-dam-schemas` command usage:
1499
- ```
1500
- dxclient list-dam-schemas -h
1501
- ```
1502
- **Command options**
1503
- ```
1504
- -dxProtocol <value>
1505
- Use this attribute to specify the protocol with which to connect to the server
1506
- -hostname <value>
1507
- Use this attribute to specify the hostname of the target server
1508
- -dxUsername <value>
1509
- Use this attribute to specify the username that is required for authenticating with the server
1510
- -dxPassword <value>
1511
- Use this attribute to specify the password that is required for authenticating with the server
1512
- -damAPIPort <value>
1513
- Use this attribute to specify the port number of the DAM server(for Kubernetes Environment default port is 443 )
1514
- -ringAPIPort <value>
1515
- Use this attribute to specify the port number of the DX Core API server(for Kubernetes Environment default port is 443 )
1516
- -damAPIVersion <value>
1517
- Use this attribute to specify the API Version number of DAM(for Kubernetes Environment default port is 443 )
1518
- -ringAPIVersion <value>
1519
- Use this attribute to specify the API Version number of DX Core(for Kubernetes Environment default port is 443 )
1520
- ```
1521
-
1522
- Example Usage:
1523
- ```
1524
- dxclient list-dam-schemas -dxProtocol <dxProtocol> -hostname <hostname> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -ringAPIVersion <ringAPIVersion> -damAPIVersion <damAPIVersion>
1525
- ```
1526
-
1527
- ### 19. PZN Export
1528
-
1529
- The `pzn-export` command is used to export the rules from the source server to a user-specified location.
1530
-
1531
- Command Description:
1532
- ```
1533
- dxclient pzn-export
1534
- ```
1535
- **Help command:**
1536
- This command shows the help information for `pzn-export` command usage:
1537
- ```
1538
- dxclient pzn-export -h
1539
- ```
1540
- **Command options:**
1541
- ```
1542
- -dxProtocol <value>
1543
- Use this attribute to specify the protocol with which to connect to the DX server
1544
-
1545
- -hostname <value>
1546
- Use this attribute to specify the hostname of the target DX server
1547
-
1548
- -dxPort <value>
1549
- Use this attribute to specify the port on which to connect to the DX server ,for Kubernetes Environment dxPort is 443
1550
-
1551
- -dxUsername <value>
1552
- Use this attribute to specify the username to authenticate with the DX server
1553
-
1554
- -dxPassword <value>
1555
- Use this attribute to specify the password for the user in the "dxUsername" attribute
1556
-
1557
- -targetPath <value>
1558
- Use this attribute to specify the rule or folder containing the rules in the target workspace (default targetPath is '/'), which is the parent for the published nodes. The target path must exist before publishing
1559
-
1560
- -targetWorkspace <value>
1561
- Use this attribute to specify the name of the workspace containing the rules in DX server (default targetWorkspace is 'ROOTWORKSPACE')
1562
-
1563
- -dxContextRoot <value>
1564
- Use this attribute to specify the path to the context root on the DX server (e.g. /wps):
1565
-
1566
- ```
1567
- **Note:** targetPath and targetWorkspace are optional parameters. If the user does not pass the respective parameters then the default value will be taken.
1568
-
1569
- Example usage:
1570
-
1571
- ```
1572
- dxclient pzn-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxContextRoot <dxContextRoot>
1573
-
1574
- The outputfile for pzn export will be generated inside store/outputFiles/pznrules
1575
- ```
1576
-
1577
- ### 20. PZN Import
1578
-
1579
- The `pzn-import` command is used to import the rules from the source server into the target server.
1580
-
1581
- Command Description:
1582
- ```
1583
- dxclient pzn-import
1584
- ```
1585
- **Help command:**
1586
- This command shows the help information for `pzn-import` command usage:
1587
- ```
1588
- dxclient pzn-import -h
1589
- ```
1590
- **Required files**
1591
- ```
1592
- Rules file: This file should contain the configuration XML representation of all the currently selected personalization objects.
1593
- ```
1594
- **Command options:**
1595
- ```
1596
- -dxProtocol <value>
1597
- Use this attribute to specify the protocol with which to connect to the DX server
1598
-
1599
- -hostname <value>
1600
- Use this attribute to specify the hostname of the target DX server
1601
-
1602
- -dxPort <value>
1603
- Use this attribute to specify the port on which to connect to the DX server ,for Kubernetes Environment dxPort is 443
1604
-
1605
- -dxUsername <value>
1606
- Use this attribute to specify the username to authenticate with the DX server
1607
-
1608
- -dxPassword <value>
1609
- Use this attribute to specify the password for the user in the "dxUsername" attribute
1610
-
1611
- -dxConnectUsername <value>
1612
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1613
-
1614
- -dxConnectPassword <value>
1615
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1616
-
1617
- -dxConnectPort <value>
1618
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1619
-
1620
- -rulesFilePath <Absolute or relative path to import nodes file>
1621
- Use this attribute to specify the path to the file containing the rules to be imported
1622
-
1623
- -targetPath <value>
1624
- Use this attribute to specify the rule or folder containing the rules in the target workspace (default targetPath is '/'), which is the parent for the published nodes. The target path must exist before publishing
1625
-
1626
- -targetWorkspace <value>
1627
- Use this attribute to specify the name of the workspace containing the rules in DX server (default targetWorkspace is 'ROOTWORKSPACE')
1628
-
1629
- -dxContextRoot <value>
1630
- Use this attribute to specify the path to the context root on the DX server (e.g. /wps):
1631
-
1632
- ```
1633
- **Note:** dxProtocol, hostname, dxPort, targetWorkspace and targetPath are optional parameters. If the user does not pass the respective parameters then the default value will be taken.
1634
-
1635
- Example usage:
1636
- ```
1637
- dxclient pzn-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -rulesFilePath <rulesFilePath> -dxContextRoot <dxContextRoot>
1638
- ```
1639
-
1640
- ### 21. Resource Environment Provider
1641
-
1642
- The `resource-env-provider` command is used to create, update, delete, export or import custom properties from an existing Resource Environment Provider.
1643
-
1644
- Commands Description:
1645
- ```
1646
- dxclient resource-env-provider
1647
- ```
1648
- **Help command:**
1649
- This command shows the help information for `resource-env-provider` command usage:
1650
- ```
1651
- dxclient resource-env-provider -h
1652
- ```
1653
-
1654
- ```
1655
- dxclient resource-env-provider create-property -h
1656
- dxclient resource-env-provider update-property -h
1657
- dxclient resource-env-provider delete-property -h
1658
- dxclient resource-env-provider export-properties -h
1659
- dxclient resource-env-provider import-properties -h
1660
- dxclient resource-env-provider retrieve-property -h
1661
- ```
1662
-
1663
- **Commands**
1664
- ```
1665
- resource-env-provider create-property [OPTIONS]
1666
- Create a custom property from an existing Resource Environment Provider
1667
-
1668
- resource-env-provider update-property [OPTIONS]
1669
- Update a custom property from an existing Resource Environment Provider
1670
-
1671
- resource-env-provider delete-property [OPTIONS]
1672
- Delete a custom property from an existing Resource Environment Provider
1673
-
1674
- resource-env-provider export-properties [OPTIONS]
1675
- Export all the existing Resource Environment Provider
1676
-
1677
- resource-env-provider import-properties [OPTIONS]
1678
- Import all the existing Resource Environment Provider
1679
-
1680
- resource-env-provider retrieve-property [OPTIONS]
1681
- Retrieve a property from an existing Resource Environment Provider
1682
- ```
1683
-
1684
- **Required options for create, update or delete property Command options**
1685
- ```
1686
- -dxProtocol <value>
1687
- Use this attribute to specify the protocol with which to connect to the server
1688
-
1689
- -hostname <value>
1690
- Use this attribute to specify the hostname of the target server
1691
-
1692
- -dxPort <value>
1693
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1694
-
1695
- -dxUsername <value>
1696
- Use this attribute to specify the username that is required for authenticating with the server
1697
-
1698
- -dxPassword <value>
1699
- Use this attribute to specify the password that is required for authenticating with the server
1700
-
1701
- -dxConnectPort <value>
1702
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1703
-
1704
- -dxConnectUsername <value>
1705
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1706
-
1707
- -dxConnectPassword <value>
1708
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1709
-
1710
- -providerName <value>
1711
- Use this attribute to specify the name of the Resource Environment Provider
1712
-
1713
- -propertyName <value>
1714
- Use this attribute to specify the name of the Custom Property
1715
-
1716
- -propertyValue <value>
1717
- Use this attribute to specify the value of the Custom Property
1718
-
1719
- -propertyDesc <value>
1720
- Use this attribute to specify the description of the Custom Property
1721
- ```
1722
-
1723
- **Required options for export properties Command options**
1724
- ```
1725
- -dxProtocol <value>
1726
- Use this attribute to specify the protocol with which to connect to the server
1727
-
1728
- -hostname <value>
1729
- Use this attribute to specify the hostname of the target server
1730
-
1731
- -dxConnectPort <value>
1732
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1733
-
1734
- -dxConnectUsername <value>
1735
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1736
-
1737
- -dxConnectPassword <value>
1738
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1739
-
1740
- -dxWASUsername <value>
1741
- Use this attribute to specify the username of the DX WAS server
1742
-
1743
- -dxWASPassword <value>
1744
- Use this attribute to specify the password of the DX WAS server
1745
-
1746
- -dxProfileName <Profile name of the DX core server>
1747
- Use this attribute to specify the profile name of the DX core server
1748
- ```
1749
-
1750
- **Required options for import properties Command options**
1751
- ```
1752
- -dxProtocol <value>
1753
- Use this attribute to specify the protocol with which to connect to the server
1754
-
1755
- -hostname <value>
1756
- Use this attribute to specify the hostname of the target server
1757
-
1758
- -dxConnectPort <value>
1759
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1760
-
1761
- -dxConnectUsername <value>
1762
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1763
-
1764
- -dxConnectPassword <value>
1765
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1766
-
1767
- -dxWASUsername <value>
1768
- Use this attribute to specify the username of the DX WAS server
1769
-
1770
- -dxWASPassword <value>
1771
- Use this attribute to specify the password of the DX WAS server
1772
-
1773
- -dxProfileName <Profile name of the DX core server>
1774
- Use this attribute to specify the profile name of the DX core server
1775
-
1776
- -filePath <value>
1777
- Use this attribute to specify the File path of the import Resource Environment Provider files.
1778
- ```
1779
-
1780
- Example Usage:
1781
- ```
1782
- dxclient resource-env-provider create-property -providerName <providerName> -propertyName <propertyName> -propertyValue <propertyValue>
1783
-
1784
- dxclient resource-env-provider update-property -providerName <providerName> -propertyName <propertyName> -propertyValue <modifiedpropertyValue>
1785
-
1786
- dxclient resource-env-provider delete-property -providerName <providerName> -propertyName <propertyName> -propertyValue <modifiedpropertyValue>
1787
-
1788
- dxclient resource-env-provider export-properties -dxProfileName <dxProfileName>
1789
-
1790
- dxclient resource-env-provider import-properties -dxProfileName <dxProfileName> -filePath <filePath>
1791
-
1792
- dxclient resource-env-provider retrieve-property -providerName <providerName> -propertyName <propertyName>
1793
- ```
1794
-
1795
- ### 22. Manage virtual Portal
1796
-
1797
- The `manage-virtual-portal` command is used to create, list ,export and import of virtual portal in the DX server.
1798
-
1799
- Commands Description
1800
- ```
1801
- dxclient manage-virtual-portal
1802
- ```
1803
- **Help command**
1804
- This command shows the help document on the `manage-virtual-portal` command:
1805
- ```
1806
- dxclient manage-virtual-portal create -h
1807
-
1808
- dxclient manage-virtual-portal list -h
1809
-
1810
- dxclient manage-virtual-portal import -h
1811
-
1812
- dxclient manage-virtual-portal export -h
1813
- ```
1814
-
1815
- **Commands**
1816
- ```
1817
- manage-virtual-portal create [OPTIONS]
1818
- Create virtual portal task in the DX server
1819
-
1820
- manage-virtual-portal list [OPTIONS]
1821
- List virtual portal task in the DX server
1822
-
1823
- manage-virtual-portal import [OPTIONS]
1824
- Import virtual portal task in the DX server
1825
-
1826
- manage-virtual-portal export [OPTIONS]
1827
- Export virtual portal task in the DX server
1828
- ```
1829
-
1830
- **Required options - `manage-virtual-portal create` command**
1831
- ```
1832
- -dxUsername <value>
1833
- Use this attribute to specify the username that is required for authenticating with the server
1834
-
1835
- -dxPassword <value>
1836
- Use this attribute to specify the password that is required for authenticating with the server
1837
-
1838
- -hostname <value>
1839
- Use this attribute to specify the hostname of the target server
1840
-
1841
- -dxConnectPort <value>
1842
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1843
-
1844
- -dxConnectUsername <value>
1845
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1846
-
1847
- -dxConnectPassword <value>
1848
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1849
-
1850
- -dxProfileName <Profile name of the DX core server>
1851
- Use this attribute to specify the profile name of the DX core server
1852
-
1853
- -dxWASUsername <value>
1854
- Use this attribute to specify the username of the DX WAS server
1855
-
1856
- -dxWASPassword <value>
1857
- Use this attribute to specify the password of the DX WAS server
1858
-
1859
- -vpTitle <value>
1860
- Use this attribute to specify the virtual portal Title
1861
-
1862
- -vpRealm <value>
1863
- Use this attribute to specify the virtual portal Realm
1864
-
1865
- -vpAdminGroup <value>
1866
- Use this attribute to specify the virtual portal AdminGroup
1867
-
1868
- -vpHostname <value>
1869
- Use this attribute to specify the virtual portal Hostname
1870
-
1871
- -vpContext <value>
1872
- Use this attribute to specify the virtual portal Context
1873
-
1874
- Optional arguments:
1875
- -requestId <Unique Id of a previously triggered create virtual portal request>
1876
- Use this attribute and retrigger the command to check the status of any previous request that was incomplete.
1877
- ```
1878
-
1879
- Example Usage:
1880
- ```
1881
- dxclient manage-virtual-portal create -hostname <hostname> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX Server> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxWASUsername < Username of the DX WAS server> -dxWASPassword <Password of the DX WAS server> -vpTitle <virtual-portal-Title> -vpRealm <virtual-portal-realm> -vpAdminGroup <virtual-portal-adminGroup> -vpHostname <virtual-portal-hostname> -vpContext <virtual-portal-context>
1882
- ```
1883
-
1884
- **Required options - `manage-virtual-portal list` command**
1885
- ```
1886
- -dxUsername <value>
1887
- Use this attribute to specify the username that is required for authenticating with the server
1888
-
1889
- -dxPassword <value>
1890
- Use this attribute to specify the password that is required for authenticating with the server
1891
-
1892
- -hostname <value>
1893
- Use this attribute to specify the hostname of the target server
1894
-
1895
- -dxConnectPort <value>
1896
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
1897
-
1898
- -dxConnectUsername <value>
1899
- Use this attribute to specify the username that is required for authenticating to the cw_profile
1900
-
1901
- -dxConnectPassword <value>
1902
- Use this attribute to specify the password that is required for authenticating to the cw_profile
1903
-
1904
- -dxProfileName <Profile name of the DX core server>
1905
- Use this attribute to specify the profile name of the DX core server
1906
-
1907
- -dxWASUsername <value>
1908
- Use this attribute to specify the username of the DX WAS server
1909
-
1910
- -dxWASPassword <value>
1911
- Use this attribute to specify the password of the DX WAS server
1912
- ```
1913
-
1914
- Example Usage:
1915
- ```
1916
- dxclient manage-virtual-portal list -hostname <hostname> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <profile-name-of-the-DX-server> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxWASUsername <username-of-the-DX-WAS-server> -dxWASPassword <password-of-the-DX-WAS-server>
1917
- ```
1918
-
1919
- **Required options - `manage-virtual-portal import` command**
1920
- ```
1921
- -dxProtocol <value>
1922
- Use this attribute to specify the protocol with which to connect to the server
1923
-
1924
- -dxUsername <value>
1925
- Use this attribute to specify the username that is required for authenticating with the server
1926
-
1927
- -dxPassword <value>
1928
- Use this attribute to specify the password that is required for authenticating with the server
1929
-
1930
- -hostname <value>
1931
- Use this attribute to specify the hostname of the target server
1932
-
1933
- -dxPort <value>
1934
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1935
-
1936
- -xmlConfigPath <value>
1937
- Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config)
1938
-
1939
- -xmlFile <value>
1940
- Use this attribute to specify the xml file name with absolute path of the input file
1941
-
1942
- -vpContext <value>
1943
- Use this attribute to specify the virtual portal Context
1944
- ```
1945
-
1946
- Example Usage:
1947
- ```
1948
- dxclient manage-virtual-portal import -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -xmlConfigPath <xmlConfigPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlFile <xml-file-with-path> -vpContext <virtual-portal-context>
1949
- ```
1950
-
1951
- **Required options - `manage-virtual-portal export` command**
1952
- ```
1953
- -dxProtocol <value>
1954
- Use this attribute to specify the protocol with which to connect to the server
1955
-
1956
- -dxUsername <value>
1957
- Use this attribute to specify the username that is required for authenticating with the server
1958
-
1959
- -dxPassword <value>
1960
- Use this attribute to specify the password that is required for authenticating with the server
1961
-
1962
- -hostname <value>
1963
- Use this attribute to specify the hostname of the target server
1964
-
1965
- -dxPort <value>
1966
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
1967
-
1968
- -xmlConfigPath <value>
1969
- Use this attribute to specify the path to DX configuration endpoint (e.g. /wps/config)
1970
-
1971
- -vpContext <value>
1972
- Use this attribute to specify the virtual portal Context
1973
-
1974
- -vpTitle <value>
1975
- Use this attribute to specify the virtual portal Title
1976
-
1977
- -xmlFile <value>
1978
- Use this attribute to specify the xml file name with absolute path of the input file to export the virtual portal content.
1979
- ```
1980
- **Note:** Currently export virtual portal supports only vpContext and does not support vpHostname. Support for Virtual portal with hostname can be added in future release.
1981
-
1982
- Example Usage:
1983
- ```
1984
- dxclient manage-virtual-portal export -hostname <hostname> -dxProtocol <dxProtocol> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -vpTitle <vpTitle> -vpContext <vpContext>
1985
- ```
1986
-
1987
- ### 23. Manage dam staging subscriber register
1988
-
1989
- manage-dam-staging register-dam-subscriber command is used to register the subscriber for dam staging.
1990
-
1991
- Commands Description
1992
- ```
1993
- dxclient manage-dam-staging register-dam-subscriber
1994
- ```
1995
- **Help command**
1996
- This command shows the help information for `manage-dam-staging register-dam-subscriber` command usage:
1997
- ```
1998
- dxclient manage-dam-staging register-dam-subscriber -h
1999
- ```
2000
- **Command options**
2001
- ```
2002
- -dxProtocol, --dxProtocol <value>
2003
- Protocol of the DX server of the publisher (default: "")
2004
-
2005
- -hostname, --hostname <value>
2006
- Host name of the DX server of the publisher (default: "")
2007
-
2008
- -dxPort, --dxPort <value>
2009
- Port number of the DX server of the publisher (default: "")
2010
-
2011
- -dxUsername, --dxUsername <value>
2012
- Username of the DX server of the publisher (default: "")
2013
-
2014
- -dxPassword, --dxPassword <value>
2015
- Password of the DX server of the publisher (default: "")
2016
-
2017
- -targetServerUsername, --targetServerUsername <value>
2018
- Username of the DX server of the subscriber (default: "")
2019
-
2020
- -targetServerPassword, --targetServerPassword <value>
2021
- Password of the DX server of the subscriber (default: "")
2022
-
2023
- -damAPIPort, --damAPIPort <value>
2024
- Port number of the DAM API server of the publisher (default: "")
2025
-
2026
- -ringAPIPort, --ringAPIPort <value>
2027
- Port number of the DX Core API server of the publisher (default: "")
2028
-
2029
- -damAPIVersion, --damAPIVersion <value>
2030
- API Version number of DAM API server of the publisher (default: "")
2031
-
2032
- -ringAPIVersion, --ringAPIVersion <value>
2033
- API Version number of DX Core API server of the publisher (default: "")
2034
-
2035
- -targetHostname, --targetHostname <value>
2036
- Host name of the target environment of the subscriber
2037
-
2038
- -interval,--interval <value>
2039
- Interval between two sync cycles. The unit of interval is minute. Default value of interval is 2 minutes.
2040
- ```
2041
- Example usage:
2042
-
2043
- ```
2044
- dxclient manage-dam-staging register-dam-subscriber -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -targetServerUsername <targetServerUsername> -targetServerPassword <targetServerPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname> -interval <interval>
2045
-
2046
- ```
2047
-
2048
- 24. Manage dam staging update secrets
2049
-
2050
- manage-dam-staging update-secrets command is used to update publisher & subscriber secrets for dam staging.
2051
-
2052
- Commands Description
2053
- ```
2054
- dxclient manage-dam-staging update-secrets
2055
- ```
2056
- **Help command**
2057
- This command shows the help information for `manage-dam-staging update-secrets` command usage:
2058
- ```
2059
- dxclient manage-dam-staging update-secrets -h
2060
- ```
2061
- **Command options**
2062
- ```
2063
- -dxProtocol, --dxProtocol <value>
2064
- Protocol of the DX server of the publisher (default: "")
2065
-
2066
- -hostname, --hostname <value>
2067
- Host name of the DX server of the publisher (default: "")
2068
-
2069
- -dxPort, --dxPort <value>
2070
- Port number of the DX server of the publisher (default: "")
2071
-
2072
- -dxUsername, --dxUsername <value>
2073
- Username of the DX server of the publisher (default: "")
2074
-
2075
- -dxPassword, --dxPassword <value>
2076
- Password of the DX server of the publisher (default: "")
2077
-
2078
- -targetServerUsername, --targetServerUsername <value>
2079
- Username of the DX server of the subscriber (default: "")
2080
-
2081
- -targetServerPassword, --targetServerPassword <value>
2082
- Password of the DX server of the subscriber (default: "")
2083
-
2084
- -damAPIPort, --damAPIPort <value>
2085
- Port number of the DAM API server of the publisher (default: "")
2086
-
2087
- -ringAPIPort, --ringAPIPort <value>
2088
- Port number of the DX Core API server of the publisher (default: "")
2089
-
2090
- -damAPIVersion, --damAPIVersion <value>
2091
- API Version number of DAM API server of the publisher (default: "")
2092
-
2093
- -ringAPIVersion, --ringAPIVersion <value>
2094
- API Version number of DX Core API server of the publisher (default: "")
2095
-
2096
- -targetHostname, --targetHostname <value>
2097
- Host name of the target environment of the subscriber
2098
-
2099
- -interval,--interval <value>
2100
- Interval between two sync cycles. The unit of interval is minute. Default value of interval is 2 minutes.
2101
- ```
2102
- Example usage:
2103
- ```
2104
- dxclient manage-dam-staging update-secrets -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -targetServerUsername <targetServerUsername> -targetServerPassword <targetServerPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname> -interval <interval>
2105
- ```
2106
-
2107
- ### 25. Manage dam staging trigger
2108
-
2109
- manage-dam-staging trigger-staging command is used to trigger the DAM staging.
2110
-
2111
- Commands Description
2112
- ```
2113
- dxclient manage-dam-staging trigger-staging
2114
- ```
2115
- **Help command**
2116
- This command shows the help information for `manage-dam-staging trigger-staging` command usage:
2117
- ```
2118
- dxclient manage-dam-staging trigger-staging -h
2119
- ```
2120
- **Command options**
2121
- ```
2122
- -dxProtocol, --dxProtocol <value>
2123
- Protocol of the DX server of the publisher (default: "")
2124
-
2125
- -hostname, --hostname <value>
2126
- Host name of the DX server of the publisher (default: "")
2127
-
2128
- -dxPort, --dxPort <value>
2129
- Port number of the DX server of the publisher (default: "")
2130
-
2131
- -dxUsername, --dxUsername <value>
2132
- Username of the DX server of the publisher (default: "")
2133
-
2134
- -dxPassword, --dxPassword <value>
2135
- Password of the DX server of the publisher (default: "")
2136
-
2137
- -damAPIPort, --damAPIPort <value>
2138
- Port number of the DAM API server of the publisher (default: "")
2139
-
2140
- -ringAPIPort, --ringAPIPort <value>
2141
- Port number of the DX Core API server of the publisher (default: "")
2142
-
2143
- -damAPIVersion, --damAPIVersion <value>
2144
- API Version number of DAM API server of the publisher (default: "")
2145
-
2146
- -ringAPIVersion, --ringAPIVersion <value>
2147
- API Version number of DX Core API server of the publisher (default: "")
2148
-
2149
- -targetHostname, --targetHostname <value>
2150
- Host name of the target environment of the subscriber
2151
- ```
2152
- Example usage:
2153
-
2154
- ```
2155
- dxclient manage-dam-staging trigger-staging -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -targetHostname <targetHostname>
2156
-
2157
- ```
2158
-
2159
- ### 26. Manage dam staging subscriber deregister
2160
-
2161
- manage-dam-staging deregister-dam-subscriber command is used to deregister subscriber.
2162
-
2163
- Commands Description
2164
- ```
2165
- dxclient manage-dam-staging deregister-dam-subscriber
2166
- ```
2167
- **Help command**
2168
- This command shows the help information for `manage-dam-staging deregister-dam-subscriber` command usage:
2169
- ```
2170
- dxclient manage-dam-staging deregister-dam-subscriber -h
2171
- ```
2172
- **Command options**
2173
- ```
2174
- -dxProtocol, --dxProtocol <value>
2175
- Protocol of the DX server of the publisher (default: "")
2176
-
2177
- -hostname, --hostname <value>
2178
- Host name of the DX server of the publisher (default: "")
2179
-
2180
- -dxPort, --dxPort <value>
2181
- Port number of the DX server of the publisher (default: "")
2182
-
2183
- -dxUsername, --dxUsername <value>
2184
- Username of the DX server of the publisher (default: "")
2185
-
2186
- -dxPassword, --dxPassword <value>
2187
- Password of the DX server of the publisher (default: "")
2188
-
2189
- -damAPIPort, --damAPIPort <value>
2190
- Port number of the DAM API server of the publisher (default: "")
2191
-
2192
- -ringAPIPort, --ringAPIPort <value>
2193
- Port number of the DX Core API server of the publisher (default: "")
2194
-
2195
- -damAPIVersion, --damAPIVersion <value>
2196
- API Version number of DAM API server of the publisher (default: "")
2197
-
2198
- -ringAPIVersion, --ringAPIVersion <value>
2199
- API Version number of DX Core API server of the publisher (default: "")
2200
-
2201
- -subscriberId, --subscriberId <value>
2202
- Subscriber id of the target environment of the subscriber
2203
- ```
2204
- Example usage:
2205
-
2206
- ```
2207
- dxclient manage-dam-staging deregister-dam-subscriber -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
2208
-
2209
- ```
2210
-
2211
- ### 27. Create syndication relation
2212
-
2213
- Create syndication relation command is used to create the relation between syndicator and subscriber in DX server.
2214
-
2215
- Commands Description
2216
- ```
2217
- dxclient create-syndication-relation
2218
- ```
2219
- **Help command**
2220
- This command shows the help information for `create-syndication-relation` command usage:
2221
- ```
2222
- dxclient create-syndication-relation -h
2223
- ```
2224
- **Command options**
2225
- ```
2226
- -dxProtocol, --dxProtocol <value>
2227
- Protocol of the DX server (default: "")
2228
-
2229
- -hostname, --hostname <value>
2230
- Host name of the DX server (default: "")
2231
-
2232
- -dxPort, --dxPort <value>
2233
- Port number of the DX server, for any Kubernetes Environment default port is 443 (default: "")
2234
-
2235
- -contenthandlerPath <value>
2236
- The path to the contenthandler servlet on the Script Application server.
2237
-
2238
- -dxUsername, --dxUsername <value>
2239
- Username of the DX server (default: "")
2240
-
2241
- -dxPassword, --dxPassword <value>
2242
- Password of the DX Core (default: "")
2243
-
2244
- -syndicatorUrl, --syndicatorUrl<value>
2245
- Syndicator URL of target server e.g http(s)://host:port/wps/wcm
2246
-
2247
- -syndicatorName, --syndicatorName <value>
2248
- New syndicator name
2249
-
2250
- -subscriberName, --subscriberName <value>
2251
- New subscriber name
2252
-
2253
- -vaultSlotName, --vaultSlotName <value>
2254
- Credential Vault Name of source server
2255
-
2256
- -isEnabled, --isEnabled <value>
2257
- Whether the syndicator/subscriber pair is enabled on creation: isEnabled (default is true)
2258
-
2259
- -updateAfterCreation, --updateAfterCreation <value>
2260
- Whether the syndicator/subscriber pair is updateAfterCreation : updateAfterCreation (default is true)
2261
-
2262
- -syndicationType, --syndicationType <value>
2263
- The libraries to syndicate eg. all-items,liveItems,liveProjectsItem,all-items,published-items and all-items-and-versions.
2264
- -webContentLibraries, --webContentLibraries <value>
2265
- Libraries Name of target Server
2266
-
2267
- -subscriberURL, --subscriberURL <value>
2268
- Subscriber URL e.g http(s)://host:port/wps/wcm
2269
-
2270
- -mode, --mode <value>
2271
- Syndicator/subscriber mode
2272
-
2273
- -syndicatorVaultSlotName, --syndicatorVaultSlotName <value>
2274
- Credential Vault Name
2275
-
2276
- -dxContextRoot, --dxContextRoot <value>
2277
- Dx context root
2278
-
2279
- -virtualPortalContext, --virtualPortalContext <value>
2280
- Virtual portal Context
2281
-
2282
- ```
2283
- Example usage:
2284
-
2285
- ```
2286
- dxclient create-syndication-relation -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -contenthandlerPath <contenthandlerPath> -dxUsername <dxUsername> -dxPassword <dxPassword> -syndicatorUrl <syndicatorUrl>
2287
- -syndicatorName <syndicatorName> -subscriberName <subscriberName> -vaultSlotName <vaultSlotName>
2288
- -isEnabled <isEnabled> -updateAfterCreation <updateAfterCreation> -syndicationType <syndicationType> -webContentLibraries <webContentLibraries> -subscriberURL <subscriberURL>
2289
- -mode <mode> -syndicatorVaultSlotName <syndicatorVaultSlotName> -dxContextRoot <dxContextRoot>
2290
- -virtualPortalContext <virtualPortalContext>
2291
- ```
2292
-
2293
- ### 28. Create Credential Vault
2294
-
2295
- The `create-credential-vault` command is used to create or update a credential vault slot in the DX server.
2296
-
2297
- Commands Description
2298
- ```
2299
- dxclient create-credential-vault
2300
-
2301
- ```
2302
- **Help command**
2303
- This command shows the help document on the `create-credential-vault` command:
2304
- ```
2305
- dxclient create-credential-vault -h
2306
- ```
2307
- **Commands options**
2308
- ```
2309
- -hostname <value>
2310
- Use this attribute to specify the hostname of the target server
2311
-
2312
- -dxProtocol <value>
2313
- Use this attribute to specify the protocol with which to connect to the server
2314
-
2315
- -dxPort <value>
2316
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2317
-
2318
- -xmlConfigPath <value>
2319
- Use this attribute to specify the path to DX configuration endpoint
2320
-
2321
- -dxUsername <value>
2322
- Use this attribute to specify the username that is required for authenticating with the server
2323
-
2324
- -dxPassword <value>
2325
- Use this attribute to specify the password that is required for authenticating with the server
2326
-
2327
- -credentialSlotName <value>
2328
- Use this attribute to specify the credential vault segment slot name
2329
-
2330
- -vaultUsername <value>
2331
- Use this attribute to specify the credential vault vaultUsername
2332
-
2333
- -vaultUserGroup <value>
2334
- Use this attribute to specify the credential vault UserGroup
2335
-
2336
- -vaultPassword <value>
2337
- Use this attribute to specify the credential vault shared userid password
2338
-
2339
- -vaultSegmentName <value>
2340
- Use this attribute to specify the credential vault segment name and the default is set to "DefaultAdminSegment"
2341
-
2342
- -vaultDescription <value>
2343
- Use this attribute to specify the credential vault segment description
2344
-
2345
- ```
2346
-
2347
- Log files from command execution can be found in the logs directory of the DXClient installation.
2348
-
2349
- Example Usage:
2350
- ```
2351
- dxclient create-credential-vault -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -xmlConfigPath <xmlConfigPath> -credentialSlotName <credentialSlotName> -vaultUsername <vaultUsername> -vaultPassword <vaultPassword>
2352
- ```
2353
-
2354
- ### 29. WCM Libraries Export
2355
-
2356
- The `wcm-library-export` command is used to export the wcm libraries from the source server to a user-specified location.
2357
-
2358
- Commands Description
2359
- ```
2360
- dxclient wcm-library-export
2361
-
2362
- ```
2363
- **Help command**
2364
- This command shows the help document on the `wcm-library-export` command:
2365
- ```
2366
- dxclient wcm-library-export -h
2367
- ```
2368
- **Commands options**
2369
- ```
2370
- -hostname <value>
2371
- Use this attribute to specify the hostname of the target server
2372
-
2373
- -dxUsername <value>
2374
- Use this attribute to specify the username that is required for authenticating with the server
2375
-
2376
- -dxPassword <value>
2377
- Use this attribute to specify the password that is required for authenticating with the server
2378
-
2379
- -dxConnectPort <value>
2380
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2381
-
2382
- -dxConnectUsername <value>
2383
- Use this attribute to specify the username that is required for authenticating to the cw_profile
2384
-
2385
- -dxConnectPassword <value>
2386
- Use this attribute to specify the password that is required for authenticating to the cw_profile
2387
-
2388
- -dxWASUsername <value>
2389
- Use this attribute to specify the username of the DX WAS server
2390
-
2391
- -dxWASPassword <value>
2392
- Use this attribute to specify the password of the DX WAS server
2393
-
2394
- -dxProfileName <Profile name of the DX core server>
2395
- Use this attribute to specify the profile name of the DX core server
2396
-
2397
- -librariesName <value>
2398
- Use this attribute to specify the names of the wcm libraries of the DX core server (e.g. "hello_library,demo_library")
2399
-
2400
- -exportAllLibraries <value>
2401
- Use this attribute to specify the export libraries. This value can be true or false. If true then export the all libraries
2402
-
2403
- -virtualPortalContext <value>
2404
- The context of the virtual portal from which wcm library should be exported.
2405
-
2406
- ```
2407
-
2408
- Log files from command execution can be found in the logs directory of the DXClient installation.
2409
-
2410
- Example Usage:
2411
- ```
2412
- dxclient wcm-library-export -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxWASUsername <dxWASUsername> -dxProfileName <dxProfileName> -librariesName <librariesName>
2413
- ```
2414
-
2415
- ### 30. WCM Libraries Import
2416
-
2417
- The `wcm-library-import` command is used to import the wcm libraries from the source server into the target server.
2418
-
2419
- Commands Description
2420
- ```
2421
- dxclient wcm-library-import
2422
-
2423
- ```
2424
- **Help command**
2425
- This command shows the help document on the `wcm-library-import` command:
2426
-
2427
- ```
2428
- dxclient wcm-library-import -h
2429
- ```
2430
- **Commands options**
2431
- ```
2432
- -hostname <value>
2433
- Use this attribute to specify the hostname of the target server
2434
-
2435
- -dxUsername <value>
2436
- Use this attribute to specify the username that is required for authenticating with the server
2437
-
2438
- -dxPassword <value>
2439
- Use this attribute to specify the password that is required for authenticating with the server
2440
-
2441
- -dxConnectPort <value>
2442
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2443
-
2444
- -dxConnectUsername <value>
2445
- Use this attribute to specify the username that is required for authenticating to the cw_profile
2446
-
2447
- -dxConnectPassword <value>
2448
- Use this attribute to specify the password that is required for authenticating to the cw_profile
2449
-
2450
- -dxWASUsername <value>
2451
- Use this attribute to specify the username of the DX WAS server
2452
-
2453
- -dxWASPassword <value>
2454
- Use this attribute to specify the password of the DX WAS server
2455
-
2456
- -dxProfileName <Profile name of the DX core server>
2457
- Use this attribute to specify the profile name of the DX core server
2458
-
2459
- -libFilePath <value>
2460
- Use this attribute to specify the path to a zip/tar containing wcm libraries in it
2461
-
2462
- -virtualPortalContext <value>
2463
- The context of the virtual portal to which wcm library should be imported.
2464
-
2465
- ```
2466
-
2467
- Log files from command execution can be found in the logs directory of the DXClient installation.
2468
-
2469
- Example Usage:
2470
- ```
2471
- dxclient wcm-library-import -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxWASUsername <dxWASUsername> -dxProfileName <dxProfileName> -libFilePath <libFilePath>
2472
- ```
2473
- ### 31. DX Core Configuration Reports
2474
-
2475
- The `dx-core-configuration-reports` command is used to generate the differential reports on various core configurations between two dx server nodes.
2476
-
2477
- The dx-core-configuration-reports summary-report command shows the summary of the configurations of a single DX server or both source and target DX servers, which users may use to compare.
2478
-
2479
- Command Description:
2480
- ```
2481
- dxclient dx-core-configuration-reports
2482
- ```
2483
- **Help command:**
2484
- This command shows the help information for `dx-core-configuration-reports` command usage:
2485
- ```
2486
- dxclient dx-core-configuration-reports summary-report -h
2487
- ```
2488
- **Commands**
2489
- ```
2490
- dx-core-configuration-report summary-reports [OPTIONS]
2491
- Provides a configurational report with differences for the source or target DX Core Servers.
2492
- ```
2493
- Command options: Summary report command
2494
- ```
2495
- -hostname <value>
2496
- Use this attribute to specify the hostname of the DX Core server
2497
-
2498
- -dxConnectPort <value>
2499
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2500
-
2501
- -dxConnectUsername <value>
2502
- Use this attribute to specify the username that is required for authenticating to the cw_profile
2503
-
2504
- -dxConnectPassword <value>
2505
- Use this attribute to specify the password that is required for authenticating to the cw_profile
2506
-
2507
- -dxProfileName <Profile name of the DX core server>
2508
- Use this attribute to specify the profile name of the DX core server
2509
-
2510
- -targetHostname <value>
2511
- Use this attribute to specify the hostname of the target DX core server
2512
-
2513
- -targetDxConnectPort <value>
2514
- Use this attribute to specify the port number of the target cw_profile server
2515
-
2516
- -targetDxConnectUsername <value>
2517
- Use this attribute to specify the username that is required for authenticating to the target cw_profile server
2518
-
2519
- -targetDxConnectPassword<value>
2520
- Use this attribute to specify the password that is required for authenticating to the target cw_profile server
2521
-
2522
- -targetDxProfileName <Profile name of the DX core server>
2523
- Use this attribute to specify the profile name of the target DX Core server
2524
- ```
2525
-
2526
- ```
2527
- **Note:** target server details are only needed when the user needs to generate the summary of the configurations to both servers.
2528
- ```
2529
-
2530
- Example usage:
2531
- ```
2532
- dxclient dx-core-configuration-reports summary-report -hostname <hostname> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -dxProfileName <dxProfileName> -targetHostname <targetHostname> -targetDxConnectUsername <targetDxConnectUsername> -targetDxConnectPassword <targetDxConnectPassword> -targetDxConnectPort <targetDxConnectPort> -targetDxProfileName <targetDxProfileName>
2533
- ```
2534
-
2535
- ### 32. Export dam assets
2536
-
2537
- The export command is used to export the assets of a dam in the file system at the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2538
-
2539
- Commands Description
2540
- ```
2541
- dxclient manage-dam-assets export-assets
2542
- ```
2543
- **Help command**
2544
- This command shows the help information for `manage-dam-assets` command usage:
2545
- ```
2546
- dxclient manage-dam-assets export-assets -h
2547
- ```
2548
- **Commands options**
2549
- ```
2550
- -dxProtocol <value>
2551
- Use this attribute to specify the protocol with which to connect to the DX server
2552
-
2553
- -hostname <value>
2554
- Use this attribute to specify the hostname of the DX server
2555
-
2556
- -dxPort <value>
2557
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2558
-
2559
- -dxUsername <value>
2560
- Use this attribute to specify the username that is required for authenticating with the server
2561
-
2562
- -dxPassword <value>
2563
- Use this attribute to specify the password that is required for authenticating with the server
2564
-
2565
- -damAPIPort <value>
2566
- Port number of the DAM server, for any Kubernetes Environment default port is 443 (default: "")
2567
-
2568
- -ringAPIPort <value>
2569
- Port number of the DX Core API server, for any Kubernetes Environment default port is 443 (default: "")
2570
-
2571
- -ltpaTokenRefreshTime <value>
2572
- LTPA Token Refresh time in minutes (default: "5")
2573
-
2574
- -exportPath <value>
2575
- Location of the file path to export(Default path is store/outputFiles/dam-export-assets/)
2576
-
2577
- -exportBinary <value>
2578
- Use true or false to include or exclude binary as part of export(default is true)
2579
-
2580
- **Note:** Optional parameter are exportPath and exportBinary.
2581
-
2582
- ```
2583
-
2584
- Example Usage:
2585
- ```
2586
- dxclient manage-dam-assets export-assets -dxProtocol https -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -exportPath <exportPath> -exportBinary <exportBinary>
2587
-
2588
- ```
2589
-
2590
- ### 33. Validation of exported dam assets
2591
- The valdiate command is used to validate exported DAM assets file at the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2592
-
2593
- Commands Description
2594
- ```
2595
- dxclient manage-dam-assets validate-assets
2596
- ```
2597
- **Help command**
2598
- This command shows the help information for `manage-dam-assets` command usage:
2599
- ```
2600
- dxclient manage-dam-assets validate-assets -h
2601
- ```
2602
- **Commands Optional options**
2603
- ```
2604
- -exportPath <value>
2605
- Location of the file path to export(Default path is store/outputFiles/dam-export-assets/)
2606
-
2607
- -importBinary <value>
2608
- Use true or false to include or exclude binary as part of import(default is true)
2609
-
2610
- **Note:** Optional parameter are exportPath and importBinary.
2611
- ```
2612
-
2613
- Example Usage:
2614
- ```
2615
- dxclient manage-dam-assets validate-assets -exportPath <exportPath> -importBinary <importBinary>
2616
-
2617
- ```
2618
-
2619
- ### 34. Import dam assets
2620
-
2621
- The import command is used to import the assets of a dam to the target environment from the location specified by the user or default location `store/outputFiles/dam-export-assets/`
2622
-
2623
- Commands Description
2624
- ```
2625
- dxclient manage-dam-assets import-assets
2626
- ```
2627
- **Help command**
2628
- This command shows the help information for `manage-dam-assets` command usage:
2629
- ```
2630
- dxclient manage-dam-assets import-assets -h
2631
- ```
2632
- **Commands options**
2633
- ```
2634
- -dxProtocol <value>
2635
- Use this attribute to specify the protocol with which to connect to the DX server
2636
-
2637
- -hostname <value>
2638
- Use this attribute to specify the hostname of the DX server
2639
-
2640
- -dxPort <value>
2641
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2642
-
2643
- -dxUsername <value>
2644
- Use this attribute to specify the username that is required for authenticating with the server
2645
-
2646
- -dxPassword <value>
2647
- Use this attribute to specify the password that is required for authenticating with the server
2648
-
2649
- -damAPIPort <value>
2650
- Port number of the DAM server, for any Kubernetes Environment default port is 443 (default: "")
2651
-
2652
- -ringAPIPort <value>
2653
- Port number of the DX Core API server, for any Kubernetes Environment default port is 443 (default: "")
2654
-
2655
- -exportPath <value>
2656
- Location of the file path to import(Default path is store/outputFiles/dam-export-assets/)
2657
-
2658
- -importBinary <value>
2659
- Use true or false to include or exclude binary as part of import(default is true)
2660
-
2661
- **Note:** Optional parameter are exportPath and importBinary.
2662
- ```
2663
-
2664
- Example Usage:
2665
- ```
2666
- dxclient manage-dam-assets import-assets -dxProtocol https -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -exportPath <exportPath> -importBinary <importBinary>
2667
- ```
2668
-
2669
- ### 35. Manage dam staging get all subscribers
2670
-
2671
- manage-dam-staging get-all-subscribers command is used to get all the subscribers details for dam staging.
2672
-
2673
- Commands Description
2674
- ```
2675
- dxclient manage-dam-staging get-all-subscribers
2676
- ```
2677
- **Help command**
2678
- This command shows the help information for `manage-dam-staging get-all-subscribers` command usage:
2679
- ```
2680
- dxclient manage-dam-staging get-all-subscribers -h
2681
- ```
2682
-
2683
- **Command options**
2684
- ```
2685
- -dxProtocol, --dxProtocol <value>
2686
- Protocol of the DX server of the publisher (default: "")
2687
-
2688
- -hostname, --hostname <value>
2689
- Host name of the DX server of the publisher (default: "")
2690
-
2691
- -dxPort, --dxPort <value>
2692
- Port number of the DX server of the publisher (default: "")
2693
-
2694
- -dxUsername, --dxUsername <value>
2695
- Username of the DX server of the publisher (default: "")
2696
-
2697
- -dxPassword, --dxPassword <value>
2698
- Password of the DX server of the publisher (default: "")
2699
-
2700
- -damAPIPort, --damAPIPort <value>
2701
- Port number of the DAM API server of the publisher (default: "")
2702
-
2703
- -ringAPIPort, --ringAPIPort <value>
2704
- Port number of the DX Core API server of the publisher (default: "")
2705
-
2706
- -damAPIVersion, --damAPIVersion <value>
2707
- API Version number of DAM API server of the publisher (default: "")
2708
-
2709
- -ringAPIVersion, --ringAPIVersion <value>
2710
- API Version number of DX Core API server of the publisher (default: "")
2711
- ```
2712
-
2713
- Example usage:
2714
- ```
2715
- dxclient manage-dam-staging get-all-subscribers -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion>
2716
-
2717
- ```
2718
-
2719
- ### 36. Restart Core Pods
2720
-
2721
- restart-core-pods command is used to restart all the Core Pods in a Kubernetes-based deployments.
2722
-
2723
- Commands Description
2724
- This command triggers a rollout restart for a Kubernetes-based deployments, similar to `kubectl rollout retstart` command.
2725
-
2726
- Note: Only the user set as `wasAdmin` in the Helm values in authorised to trigger this command.
2727
- ```
2728
- dxclient restart-core-pods
2729
- ```
2730
-
2731
- **Help command**
2732
- This command shows the help information for `restart-dx-core` command usage:
2733
- ```
2734
- dxclient restart-dx-core -h
2735
- ```
2736
- **Command options**
2737
- ```
2738
- -dxProtocol <value>
2739
- Use this attribute to specify the protocol with which to connect to the server
2740
-
2741
- -dxWASUsername <value>
2742
- Use this attribute to specify the username that is required for authenticating with the DX WAS Server:
2743
-
2744
- -dxWASPassword <value>
2745
- Use this attribute to specify the password that is required for authenticating with the DX WAS Server:
2746
-
2747
- -hostname <value>
2748
- Use this attribute to specify the hostname of the target DX deployment:
2749
- ```
2750
-
2751
- ### 37. Undeploy Application
2752
- undeploy-application command is used to undeploy an EAR file from the WebSphere Application Server.
2753
-
2754
- Commands Description
2755
- ```
2756
- dxclient deploy-application
2757
- This command undeploys the application from WAS. User could opt to store backup by setting 'enable-backup' parameter to true .
2758
- ```
2759
- **Help command**
2760
- This command shows the help information for `undeploy-application` command usage:
2761
- ```
2762
- dxclient undeploy-application -h
2763
- ```
2764
-
2765
- **Common Command options**
2766
- ```
2767
- -hostname <value>
2768
- Use this attribute to specify the hostname of the target server
2769
-
2770
- -dxProtocol <value>
2771
- Use this attribute to specify the protocol with which to connect to the server
2772
-
2773
- -dxPort <value>
2774
- Use this attribute to specify the port on which to connect to the server(for Kubernetes Environment dxPort is 443)
2775
-
2776
- -dxUsername <value>
2777
- Use this attribute to specify the username that is required for authenticating with the server
2778
-
2779
- -dxPassword <value>
2780
- Use this attribute to specify the password that is required for authenticating with the server
2781
-
2782
- Required options for application deployment:
2783
-
2784
- -dxConnectPort <value>
2785
- Use this attribute to specify the port number of the cw_profile(for Kubernetes Environment dxConnectPort is 443)
2786
-
2787
- -dxConnectUsername <value>
2788
- Use this attribute to specify the username that is required for authenticating to the cw_profile
2789
-
2790
- -dxConnectPassword <value>
2791
- Use this attribute to specify the password that is required for authenticating to the cw_profile
2792
-
2793
- -dxSoapPort <Soap port of the DX server>
2794
- Use this attribute to specify Soap port of the DX server
2795
-
2796
- -dxProfileName <Profile name of the DX core server profile>
2797
- Use this attribute to specify the profile name of the DX core server
2798
-
2799
- -applicationName <value>
2800
- Use this attribute to specify the application name
2801
-
2802
- Optional arguments:
2803
-
2804
- -enable-backup <value>
2805
- Set the flag to true to take backup of the application to be undeployed. Default is false.
2806
-
2807
- **Note:** Mandatory parameters applicationName should be passed into the command line.
2808
- ```
2809
- Example Usage:
2810
- ```
2811
- dxclient undeploy-application -dxProtocol <http/https> -hostname <host-name> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -dxSoapPort <dxSoapPort> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -applicationName <application name> -dxProfileName <Profile name of the DX core server>
2812
- ```
2813
-
2814
- ### 38. LiveSync Push Theme
2815
-
2816
- This command will sync your WebDAV based theme files into DX Server. Then, it will watch for succeeding changes within the given `themePath` and immediately reflect the changes in the DX Server.
2817
-
2818
- Commands Description
2819
-
2820
- This command initially pushes the local theme (provided in `themePath`) into DX Server with the theme system name (provided in `themeName`). During this initial synchronization, theme files in the WebDAV server are currently unavailable for other clients. It will then create a file system watcher which will watch for any changes (files or folders) under `themePath` and immediately reflect those changes in DX Server. To stop watching, press (Ctrl + C).
2821
-
2822
- ```
2823
- dxclient livesync push-theme
2824
- ```
2825
- **Help command**
2826
- This command shows the help information for `live-sync` command usage:
2827
- ```
2828
- dxclient livesync push-theme -h
2829
- ```
2830
- **Command options**
2831
- ```
2832
- -dxProtocol, --dxProtocol <value>
2833
- Protocol of the DX server
2834
-
2835
- -hostname, --hostname <value>
2836
- Host name of the DX server
2837
-
2838
- -dxPort, --dxPort <value>
2839
- Port number of the DX Server, for any Kubernetes Environment default port is 443
2840
-
2841
- -dxUsername, --dxUsername <value>
2842
- Username of the DX Core server
2843
-
2844
- -dxPassword, --dxPassword <value>
2845
- Password of the DX Core server
2846
-
2847
- -contenthandlerPath,--contenthandlerPath <value>
2848
- Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
2849
-
2850
- -themeName, --themeName <value>
2851
- Theme System Name
2852
-
2853
- -themePath, --themePath <value>
2854
- Local path to the Theme folder
2855
-
2856
- -disablePrompt, --disablePrompt <value>
2857
- Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
2858
- ```
2859
- Example usage:
2860
-
2861
- ```
2862
- dxclient livesync push-theme -dxUsername <dxUsername> -dxPassword <dxPassword> -dxPort <dxPort> -dxProtocol <dxProtocol> -hostname <hostname> -contenthandlerPath <contenthandlerPath> -themePath <themePath> -themeName <themeSystemName>
2863
- ```
2864
-
2865
- **Ignoring files and folders**
2866
- You can opt to ignore files and folder paths to sync to server by creating an ignore file (`.ignore`) under the root of theme folder. When changing contents of the ignore file, the command needs to be re-run again to reflect the files the needs to be ignored.
2867
-
2868
- Sample ignore file contents:
2869
- ```
2870
- #.ignore
2871
-
2872
- test.txt
2873
- sample.txt
2874
- logs/
2875
- ```
2876
-
2877
- ### 39. LiveSync Pull Theme
2878
-
2879
- The livesync pull-theme command is used to sync WebDAV based theme files from the DX server to a local folder.​
2880
-
2881
- Commands Description
2882
-
2883
- This command will download a zipped file from the theme server which then will be extracted to the chosen local directory of the theme (provided in `themePath`), overwriting existing files and deleting stale files in the process. If `themeName` option is not provided, a list of WebDAV themes are dislayed and user may select a theme to pull into their local.
2884
-
2885
- ```
2886
- dxclient livesync pull-theme
2887
- ```
2888
- **Help command**
2889
- This command shows the help information for `livesync pull-theme` command usage:
2890
- ```
2891
- dxclient livesync pull-theme -h
2892
- ```
2893
-
2894
- **Command Options:**
2895
- ```
2896
- -dxProtocol, --dxProtocol <value>
2897
- Protocol of the DX server
2898
-
2899
- -hostname, --hostname <value>
2900
- Host name of the DX server
2901
-
2902
- -dxPort, --dxPort <value>
2903
- Port number of the DX Server, for any Kubernetes Environment default port is 443
2904
-
2905
- -dxUsername, --dxUsername <value>
2906
- Username of the DX Core server
2907
-
2908
- -dxPassword, --dxPassword <value>
2909
- Password of the DX Core server
2910
-
2911
- -contenthandlerPath,--contenthandlerPath <value>
2912
- Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
2913
-
2914
- -themeName, --themeName <value>
2915
- Theme System Name
2916
-
2917
- -themePath, --themePath <value>
2918
- Local path to the Theme folder
2919
-
2920
- -disablePrompt, --disablePrompt <value>
2921
- Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
2922
- ```
2923
-
2924
- Example usage:
2925
- ```
2926
- dxclient livesync pull-theme --dxUsername <dxUsername> --dxPassword <dxPassword> --dxPort <dxPort> --dxProtocol <dxProtocol> --hostname <hostname> --contenthandlerPath <contenthandlerPath> --themePath <themePath> --themeSystemName <themeName>
2927
- ```
2928
-
2929
- ### 40. Manage dam staging get staging mismatch report
2930
-
2931
- manage-dam-staging get-staging-mismatch-report command is used to generate staging mismatch report.
2932
-
2933
- Commands Description
2934
- ```
2935
- dxclient manage-dam-staging get-staging-mismatch-report
2936
- ```
2937
- **Help command**
2938
- This command shows the help information for `manage-dam-staging get-staging-mismatch-report` command usage:
2939
- ```
2940
- dxclient manage-dam-staging get-staging-mismatch-report -h
2941
- ```
2942
-
2943
- **Command options**
2944
- ```
2945
- -dxProtocol, --dxProtocol <value>
2946
- Protocol of the DX server of the publisher (default: "")
2947
-
2948
- -hostname, --hostname <value>
2949
- Host name of the DX server of the publisher (default: "")
2950
-
2951
- -dxPort, --dxPort <value>
2952
- Port number of the DX server of the publisher (default: "")
2953
-
2954
- -dxUsername, --dxUsername <value>
2955
- Username of the DX server of the publisher (default: "")
2956
-
2957
- -dxPassword, --dxPassword <value>
2958
- Password of the DX server of the publisher (default: "")
2959
-
2960
- -damAPIPort, --damAPIPort <value>
2961
- Port number of the DAM API server of the publisher (default: "")
2962
-
2963
- -ringAPIPort, --ringAPIPort <value>
2964
- Port number of the DX Core API server of the publisher (default: "")
2965
-
2966
- -damAPIVersion, --damAPIVersion <value>
2967
- API Version number of DAM API server of the publisher (default: "")
2968
-
2969
- -ringAPIVersion, --ringAPIVersion <value>
2970
- API Version number of DX Core API server of the publisher (default: "")
2971
-
2972
- -subscriberId, --subscriberId <value>
2973
- Subscriber id of the target environment of the subscriber (default: "")
2974
-
2975
- -recordType, --recordType <value>
2976
- Type of the mismatch record (default: "")
2977
-
2978
- -recordAction, --recordAction <value>
2979
- Action of the mismatch record (default: "")
2980
-
2981
- -reportPath, --reportPath <value>
2982
- Location of the file path to download report (Default path is store/outputFiles/)
2983
-
2984
- -ltpaTokenRefreshTime, --ltpaTokenRefreshTime <value>
2985
- LTPA Token refresh time in minutes (default: 5)
2986
- ```
2987
-
2988
- Example usage:
2989
- ```
2990
- dxclient manage-dam-staging get-staging-mismatch-report -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId> -recordType <recordType> -recordAction <recordAction> -reportPath <reportPath> -ltpaTokenRefreshTime <ltpaTokenRefreshTime>
2991
- ```
2992
-
2993
- !!!warning
2994
- 1. Avoid using `~` `!` `()` `'` and `*` special characters when naming files and folders.
2995
- 2. If you have a theme title name with special characters, those are automatically converted to underscores (`_`) by the server (for example, `来源folder` is translated to `__folder`). For the theme name, use the Theme System Name, the one with `_` like `__folder` in the following example.
2996
-
2997
- ### 41. Manage dam staging find staging mismatch
2998
-
2999
- manage-dam-staging find-staging-mismatch command is used to get mismatch logs for dam staging.
3000
-
3001
- Commands Description
3002
- ```
3003
- dxclient manage-dam-staging find-staging-mismatch
3004
- ```
3005
- **Help command**
3006
- This command shows the help information for `manage-dam-staging find-staging-mismatch` command usage:
3007
- ```
3008
- dxclient manage-dam-staging find-staging-mismatch -h
3009
- ```
3010
-
3011
- **Command options**
3012
- ```
3013
- -dxProtocol, --dxProtocol <value>
3014
- Protocol of the DX server of the publisher (default: "")
3015
-
3016
- -hostname, --hostname <value>
3017
- Host name of the DX server of the publisher (default: "")
3018
-
3019
- -dxPort, --dxPort <value>
3020
- Port number of the DX server of the publisher (default: "")
3021
-
3022
- -dxUsername, --dxUsername <value>
3023
- Username of the DX server of the publisher (default: "")
3024
-
3025
- -dxPassword, --dxPassword <value>
3026
- Password of the DX server of the publisher (default: "")
3027
-
3028
- -damAPIPort, --damAPIPort <value>
3029
- Port number of the DAM API server of the publisher (default: "")
3030
-
3031
- -ringAPIPort, --ringAPIPort <value>
3032
- Port number of the DX Core API server of the publisher (default: "")
3033
-
3034
- -damAPIVersion, --damAPIVersion <value>
3035
- API Version number of DAM API server of the publisher (default: "")
3036
-
3037
- -ringAPIVersion, --ringAPIVersion <value>
3038
- API Version number of DX Core API server of the publisher (default: "")
3039
-
3040
- -subscriberId, --subscriberId <value>
3041
- Subscriber id of the target environment of the subscriber
3042
- ```
3043
-
3044
- Example usage:
3045
- ```
3046
- dxclient manage-dam-staging find-staging-mismatch -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3047
- ```
3048
-
3049
- ### 42. Manage dam staging start staging resync
3050
-
3051
- manage-dam-staging start-staging-resync command is used to trigger staging resync.
3052
-
3053
- Commands Description
3054
- ```
3055
- dxclient manage-dam-staging start-staging-resync
3056
- ```
3057
- **Help command**
3058
- This command shows the help information for `manage-dam-staging start-staging-resync` command usage:
3059
- ```
3060
- dxclient manage-dam-staging start-staging-resync -h
3061
- ```
3062
-
3063
- **Command options**
3064
- ```
3065
- -dxProtocol, --dxProtocol <value>
3066
- Protocol of the DX server of the publisher (default: "")
3067
-
3068
- -hostname, --hostname <value>
3069
- Host name of the DX server of the publisher (default: "")
3070
-
3071
- -dxPort, --dxPort <value>
3072
- Port number of the DX server of the publisher (default: "")
3073
-
3074
- -dxUsername, --dxUsername <value>
3075
- Username of the DX server of the publisher (default: "")
3076
-
3077
- -dxPassword, --dxPassword <value>
3078
- Password of the DX server of the publisher (default: "")
3079
-
3080
- -damAPIPort, --damAPIPort <value>
3081
- Port number of the DAM API server of the publisher (default: "")
3082
-
3083
- -ringAPIPort, --ringAPIPort <value>
3084
- Port number of the DX Core API server of the publisher (default: "")
3085
-
3086
- -damAPIVersion, --damAPIVersion <value>
3087
- API Version number of DAM API server of the publisher (default: "")
3088
-
3089
- -ringAPIVersion, --ringAPIVersion <value>
3090
- API Version number of DX Core API server of the publisher (default: "")
3091
-
3092
- -subscriberId, --subscriberId <value>
3093
- Subscriber id of the target environment of the subscriber
3094
- ```
3095
-
3096
- Example usage:
3097
- ```
3098
- dxclient manage-dam-staging start-staging-resync -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3099
- ```
3100
-
3101
- ### 43. Manage dam staging delete staging mismatch
3102
-
3103
- manage-dam-staging delete-staging-mismatch command is used to delete mismatch logs for all the registered dam staging subscribers.
3104
-
3105
- Commands Description
3106
- ```
3107
- dxclient manage-dam-staging delete-staging-mismatch
3108
- ```
3109
- **Help command**
3110
- This command shows the help information for `manage-dam-staging delete-staging-mismatch` command usage:
3111
- ```
3112
- dxclient manage-dam-staging delete-staging-mismatch -h
3113
- ```
3114
-
3115
- **Command options**
3116
- ```
3117
- -dxProtocol, --dxProtocol <value>
3118
- Protocol of the DX server of the publisher (default: "")
3119
-
3120
- -hostname, --hostname <value>
3121
- Host name of the DX server of the publisher (default: "")
3122
-
3123
- -dxPort, --dxPort <value>
3124
- Port number of the DX server of the publisher (default: "")
3125
-
3126
- -dxUsername, --dxUsername <value>
3127
- Username of the DX server of the publisher (default: "")
3128
-
3129
- -dxPassword, --dxPassword <value>
3130
- Password of the DX server of the publisher (default: "")
3131
-
3132
- -damAPIPort, --damAPIPort <value>
3133
- Port number of the DAM API server of the publisher (default: "")
3134
-
3135
- -ringAPIPort, --ringAPIPort <value>
3136
- Port number of the DX Core API server of the publisher (default: "")
3137
-
3138
- -damAPIVersion, --damAPIVersion <value>
3139
- API Version number of DAM API server of the publisher (default: "")
3140
-
3141
- -ringAPIVersion, --ringAPIVersion <value>
3142
- API Version number of DX Core API server of the publisher (default: "")
3143
-
3144
- -subscriberId, --subscriberId <value>
3145
- Subscriber id of the target environment of the subscriber (default: "")
3146
- ```
3147
-
3148
- ```
3149
- **Note:** The "subscriberId" is required only when a user intends to delete mismatch logs for a particular subscriber.
3150
- ```
3151
-
3152
- Example usage:
3153
- ```
3154
- dxclient manage-dam-staging find-staging-mismatch -dxProtocol <dxProtocol> -hostname <hostname> -dxPort <dxPort> -dxUsername <dxUsername> -dxPassword <dxPassword> -damAPIPort <damAPIPort> -ringAPIPort <ringAPIPort> -damAPIVersion <damAPIVersion> -ringAPIVersion <ringAPIVersion> -subscriberId <subscriberId>
3155
- ```
3156
-
3157
- ### 44. LiveSync Push WCM Design Library
3158
-
3159
- This command will sync your WCM Design Library local files into DX Server. Then, it will watch for succeeding changes within the given `wcmLibraryPath` and immediately reflect the changes in the DX server.
3160
-
3161
- > :warning: **Feature Limitations:**
3162
- > 1. Supported WCM Types: Presentation Template, HTML Component and Folder Component.
3163
- > 2. Moving and Renaming of files will be equivalent to deleting the original components and creation of an entirely new components.
3164
- > 3. If a published component have a draft version, the feature will pull and push into the draft version.
3165
- > 4. The Push WCM Design Library feature will only work on WCM Design Library previously pulled by the LiveSync Pull WCM Design Library feature.
3166
-
3167
- Commands Description
3168
-
3169
- This command invokes the livesync push-wcm-design-library tool inside the DXClient.
3170
-
3171
- This command initially pushes all the changes that happened in local WCM Design Library files (provided in `wcmLibraryPath`) to DX Server with the WCM Design Library system name (provided in `wcmLibraryName`). It will then create a file system watcher which will watch for any changes (files or folders) under `wcmLibraryPath` and immediately reflect those changes in DX Server. To stop watching, press (Ctrl + C).
3172
-
3173
- ```shell
3174
- dxclient livesync push-wcm-design-library
3175
- ```
3176
-
3177
- **Help command**
3178
- This command shows the help information for `live-sync` command usage:
3179
-
3180
- ```shell
3181
- dxclient livesync push-wcm-design-library -h
3182
- ```
3183
- **Command options**
3184
- ```
3185
- -dxProtocol, --dxProtocol <value>
3186
- Protocol of the DX server
3187
-
3188
- -hostname, --hostname <value>
3189
- Host name of the DX server
3190
-
3191
- -dxPort, --dxPort <value>
3192
- Port number of the DX Server, for any Kubernetes Environment default port is 443
3193
-
3194
- -dxUsername, --dxUsername <value>
3195
- Username of the DX Core server
3196
-
3197
- -dxPassword, --dxPassword <value>
3198
- Password of the DX Core server
3199
-
3200
- -contenthandlerPath,--contenthandlerPath <value>
3201
- Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
3202
-
3203
- -wcmLibraryName, --wcmLibraryName <value>
3204
- WCM Design Library Name
3205
-
3206
- -wcmLibraryId, --wcmLibraryId <value>
3207
- UUID of the WCM Design Library
3208
-
3209
- -wcmLibraryPath, --wcmLibraryPath <value>
3210
- Local path to the Library folder
3211
-
3212
- -wcmProjectName, --wcmProjectName <value>
3213
- Name of the WCM Project
3214
-
3215
- -virtualPortalContext, --virtualPortalContext <value>
3216
- Context of the virtual portal of the DX Core server
3217
-
3218
- -disablePrompt, --disablePrompt <value>
3219
- Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
3220
- ```
3221
- Example usage:
3222
-
3223
- ```
3224
- dxclient livesync push-wcm-design-library -dxUsername <dxUsername> -dxPassword <dxPassword> -dxPort <dxPort> -dxProtocol <dxProtocol> -hostname <hostname> -contenthandlerPath <contenthandlerPath> -wcmLibraryPath <wcmLibraryPath> -wcmLibraryName <wcmLibraryName>
3225
- ```
3226
-
3227
- **Optional wcmLibraryName and wcmLibraryId inputs**
3228
- If the user provided neither of these options. The dxclient livesync push-wcm-design-library will use the metadata of saved WCM Design Library in the `wcmLibraryPath`.
3229
-
3230
- ### 45. LiveSync Pull WCM Design Library
3231
-
3232
- This command is used to sync a DX WCM Design Library from DX Server to a local folder.
3233
-
3234
- > :warning: **Feature Limitations:**
3235
- > 1. Supported WCM Types: Presentation Template, HTML Component and Folder Component.
3236
- > 2. Moving and Renaming of files will be equivalent to deleting the original components and creation of an entirely new components.
3237
- > 3. If a published component have a draft version, the feature will pull and push into the draft version.
3238
- > 4. The Push WCM Design Library feature will only work on WCM Design Library previously pulled by the LiveSync Pull WCM Design Library feature.
3239
-
3240
- Commands Description
3241
-
3242
- This command invokes the livesync pull-wcm-design-library tool inside the DXClient.
3243
-
3244
- This command will download the WCM Design Library files in DX Server under the given library name (provided in `-wcmLibraryName`). This will then be saved to the target local directory of the library (provided in `-wcmLibraryPath`), overwriting existing files in this local directory which also deletes stale files in the process.
3245
-
3246
- ```
3247
- dxclient livesync pull-wcm-design-library
3248
- ```
3249
- **Help command**
3250
- This command shows the help information for `livesync pull-wcm-design-library` command usage:
3251
- ```
3252
- dxclient livesync pull-wcm-design-library -h
3253
- ```
3254
-
3255
- **Command Options:**
3256
- ```
3257
- -dxProtocol, --dxProtocol <value>
3258
- Protocol of the DX server
3259
-
3260
- -hostname, --hostname <value>
3261
- Host name of the DX server
3262
-
3263
- -dxPort, --dxPort <value>
3264
- Port number of the DX Server, for any Kubernetes Environment default port is 443
3265
-
3266
- -dxUsername, --dxUsername <value>
3267
- Username of the DX Core server
3268
-
3269
- -dxPassword, --dxPassword <value>
3270
- Password of the DX Core server
3271
-
3272
- -contenthandlerPath,--contenthandlerPath <value>
3273
- Alternate path for the portal context root or the content handler servlet (default: "/wps/mycontenthandler")
3274
-
3275
- -wcmLibraryName, --wcmLibraryName <value>
3276
- WCM Design Library Name
3277
-
3278
- -wcmLibraryId, --wcmLibraryId <value>
3279
- UUID of the WCM Design Library
3280
-
3281
- -wcmibraryPath, --wcmLibraryPath <value>
3282
- Local path to the Library folder
3283
-
3284
- -wcmProjectName, --wcmProjectName <value>
3285
- Name of the WCM Project
3286
-
3287
- -virtualPortalContext, --virtualPortalContext <value>
3288
- Context of the virtual portal of the DX Core server
3289
-
3290
- -disablePrompt, --disablePrompt <value>
3291
- Disable the confirmation prompt for overwriting local and server files. Bypasses the prompt and immediately proceeds on pushing or pulling theme files.
3292
- ```
3293
-
3294
- Example usage:
3295
- ```
3296
- dxclient livesync pull-wcm-design-library -dxUsername <dxUsername> -dxPassword <dxPassword> -dxPort <dxPort> -dxProtocol <dxProtocol> -hostname <hostname> -contenthandlerPath <contenthandlerPath> -wcmLibraryPath <wcmLibraryPath> -wcmLibraryName <wcmLibraryName>
3297
- ```
3298
-
3299
- **Optional wcmLibraryName and wcmLibraryId inputs**
3300
-
3301
- If neither of these options is not provided:
3302
- 1. The LiveSync will check if a saved library was previously pull using this command and use that as the basis.
3303
- 2. If no saved library is detected, a list of WCM Design Libraries displayed and you can select a WCM Design Library to pull.
3304
-
3305
- Sample WCM Design Library Selection Prompt
3306
- ```shell
3307
- $ dxclient livesync pull-wcm-design-library -dxUsername <dxUsername> -dxPassword <dxPassword> -dxPort <dxPort> -dxProtocol <dxProtocol> -hostname <hostname> -contenthandlerPath <contenthandlerPath> -wcmLibraryPath <wcmLibraryPath>
3308
- 2024-08-16 19:53:06 : Checking for saved WCM Design Library in <wcmLibraryPath>
3309
- 2024-08-16 19:53:06 : Please select a WCM Design Library
3310
- (x) [Library Name: blog solo template v70, Display Title: Blog Solo Template v70, ID: ddc1c6de-b18d-4cfd-af8f-dac5ccdd5d30]
3311
- ( ) [Library Name: blog template v70, Display Title: Blog Template v70, ID: 5eb62c46-6f7d-498f-b71d-6bbdaac3e84a]
3312
- ( ) [Library Name: ml configuration, Display Title: ML Configuration, ID: cac73711-d639-436b-a922-1a717c5e1105]
3313
- ( ) [Library Name: portal site, Display Title: Portal Site, ID: TWFuYWdlZCBQYWdlcyBSb290IExpYnJhcnk]
3314
- ```
3315
-
3316
- # Logger enablement
3317
-
3318
- ## Enable logger
3319
-
3320
- Logger can be enabled by setting parameter "enableLogger": true in the below file. If logger enabled then logger file will be generate in logs folder of the dxclient.
3321
-
3322
- dist/configuration/config.json
3323
-
3324
- If logger enabled then logger file will be available in the below location:
3325
- store/logs/
322
+ 25. If connecting to an HCL DX 9.5 CF227 deployment, following changes are to be expected.
3326
323
 
3327
- ## disable logger
324
+ - LiveSync now supports Style-Sheet Components.
3328
325
 
3329
- Logger can be disabled by setting parameter "enableLogger":false in the below file
326
+ </details>
3330
327
 
3331
- dist/configuration/config.json
328
+ ## [DXClient Documentation](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/)
3332
329
 
3333
- All the generic command options can be configured inside “config.json” of the tool, which will be read as default.
3334
- The options passed through command line will override these default values.
330
+ Full documentation of DXClient can be found [here](https://opensource.hcltechsw.com/digital-experience/latest/extend_dx/development_tools/dxclient/).