z/OS Task Properties

Task Properties: z/OS Task

Property	UI Field Name	Description	Specifications	Required	Patchable
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	Y
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 false, 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	Y (task only)
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	Y
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	Y
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	Y
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	Y
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	Y
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	Y (task only)
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	Y (task only)
msgclassNew	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	Y
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	Y
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	Y
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	Y
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	Y
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	Y
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). info If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent.	N	Y
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	Y
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	Y (task only)
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	Y (task only)
parameters	Parameters	A list of arguments, each consisting of a Name and Value, to be inserted into the JCL.	Variables are supported. Format: XML XML <parameters> <parameter> <name>NAME1</name> <value>val1</value> </parameter> <parameter> <name>NAME2</name> <value>val2</value> </parameter> </parameters> JSON JSON "parameters": [ { "name": "NAME1", "value": "val1" }, { "name": "NAME2", "value": "val2" } ]	N	Y
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: /*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	Y
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	Y (task only)
retryInterval	Retry Interval	Number of seconds between each retry.	Integer; Default is 60.	N	Y (task only)
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	Y (task only)
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	Y (task only)
scheduleId	Schedule ID	CA7 Schedule ID; for CA7 toleration only (see CA7/CA11 Toleration).		N	Y
systemOrSysaffParameter	SYSTEM or SYSAFF Override Parameter	Specifies the SYSTEM or SYSAFF parameter.	Value must conform to documented IBM JCL syntax.	N	Y (task only)
useJclSaveLib	Use JCL Save Library	If true, on rerun, the Agent submits the JCL saved from the prior submission (from the JCL Save Library) instead of reading from jclLocation or overrideJclLocation. Mutually exclusive with useOverrideLib.	Boolean; Valid values: true/false. Default is false.	N	Y
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. Mutually exclusive with useJclSaveLib.	Boolean; Valid values: true/false. Default is false.	N	Y
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	Y

Task Instance Properties: z/OS Task

Property	UI Field Name	Description	Patchable
jobname	Job Name	Name of the job executed by the task instance.	N
jobId	Job ID	Job identifier of the job executed by the task instance.	N
zosId	z/OS ID	z/OS ID	N
jclChangesConfirmed	Confirm JCL Changes	Confirm JCL Changes	N