Data Studio CLI (TedCLI.bat)
The Data Studio CLI executes the TED specifications including ConverterPro, ComparePro, Related Extract, Related Loader, and Execution Suites. You create the specifications by using the relevant application client available in the File-AID/EX perspective of Workbench. You can then save the specifications and make them available in any of the shared repositories. To use the shared repository with TED CLI, you must configure the shared repository on a stand-alone communication manager. To run the specifications via the TED CLI, you must install the stand-alone execution server (if not already available).
You install the stand-alone communication manager with the File-AID Services, and configure the manager in Workbench for Eclipse preferences, under the TED section for use with the client. When you have configured the Repository Management utility and set it as current, use it to configure the shared repository for the current communication manager. For more information, see TED installation documentation.
Usage
To execute the specification, use TedCLI.bat file with the following general syntax:
In this syntax the execute command executes the specification from the repository.
Execute Command parameters
Parameter | Abbreviation | Description | Context (-able)? | Required? |
|---|---|---|---|---|
-repository | -r | Repository name where the specification is present. | No | Yes |
-results-repository | -rr | Results repository where ComparePro execution results is stored. Applicable only to ComparePro specification. It defaults to main repository if not specified. | No | No |
-specification | -s | Name of the specification to be executed. | No | Yes, if specification-list is not provided |
-specification-type | -st | Type of specification to be executed, compared, converted, extracted, loaded, and exsuited. | No | Yes, if specification-list is not provided |
-specification-list | -sl | Specification Name and Type list separated by space within quotes, if multiple specifications have to be executed in series. If this argument is specified, the specification and specification-type arguments will not be used. | No | No |
-execution-context | -ec | Name or absolute path to the execution context file. The execution context file can supply some of the arguments that can also be passed with the execute command. If the value of a certain parameter is present in the context file and is also passed as an argument, the value passed with the command takes precedence. To know which parameters you can specify via the context file, view the template provided at installPath/WorkbenchCLI/EnterpriseData, namely executioncontext_template.properties. You can create multiple execution contexts (as required) by copying the template. | No | No |
-comm-manager | -cm | Stand-alone communication manager to be used, where the repository is configured. | Yes | Yes |
-comm-manager-port | -cmp | Stand-alone communication manager's port. | Yes | Yes |
-ces-uri | -ces | CES uri to be used for license validation. | Yes | Yes |
-use-cloud | -ucd | Flag to denote whether a local CES or the Compuware cloud CES should be used. | Yes | Yes |
-ces-cust-no | -cno | Customer number when using cloud CES. | Yes | Yes for cloud CES |
-ces-site-id | -sid | Site ID when using cloud CES. | Yes | Yes for cloud CES |
-exit-on-failure | -eof | Directive to initiate exit on encountering specification execution failure when executing multiple specifications. This default optional field is true. If set to false, it will continue executing other specifications in the provided list. | No | No |
-execution-timeout | -t | Execution timeout in seconds, if needs to be set to a value other than 20 seconds. | Yes | No |
-execution-server | -es | Stand-alone execution server where EX specifications should be executed. | Yes | Yes for EX Specification |
-execution-server-port | -esp | Stand-alone execution server's port to be used for communication. | Yes | Yes for EX Specification |
-execution-host | -eh | Execution host where RDX specifications should be executed. | Yes | Yes for RDX Specifications |
-executor-host-port | -ehp | Execution host's port to be used for communication. | Yes | Yes for RDX Specifications |
-hci-userid | -hid | HCI connection userid. (For RDX execution only) | No | Yes for RDX Specifications |
-hci-password | -hpw | HCI connection password. (For RDX execution only). | No | Yes for RDX Specifications |
-certificate | -certificate | Base64 encoded string content of the certificate required to establish HCI connection with certificate-based authentication. It takes precedence over keystore based authentication if both are supplied. (For RDX execution only) | Yes | Yes for RDX Specifications |
-keystore | -keystore | Absolute path to keystore file required for establishing HCI connection with keystore based authentication. (For RDX execution only) | Yes | Yes for RDX Specifications |
-certificateAlias | -certificateAlias | Alias of the certificate to be used in the supplied keystore for keystore based authentication. (For RDX execution only) | Yes | Yes for RDX Specifications |
-keystorePassword | -keystorePassword | Password for accessing the provided keystore if applicable, for keystore based authentication. (For RDX execution only) | Yes | Yes for RDX Specifications |
-ccsid | -ccs | CCSID to be used in the execution host connection. The default is 1047. | Yes | No |
-jcl-jobcard1 | -j1 | JCL Jobcard's line 1. (For RDX execution only) | Yes | No |
-jcl-jobcard2 | -j2 | JCL Jobcard's line 2. (For RDX execution only) | Yes | No |
-jcl-jobcard3 | -j3 | JCL Jobcard's line 3. (For RDX execution only) | Yes | No |
-jcl-jobcard4 | -j4 | JCL Jobcard's line 4. (For RDX execution only) | Yes | No |
-jcl-jobcard5 | -j5 | JCL Jobcard's line 5. (For RDX execution only) | Yes | No |
-dataset-hlq | -hlq | Data set high level qualifier to be used. (For RDX execution only) | Yes | No |
-temp-dataset-prefix | -px | Prefix used for temporary datasets. (For RDX execution only) | Yes | No |
-temp-dataset-suffix | -sx | Suffix used for temporary datasets. (For RDX execution only) | Yes | No |
-fadebug | -fdb | Data privacy override FADEBUG, that defines the logging information for the File-AID Rules Engine. (For RDX Extract execution only) | Yes | No |
-faexpath | -fxp | Data privacy override FAEXPATH, that defines the path for File-AID Rules Engine location. (For RDX Extract execution only) | Yes | No |
-faipaddr | -fip | Data privacy override FAIPADDR, that provides the File-AID Services IP address and execution port. (For RDX Extract execution only) | Yes | No |
-fajopts | -fjo | Data privacy override FAJOPTS, that defines the Java options for the File-AID Rules Engine. (For RDX Extract execution only) | Yes | No |
-fajpath | -fjp | Data privacy override FAJAPTH, that defines the z/OS UNIX path for the Java Virtual Machine. (For RDX Extract execution only) | Yes | No |
Sample usage
This section provides examples of the usage.
The following syntax will print the help text for execute command.
Use the following syntax to execute an EX-Extract specification from the repository. The sample executes the TestSpec EX Extract from TestRepo repository configured on the communication manager of the provided execution server, while checking for license on the provided ces namely test-ces-host.
Use the following syntax to execute ComparePro specification from the repository. This executes a ComparePro specification by using the specified results repository to store the compare results instead of the default SpecRepository. Also, this execution utilizes the values specified in the execution context for the rest of the required parameters.
Use the following syntax to execute RDX specification from the repository using password credentials. This executes the TestRDXExtractSpec RDX Extract from TestRepo repository. The job is submitted to the mfhost:16196 defined via the execution host and port params. Some of the values are specified in the execution context file TestExecutionContext.properties defined, while some of the arguments like dataset-hlq defined in the context have been overridden with the value passed as the argument.
Use the following syntax to execute a RDX specification from the repository using certificate.
Use the following syntax to execute a RDX specification from the repository using certificate from a keystore.
Use the following syntax to execute a RDX specification from the repository using certificate from windows cert store.
Use the following syntax to execute multiple specifications in a single command from the repository. The sample executes the three specifications of type extract, converterPro and a loader in sequence. Because the optional exit-on-failure flag is set to false, if the execution of a specification fails, it continues running the rest of the specifications in the list. Default behavior is true if not specified. In this sample, the execution timeout has been set to 30 seconds instead of the default 20 seconds.
Import and Export commands
In the TED CLI, the import and export commands are available for Related Extract and Related Loader specifications. By using the import command, you can add the Extract/Loader specification to the required repository. By using the export command, you can export the Extract/Loader specification from the repository to a specified path.
To use the shared repository with TED CLI, you must configure it on a stand-alone communication manager. After installing this manager, you can configure it in the Eclipse Workbench preferences under BMC > DevX Data Studio > Communications Manager and set it to current. Use the Repository Management utility to configure the shared repository on the current communication manager.
Import command parameters
The following table describes the import command parameters:
Parameter | Abbreviation | Description |
|---|---|---|
-repository | -r | Name of the repository to which the specification is imported. |
-specification | -s | Name of the specification to be imported. |
-specification-type | -st | Type of specification to be imported, extracted or loaded. |
-execution-context | -ec | Name or absolute path to the execution context file. The execution context file can supply some of the arguments that can also be passed with the execute command. If the value of a certain parameter is present in the context file and is also passed as an argument, the value passed with the command takes precedence. To know which parameters you can specify via the context file, view the template provided at installPath/WorkbenchCLI/EnterpriseData, namely executioncontext_template.properties. You can create multiple execution contexts (as required) by copying the template. |
-import-specification-path | -isp | Path where the specification is present |
-communication manager | -cm | Stand-alone communication manager to be used, where the repository is configured. |
-communication manager port | -cmp | Stand-alone communication manager's port. |
-ces uri | -ces | CES URI to be used for license validation. |
-use cloud | -ucd | Flag to indicate whether a local CES or the Compuware cloud CES should be used. |
-ces cloud customer number | -cno | Customer number when cloud CES is being used. |
-ces cloud site id | -sid | Site ID when cloud CES is being used. |
Import commands
Use the following syntax to use the help command:
Use the following syntax to import the Related Loader Specifications:
Use the following syntax to import the Related Extract Specification:
Export command parameters
The following table describes the export command parameters:
Parameter | Abbreviation | Description |
|---|---|---|
-repository | -r | Name of the repository to which the specification is present. |
-specification | -s | Name of the specification to be exported. |
-specification-type | -st | Type of specification to be exported, extracted or loaded. |
-execution-context | -ec | Name or absolute path to the execution context file. The execution context file can supply some of the arguments that can also be passed with the execute command. If the value of a certain parameter is present in the context file and is also passed as an argument, the value passed with the command takes precedence. To know which parameters you can specify via the context file, view the template provided at installPath/WorkbenchCLI/EnterpriseData, namely executioncontext_template.properties. You can create multiple execution contexts (as required) by copying the template. |
-export-specification-path | -esp | Path where the specification is saved. |
-export type | -et | Export type-XML or batch. |
-communication manager | -cm | Stand-alone communication manager to be used, where the repository is configured. |
-communication manager port | -cmp | Stand-alone communication manager's port. |
-ces uri | -ces | CES URI to be used for license validation. |
-use cloud | -ucd | Flag to denote whether a local CES or the Compuware cloud CES should be used. |
-ces cloud customer number | -cno | Customer number when cloud CES is being used. |
-ces cloud site id | -sid | Site ID when cloud CES is being used. |
Export commands
Use the following syntax to use the help command:
Use the following syntaxes to export the Related Loader Specification:
Export as XML
Export as Batch
Use the following syntaxes to export the Related Extract Specification:
Export as XML
Export as Batch
We can pass the required parameters through the command line as well, instead of using the TEDCLI_executioncontext.properties file. See the following example:
For cloud