Data Studio CLI (TedCLI.bat)
The Data Studio CLI executes the TED specifications including ConverterPro, ComparePro, Related Extract, Related Loader, and Execution Suites. The specifications will have to be created using the relevant application client available in the File-AID/EX perspective of Workbench and the specifications should be saved and made available in any of the shared repositories. Moreover, the shared repository should be configured on a standalone communication manager for using it with TED CLI. Further, to execute the specifications via the TED CLI, standalone execution server needs to be installed, if not already available.
Important
The embedded communication manager and execution server that is available with the Workbench TED feature cannot be used for executing TED CLI.
The standalone communication manager is installed along with the File-AID Services, and can be configured in Workbench for Eclipse preferences, under the TED section for use with the client. Once configured and set as current, the Repository Management utility shall be used to configure the shared repository on to the current communication manager. Please refer to the TED install guide for more information.
Usage
Executing the specification should be done with the TedCLI.bat file. The general syntax for using the TedCLI.bat is:
TedCLI.bat -cmd=<command> optionswhere the command is:
execute - Executes the specification from the repository specified.
Important
Many of the parameters available for the 'execute' command can also be specified via the execution context file, these are marked accordingly in the Execute Command parameters table. For more information about the execution context, refer to the following table.
Execute Command parameters
| Parameter/Option | Abbr | Description | Context (-able)? | Required? |
|---|---|---|---|---|
-repository | -r | The repository name where the specification is present. | Yes | |
-results-repository | -rr | The results repository where ComparePro execution results will be stored. Applicable only to ComparePro specification. Defaults to main repository if not specified. | ||
-specification | -s | The results repository where ComparePro execution results will be stored. Applicable only to ComparePro specification. Defaults to main repository if not specified. | Yes, if specification-list is not provided | |
-specification-type | -st | The type of the specification that is to be executed. compare, convert, extract, load, exsuite. | Yes, if specification-list is not provided | |
-specification-list | -sl | Specification Name and Type list each 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. | ||
-execution-context | -ec | The 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 a value of a certain parameter is present in the context file and is also passed as an argument, the value passed with the command will take precedence. To know which all parameters can be specified via the context file, view the template provided at <Install_Path>/WorkbenchCLI/EnterpriseData namely executioncontext_template.properties. Multiple execution contexts can be created as required, by copying the template. | ||
-comm-manager | -cm | The standalone communication manager to be used, where the repository is configured. | Yes | Yes |
-comm-manager-port | -cmp | The standalone communication manager's port. | Yes | Yes |
-ces-uri | -ces | The CES uri to be used for license validation. | Yes | Yes |
-use-cloud | -ucd | Flag to denote which type of CES is to be used, a local CES or the BMC's cloud CES. | Yes | Yes |
-ces-cust-no | -cno | The customer number in case cloud CES is being used. | Yes | Yes for cloud CES |
-ces-site-id | -sid | The site ID in case cloud CES is being used. | Yes | Yes for cloud CES |
-exit-on-failure | -eof | Directive to initiate exit on encountering specification execution failure in case of executing multiple specifications. This optional field is defaulted to true. If set to false, will continue executing other specifications in the provided list. | ||
-execution-timeout | -t | The execution timeout in seconds, if needs to be set to a value other than 20 seconds. | Yes | |
-execution-server | -es | The standalone execution server where EX specifications should be executed. | Yes | Yes for EX Specification |
-execution-server-port | -esp | The standalone execution server's port to be used for communication. | Yes | Yes for EX Specification |
-execution-host | -eh | The execution host where RDX specifications should be executed. | Yes | Yes for RDX Specifications |
-executor-host-port | -ehp | The execution host's port to be used for communication. | Yes | Yes for RDX Specifications |
-hci-userid | -hid | The HCI connection userid. (For RDX execution only) | Yes for RDX Specifications | |
-hci-password | -hpw | The HCI connection password. (For RDX execution only). | Yes for RDX Specifications | |
-certificate | -certificate | Base64 encoded string content of the certificate required to establish HCI connection with certificate based authentication. Takes precedence over keystore based authentication if both 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 | The password for accessing the provided keystore if applicable, for keystore based authentication. (For RDX execution only) | Yes | Yes for RDX Specifications |
-ccsid | -ccs | The CCSID to be used in the execution host connection, the default is 1047. | Yes | |
-jcl-jobcard1 | -j1 | The JCL Jobcard's line 1. (For RDX execution only) | Yes | |
-jcl-jobcard2 | -j2 | The JCL Jobcard's line 2. (For RDX execution only) | Yes | |
-jcl-jobcard3 | -j3 | The JCL Jobcard's line 3. (For RDX execution only) | Yes | |
-jcl-jobcard4 | -j4 | The JCL Jobcard's line 4. (For RDX execution only) | Yes | |
-jcl-jobcard5 | -j5 | The JCL Jobcard's line 5. (For RDX execution only) | Yes | |
-dataset-hlq | -hlq | The data set high level qualifier to be used. (For RDX execution only) | Yes | |
-temp-dataset-prefix | -px | The prefix to be used for temporary datasets. (For RDX execution only) | Yes | |
-temp-dataset-suffix | -sx | The suffix to be used for temporary datasets. (For RDX execution only) | Yes | |
-fadebug | -fdb | The dataprivacy override FADEBUG, that defines the logging information for the File-AID Rules Engine. (For RDX Extract execution only) | Yes | |
-faexpath | -fxp | The dataprivacy override FAEXPATH, that defines the path for File-AID Rules Engine location. (For RDX Extract execution only) | Yes | |
-faipaddr | -fip | The dataprivacy override FAIPADDR, that provides the File-AID Services IP address and execution port. (For RDX Extract execution only) | Yes | |
-fajopts | -fjo | The dataprivacy override FAJOPTS, that defines the Java options for the File-AID Rules Engine. (For RDX Extract execution only) | Yes | |
-fajpath | -fjp | The dataprivacy override FAJAPTH, that defines the z/OS UNIX path for the Java Virtual Machine. (For RDX Extract execution only) | Yes |
Sample usage
Help on execute command
TedCLI.bat -cmd execute -helpWill print the help text for execute command.
Executing an EX Extract specification from the repository
TedCLI.bat -cmd execute -repository=TestRepo -specification=TestExExtractSpec -specificationtype=EXTRACT -comm-mgr=remote-comm-manager-machine -comm-mgr-port=4901 -execution-server=server-machine -execution-server-port=4900 -ces-uri=http://test-ces-host:2020/compuware -use-cloud=falseExecutes the TestSpec EX Extract from TestRepo repository configured on the given communication manager on the provided execution server, while checking for license on the provided ces namely test-ces-host.
Executing an ComparePro specification from the repository
TedCLI.bat -cmd=execute -repository=SpecRepository -specification=TestCompareProSpec -specificationtype=Compare -results-repository=ResultsRepo -execution-context=TestExecutionContext.propertiesExecutes a ComparePro specification. Makes use of 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.
Executing an RDX specification from the repository using password credentials
TedCLI.bat -cmd execute -repository TestRepo -specification TestRDXExtractSpec -specificationtype EXTRACT -execution-host mfhost -execution-host-port 16196 -execution-context TestExecutionContext.properties dataset-hlq=faexrec -hid=myuserid -hpw=mypasswordExecutes 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.
Executing an RDX specification from the repository using certificate
TedCLI.bat -cmd execute -repository TestRepo -specification TestRDXExtractSpec -specificationtype EXTRACT -execution-host mfhost -execution-host-port 16196 -execution-context TestExecutionContext.properties dataset-hlq=faexrec -certificate base64EncodedCERTcontentExecuting an RDX specification from the repository using certificate from a keystore
TedCLI.bat -cmd execute -repository TestRepo -specification TestRDXExtractSpec -specificationtype EXTRACT -execution-host mfhost -execution-host-port 16196 -execution-context TestExecutionContext.properties dataset-hlq=faexrec -keystore c:/path/mykeystore -certificateAlias myCertName -keystorePassword mykeystrpwdExecuting an RDX specification from the repository using certificate from windows cert store
TedCLI.bat -cmd execute -repository TestRepo -specification TestRDXExtractSpec -specificationtype EXTRACT -execution-host mfhost -execution-host-port 16196 -execution-context TestExecutionContext.properties dataset-hlq=faexrec -keystore Windows-MY -certificateAlias myCertName Executing multiple specifications in a single command from the repository
TedCLI.bat -cmd execute -repository TestRepo -specification-list "ExExtractSpec extract convspec convert loadspec load" -exit-on-failure false -execution-timeout 20Executes the three specifications of type extract, converterPro and a loader in sequence. Since the optional exit-on-failure flag is set to false, if the execution of a specification fails, it will continue executing the rest of the specifications in the list, default behavior is true if not specified. The execution timeout has been set to 30 seconds in this example instead of the default 20 seconds.
Comments
Log in or register to comment.