Property | UI Field Name | Description | Specifications | Required |
|---|
| Anchor |
|---|
| autoRestartOption - Z |
|---|
| autoRestartOption - Z |
|---|
|
autoRestartOption | Auto-Restart Option | Allows the z/OS job to be resubmitted with controlled step selection. | autoRestartOption is processed if a task transitions to a failed state. It works in conjunction with retryMaximum, retryInterval, and retryIndefinitely. Valid values:
- As String = -- None --, As Value = 0
- As String = Restart From First Job Step, As Value = 1
- As String = Restart From Failed Job Step, As Value = 2
- As String = Use Restart Criteria, As Value = 3
Default is – None – (0). | N |
| Anchor |
|---|
| deleteOverrideJcl - Z |
|---|
| deleteOverrideJcl - Z |
|---|
|
deleteOverrideJcl | Delete Override JCL] | If useOverrideLib is true; Allows the task to define criteria that will control the automated clean-up of the override JCL. If deleteOverrideJcl is faflse, the Controller and Agent will take no action to delete the override JCL from the target system. | Boolean; Valid values: true/false. Default is false. | N |
| Anchor |
|---|
| exitCodeOutput - Z |
|---|
| exitCodeOutput - Z |
|---|
|
exitCodeOutput | Output File | If outputType = FILE (3); Path and file name of the output file that should be scanned for the text in exitCodeText. |
| N |
| Anchor |
|---|
| exitCodeProcessing - Z |
|---|
| exitCodeProcessing - Z |
|---|
|
exitCodeProcessing | Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully. | Valid values: - As String = Success Exitcode Range, As Value = 1
- As String = Failure Exitcode Range, As Value = 2
- As String = Success Output Contains, As Value = 3
- As String = Failure Output Contains, As Value = 4
- As String = Step Conditions, As Value = 5
Default is Success Exitcode Range (1). | N |
| Anchor |
|---|
| exitCodes - Z |
|---|
| exitCodes - Z |
|---|
|
exitCodes | Exit Codes | If exitCodeProcessing = Success Exitcode Range (1) or Failure Exitcode Range (2); Range of exit codes. | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. | Y |
| Anchor |
|---|
| exitCodeText - Z |
|---|
| exitCodeText - Z |
|---|
|
exitCodeText | Scan Output For | If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); text for which the Controller should scan the output file. | The Controller will process this field as a regular expression. | Y |
| Anchor |
|---|
| jclLocation - Z |
|---|
| jclLocation - Z |
|---|
|
jclLocation | JCL Location | File and member name containing the JCL script. | When you are using the JCL_LIBRARY feature, you can substitute the name of the library with a string starting with "&", that names the library specified in the uags.conf file with the JCL_library definitions. | N |
| Anchor |
|---|
| jobClassNew - Z |
|---|
| jobClassNew - Z |
|---|
|
jobclassNew | New Jobclass | New Jobclass to replace the one in the JCL member, allowing you to override the value in your JCL without having to modify the JCL. |
| N |
| Anchor |
|---|
| jobnameNew - Z |
|---|
| jobnameNew - Z |
|---|
|
jobnameNew | New Jobname | Job name that will replace the one in the JCL member, allowing you to override the value in your JCL without having to modify the JCL. | This value should be validated before the job is launched to avoid JES start failures. Syntax: - 1-8 characters
- Upper case
- Name must start with an alphabetic or $, #, @ character.
- Remaining characters are alphanumeric or $, #, @.
- No spaces or tabs.
| N |
| Anchor |
|---|
| msgclasNew - Z |
|---|
| msgclasNew - Z |
|---|
|
msgclasNew | New Msgclass | New MSGCLASS to replace the one in the JCL member. This allows you to override the value in your JCL from the Controller without having to modify the JCL. |
| N |
| Anchor |
|---|
| outputFailureOnly - Z |
|---|
| outputFailureOnly - Z |
|---|
|
outputFailureOnly | Failure Only | If outputReturnType = FILE (4) or JOBLOG (5), and waitForOutput is false; Indication for whether output should be retrieved on task failure only. | Boolean; Valid values: true/false. Default is false. | N |
| Anchor |
|---|
| outputReturnFile - Z |
|---|
| outputReturnFile - Z |
|---|
|
outputReturnFile | Output File | If outputReturnType = FILE (4); Path and file name containing the output that you want automatically retrieved and attached to the task instance. |
| Y |
| Anchor |
|---|
| outputReturnNline - Z |
|---|
| outputReturnNline - Z |
|---|
|
outputReturnNline | Number of Lines | If outputReturnType = STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to limit the retrieved data to the number of lines specified. | Integer; Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. | N |
| Anchor |
|---|
| outputReturnSline - Z |
|---|
| outputReturnSline - Z |
|---|
|
outputReturnSline | Starting Line | If outputReturnType = STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to instruct the Controller to retrieve data beginning at this line. | Integer; Default is 1. | N |
| Anchor |
|---|
| outputReturnText - Z |
|---|
| outputReturnText - Z |
|---|
|
outputReturnText | Scan Text | If outputReturnType = STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Instructs the Controller to scan the data for the text specified and retrieve only that. | The Controller will process this field as a regular expression. | N |
| Anchor |
|---|
| outputReturnType - Z |
|---|
| outputReturnType - Z |
|---|
|
outputReturnType | Automatic Output Retrieval | Specification for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. | Valid values: - As String = NONE, As Value = 1
- As String = FILE, As Value = 4
- As String = JOBLOG, As Value = 5
Default is NONE (1).
| Note |
|---|
| If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent. |
| N |
| Anchor |
|---|
| outputType - Z |
|---|
| outputType - Z |
|---|
|
outputType | Output Type | If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); Type of output. | Valid values: - As String = STDOUT, As Value = 1
- As String = STDERR, As Value = 2
- As String = FILE, As Value = 3
Default is STDOUT (1). | Y |
| Anchor |
|---|
| overrideJclDelInstCount - Z |
|---|
| overrideJclDelInstCount - Z |
|---|
|
overrideJclDelInstCount | Override Instance Count for Deletion | If deleteOverrideJcl is true; Number of successful override instances that must occur before the override JCL library member is deleted. When the deletion criteria has been satisfied, the Controller will instruct the Agent to delete the member specified in JCL Override Location.
An override instance is considered successful only if the ending state in the controller is SUCCESS. | Integer. Default is 1. | Y |
| Anchor |
|---|
| overrideJclLocation - Z |
|---|
| overrideJclLocation - Z |
|---|
|
overrideJclLocation | JCL Override Location | If useOverrideLib is true; File and member name potentially containing an override JCL script. | The Agent will check this location for JCL before looking in the standard jclLocation. If JCL is found in this location, the job will be submitted from there. If JCL is not found in this location, the Agent will submit the job from the standard jclLocation.
Missing override JCL is not considered an error condition.
As with jclLocation, when you are using the JCL_LIBRARY feature, you can substitute the name of the library with a string starting with "&" that names the library specified in the uags.conf file with the JCL_library definitions. | N |
| Anchor |
|---|
| parameters - Z |
|---|
| parameters - Z |
|---|
|
parameters | Parameters | Any arguments needed by the program to execute properly. | Variables are supported. | N |
| Anchor |
|---|
| proclibName - Z |
|---|
| proclibName - Z |
|---|
|
proclibName | Procedure Library | Allows you to define a JES2 PROCLIB control statement in the job JCL. For example, a PROCLIB value of PROC01 will result in the following JES2 control statement generated in the job JCL: | Panel |
|---|
/*JESPARM PROCLIB=PROC001 |
The PROCLIB value must refer to a ddname defined in the JES2 procedure. Refer to IBM MVS JCL Reference for more information regarding the JES2 PROCLIB control statement. |
| N |
| Anchor |
|---|
| retryIndefinitely - Z |
|---|
| retryIndefinitely - Z |
|---|
|
retryIndefinitely | Retry Indefinitely | Specification for whether or not the Controller should continue trying indefinitely to run this task. If retryIndefinitely = yes, it overrides any value placed in retryMaximum. | Boolean; Valid values: true/false. Default is false. | N |
| Anchor |
|---|
| retryInterval - Z |
|---|
| retryInterval - Z |
|---|
|
retryInterval | Retry Interval | Number of seconds between each retry. | Integer; Default is 60. | N |
| Anchor |
|---|
| retryMaximum - Z |
|---|
| retryMaximum - Z |
|---|
|
retryMaximum | Maximum Retries | Maximum number of times that the Controller should retry this task after it has started and gone to a failed state. | Integer; Default is 0. | N |
| Anchor |
|---|
| retrySuppressFailure - Z |
|---|
| retrySuppressFailure - Z |
|---|
|
retrySuppressFailure | Suppress Intermediate Failures | Specification for whether or not the following will be suppressed until all scheduled retry attempts have been made: - All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
- Workflow conditional path processing; any Successors waiting on a failure path will not be released.
- Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
- Any Workflow containing the Failed task instance will not transition to the Running/Problems status.
| Boolean; Valid values: true/false. Default is false. | N |
| Anchor |
|---|
| scheduleId - Z |
|---|
| scheduleId - Z |
|---|
|
scheduleId | Schedule ID | CA7 Schedule ID; for CA7 toleration only (see Special Processing on z/OS Tasks#CA7/CA11 Toleration). |
| N |
| Anchor |
|---|
| systemOrSysaffParameter - Z |
|---|
| systemOrSysaffParameter - Z |
|---|
|
systemOrSysaffParameter
| SYSTEM or SYSAFF Override Parameter | Specifies the SYSTEM or SYSAFF parameter. | Value must conform to documented IBM JCL syntax. | N |
| Anchor |
|---|
| useOverrideLib - Z |
|---|
| useOverrideLib - Z |
|---|
|
useOverrideLib | Use JCL Override Library | Specification for whether or not to allow the task to work with a JCL override library on the target system.
If useOverrideLib is true, the Agent will check the JCL override path (specified in overrideJclLocation) before submitting the job from jclLocation. If a JCL member is found at the override path, the job is submitted from there. Otherwise, the Agent will look to the jclLocation path for submission. | Boolean; Valid values: true/false. Default is false. | N |
| Anchor |
|---|
| waitForOutput - Z |
|---|
| waitForOutput - Z |
|---|
|
waitForOutput | Wait For Output | If outputReturnType = FILE (4) or JOBLOG (5), and outputFailureOnly is false;; Specification for whether or not the task should wait for the requested output before completing. | Boolean; Valid values: true/false. Default is false. | N |
