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