The following plugin provides functionality available through
Pipeline-compatible steps. Read more about how to integrate steps into your
Pipeline in the
Steps
section of the
Pipeline Syntax
page.
For a list of other such plugins, see the
Pipeline Steps Reference
page.
Compuware Topaz for Enterprise Data
ted
: Topaz for Enterprise Data - Execute Specifications.
credentialsID : String
repositoryName : String
(optional)
The name of the File-AID EX repository, which houses the required EX specifications that are to be executed.
Optional? No
Can be defined in execution Context? No
resultsRepositoryName : String
(optional)
The repository where Compare Pro execution results will be stored. Only applicable to comparePro specifications.
Optional? Yes, defaults to the specification repository if not specified.
Can be defined in execution Context? No
selectExecutionTypeRadio : String
(optional)
specificationName : String
(optional)
The name of the specification that is to be executed. Required if single specification execution is selected.
Optional? No, mandatory if single specification execution is selected.
Can be defined in execution Context? No
specificationType : String
(optional)
The type of the specification that is to be executed.
Optional? No, mandatory if single specification execution is selected.
Can be defined in execution Context? No
specificationList : String
(optional)
If multiple specifications are to be executed within the same pipeline, with the same configuration. Provide a list of Specification Name and Types each separated by space. For example: SPECA extract SPECB convert SPECC compare
Optional? No, mandatory if multi-specification execution is selected.
Can be defined in execution Context? No
exitOnFailure : boolean
(optional)
Flag to denote if it is preferred to stop the continued execution of specifications after a execution failure, in case of multi-specification execution.
Optional? Yes, defaulted to true if not defined.
Can be defined in execution Context? No
executionContext : String
(optional)
TThe name of the execution context file. If the file is present at /WorkbenchCLI/EnterpriseData, the name of the file would suffice, if at a different location on the machine supply the full path with the file name. If a value for a certain argument is defined 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 /WorkbenchCLI/EnterpriseData named executioncontext_template.properties. Multiple execution contexts can be created as required by copying the template.
Optional? Yes, if this is not provided all other mandatory parameters have to be defined on the pipeline definition.
executionTimeout : String
(optional)
The execution timeout in seconds. The default if not defined is 20 seconds.
Optional? Yes
Can be defined in execution Context? Yes
defineCES : boolean
(optional)
cesURL : String
(optional)
The URL for the CES to be used for license validation. It can either be the URL for the cloud CES or a locally installed CES.
Optional? No
Can be defined in execution Context? Yes
useCloudCES : boolean
(optional)
Flag to denote if cloud CES should be used.
Optional? No
Can be defined in execution Context? Yes
cloudCustomerNo : String
(optional)
The customer number, in case the cloud CES is chosen to be used. Please contact BMC customer support if you need help with this information.
Optional? Required for cloud CES.
Can be defined in execution Context? Yes
cloudSiteID : String
(optional)
The Site ID, in case the cloud CES is chosen to be used. Please contact BMC customer support if you need help with this information.
Optional? Required for cloud CES.
Can be defined in execution Context? Yes
defineManager : boolean
(optional)
communicationManager : String
(optional)
The host name or ip of the machine where the communication manager is running. The File-AID Ex repository containing the specifications that needs to be executed should be configured on this communication manager.
Optional? No
Can be defined in execution Context? Yes
communicationManagerPort : String
(optional)
The port on which the communication manager is running. on the specified host.
Optional? No
Can be defined in execution Context? Yes
defineServer : boolean
(optional)
executionServer : String
(optional)
The host name or ip of the machine which the execution server where the EX specifications should be executed, is installed.
Optional? Required for executing EX specifications.
Can be defined in execution Context? Yes
executionServerPort : String
(optional)
The port on which the execution server is running, on the specified host.
Optional? Required for executing EX specifications.
Can be defined in execution Context? Yes
defineHost : boolean
(optional)
connectionId : String
(optional)
The execution host and port where RDX specifications should be executed.
Optional? Required for executing RDX specifications.
Can be defined in execution Context? Yes
includeCred : boolean
(optional)
defineJobcard : boolean
(optional)
jclJobcardLine1 : String
(optional)
The JCL Jobcard's line 1, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine2 : String
(optional)
The JCL Jobcard's line 2, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine3 : String
(optional)
The JCL Jobcard's line 3, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine4 : String
(optional)
The JCL Jobcard's line 4, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine5 : String
(optional)
The JCL Jobcard's line 5, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
defineQualifiers : boolean
(optional)
datasetHighLevelQualifier : String
(optional)
The dataset high level qualifier to be used. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
temporaryDatasetPrefix : String
(optional)
The prefix to be used for temporary datasets. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
temporaryDatasetSuffix : String
(optional)
The suffix to be used for temporary datasets. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
defineDataprivacyOverride : boolean
(optional)
dpOverrideFADEBUG : String
(optional)
The data privacy override FADEBUG, that defines the logging information for the File-AID Rules Engine. Only applicable for RDX Extract executions.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAEXPATH : String
(optional)
The data privacy override FAEXPATH, that defines the path for File-AID Rules Engine location. Only applicable for RDX Extract executions.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAIPADDR : String
(optional)
The data privacy override FAIPADDR, that provides the File-AID Services IP address and execution port.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAJOPTS : String
(optional)
The data privacy override FAJOPTS, that defines the Java options for the File-AID Rules Engine.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAJPATH : String
(optional)
The data privacy override FAJAPTH, that defines the z/OS UNIX path for the Java Virtual Machine.
Optional? Yes
Can be defined in execution Context? Yes
haltPipelineOnFailure : boolean
(optional)
credentialsId : String
(optional)
The credentials for the selected execution host.
Optional? Required for executing RDX specifications.
Can be defined in execution Context? No
Note: If keystore or certificate needs to be used, leave this field empty and define the parameters in the execution context. The support for keystore and certificate based authentication via this jenkins plugin will be added in a future version.
Was this page helpful?
Please submit your feedback about this page through this
quick form.
Alternatively, if you don't wish to complete the quick form, you can simply
indicate if you found this page helpful?
See existing feedback here.