Task-Related Records Properties

Advanced Criteria

Note

These properties are for the Email Monitor task only.

Property	UI Field Name	Description	Specifications	Required
`body`	Body	If `bodyFilter` is any value other than None, Is Blank, or Is Not Blank; `bodyFilter` condition value.		N
`bodyFilter`	Body Filter	`body` filter condition to apply.	Valid values: As String = None, As Value = 0 As String = Equals, As Value = 1 As String = Starts With, As Value = 2 As String = Contains, As Value = 3 As String = Ends With, As Value = 4 As String = Dos Not Equal, As Value = 5 As String = Dos Not Start With, As Value = 6 As String = Does Not Contain, As Value = 7 As String = Dos Not End With, As Value = 8 As String = Is Blank, As Value = 9 As String = Is Not Blank, As Value = 10 As String = Regex, As Value = 11 Default is None (0).	N
`caseSensitive`	Case Sensitive	Text-based filters should be treated as case-sensitive.	Boolean; Valid values: true/false. Default is false.	N
`cc`	Cc	If `ccFilter` is any value other than None, Is Blank, or Is Not Blank; `ccFilter` condition value.		N
`ccFilter`	Cc Filter	`cc` filter condition to apply.	Valid values: As String = None, As Value = 0 As String = Equals, As Value = 1 As String = Contains, As Value = 3 As String = Dos Not Equal, As Value = 5 As String = Does Not Contain, As Value = 7 As String = Is Blank, As Value = 9 As String = Is Not Blank, As Value = 10 As String = Regex, As Value = 11 Default is None (0).	N
`filterLogic`	Filter Logic	Logic to apply when combining filters.	Valid values: As String = And, As Value = 1 As String = Or, As Value = 2 Default is And (1).	N
`from`	From	If `fromFilter` is any value other than None; `fromFilter` condition value.		N
`fromFilter`	From Filter	`from` filter condition to apply.	Valid values: As String = None, As Value = 0 As String = Equals, As Value = 1 As String = Contains, As Value = 3 As String = Dos Not Equal, As Value = 5 As String = Does Not Contain, As Value = 7 As String = Regex, As Value = 11 Default is None (0).	N
`subject`	Subject	If `subjectFilter` is any value other than None, Is Blank, or Is Not Blank; `subjectFilter` condition value.		N
`subjectFilter`	Subject Filter	`subject` filter condition to apply.	Valid values: As String = None, As Value = 0 As String = Equals, As Value = 1 As String = Starts With, As Value = 2 As String = Contains, As Value = 3 As String = Ends With, As Value = 4 As String = Dos Not Equal, As Value = 5 As String = Dos Not Start With, As Value = 6 As String = Does Not Contain, As Value = 7 As String = Dos Not End With, As Value = 8 As String = Is Blank, As Value = 9 As String = Is Not Blank, As Value = 10 As String = Regex, As Value = 11 Default is None (0).	N
`to`	To	If `toFilter` is any value other than None, Is Blank, or Is Not Blank; `toFilter` condition value.		N
`toFilter`	To Filter	`to` condition to apply.	Valid values: As String = None, As Value = 0 As String = Equals, As Value = 1 As String = Contains, As Value = 3 As String = Dos Not Equal, As Value = 5 As String = Does Not Contain, As Value = 7 As String = Is Blank, As Value = 9 As String = Is Not Blank, As Value = 10 As String = Regex, As Value = 11 Default is None (0).	N

Job Steps

Note

These properties are for the SAP task only.

ABAP Program Job Step

Property	UI Field Name	Description	Specifications	Required
`username`	SAP User Name	User name in the SAP system.		N
`variantName`	Variant Name	Variant to use to process the report.		N
`programName`	Name	Name of the ABAP Program, External Program or External Command to be processed in the background.		Y
`type`	Type	Job step type.	XML: `type` is read-only. The job step `type` is determined by its element name (abapProgram, externalCommand, externalProgram). Valid Values: As String = ABAP Program As String = External Command As String = External Program Default is ABAP Program.	N
`language`	Execution Language	Specifies the language in which the system executes and prints the output.		N
`stepOrder`	Step Order	Order for Job Steps.	Integer	N
`sysId`	n/a	`sys_id` used within the Controller to identify this Job Step.		N
`useTemporaryVariant`	Use Temporary Variant	Specification for whether or not to use Temporary Variant.	Boolean; Valid values: true/false. Default is false.	N
`temporaryVariant`	Temporary Variant	XML: `<temporaryVariant> <variantParameter> <high>Z</high> <low>A</low> <technicalName>NAME1</technicalName> <option>Between</option> <sign>Include</sign> <type>Selection</type> </variantParameter> <variantParameter> <high /> <low>ABC</low> <technicalName>NAME2</technicalName> <option>Contains Pattern</option> <sign>Exclude</sign> <type>Parameter</type> </variantParameter> </temporaryVariant>` JSON: `"temporaryVariant": [ { "high": "Z", "low": "A", "technicalName": "NAME1", "option": "Between", "sign": "Include", "type": "Selection" }, { "high": null, "low": "ABC", "technicalName": "NAME2", "option": "Contains Pattern", "sign": "Exclude", "type": "Parameter" } ]`	See Temporary Variant payload properties.	Y if `useTemporaryVariant` is true
`printParameters`		XML: `<printParameters> <numberOfCopies>3</numberOfCopies> <outputDevice>output device</outputDevice> <pageArea>Page</pageArea> <pageFrom>1</pageFrom> <pageTo>5</pageTo> <printTime>Immediately</printTime> </printParameters>` JSON: `"printParameters": { "numberOfCopies": 3, "outputDevice": "output device", "pageArea": "Page", "pageFrom": 1, "pageTo": 5, "printTime": "Immediately" }`	See Print Parameters payload properties.	N

Print Parameters

Property	UI Field Name	Description	Specifications	Required
`outputDevice`	Output Device	Specifies the printer or fax machine.		N
`printTime`	Print Time	Specifies when the spool request will be sent to the output device.	Valid Values: As String = SAP Spool Only, As Value = 1 As String = Immediately, As Value = 2 Default is SAP Spool Only (1).	N
`numberOfCopies`	Number of Copies	Number of printouts.	Integer	N
`pageFrom`	Page From	First page in the range of pages to be printed.	Integer	Y if `pageArea` is Page
`pageTo`	Page To	Last page in the range of pages to be printed.	Integer	Y if `pageArea` is Page
`pageArea`	Page Area	Specifies if everything should be printed or select pages.	Valid Values: As String = Everything, As Value = 1 As String = Page, As Value = 2 Default is Everything (1).	N
`format`	Format			N
`outputContent`		XML: `<outputContent> <maxSpoolWidth>Yes</maxSpoolWidth> <noFrame>Yes</noFrame> <noShade>Yes</noShade> <structureInformation>Yes</structureInformation> <textOnly>Yes</textOnly> </outputContent>` JSON: `"outputContent": { "maxSpoolWidth": "Yes", "noFrame": "Yes", "noShade": "Yes", "structureInformation": "Yes", "textOnly": "Yes" }`	See Output Content payload properties.	N
`spoolRequest`		XML: `<spoolRequest> <authorization>authorization</authorization> <name>spool request name</name> <title>title</title> </spoolRequest>` JSON: `"spoolRequest": { "authorization": "authorization", "name": "spool request name", "title": "title" }`	See Spool Request payload properties.	N
`coverSheets`		XML: `<coverSheets> <department>dep</department> <osCoverSheet>Do Not Print</osCoverSheet> <receivers>rec</receivers> <sapCoverSheet>Do Not Print</sapCoverSheet> <selectionCoverSheet>Yes</selectionCoverSheet> </coverSheets>` JSON: `"coverSheets": { "department": "department", "osCoverSheet": "Do Not Print", "receivers": "receivers", "sapCoverSheet": "Do Not Print", "selectionCoverSheet": "Yes" }`	See Cover Sheets payload properties.	N
`outputOptions`		XML: `<outputOptions> <deleteAfterPrinting>Unspecified</deleteAfterPrinting> <documentType /> <information /> <newSpoolRequest>Unspecified</newSpoolRequest> <objectType /> <printPriority>Unspecified</printPriority> <spoolRetention>Unspecified</spoolRetention> <storageMode>Unspecified</storageMode> <text /> </outputOptions>` JSON: `"outputOptions": { "deleteAfterPrinting": "Unspecified", "documentType": null, "information": null, "newSpoolRequest": "Unspecified", "objectType": null, "printPriority": "Unspecified", "spoolRetention": "Unspecified", "storageMode": "Unspecified", "text": null }`	See Output Options payload properties.	N

Print Parameters: Output Content

Property	UI Field Name	Description	Specifications	Required
`maxSpoolWidth`	Spool Request Maximum 255 Character Width	Specification for a line break in spool after 255 characters.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`textOnly`	Text Only	Specification to print text output only.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`noShade`	Suppress Colors/Shading In Printout	Specifies if colors/shading are included in spool list.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`structureInformation`	Spool List With Structure Information	Specifies if structure information is inserted into the print request.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`noFrame`	No Frame Characters	Specifies if no frame characters are printed.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N

Print Parameters: Spool Request

Property	UI Field Name	Description	Required
`name`	Spool Request Name	The name of the spool request if not printed immediately.	N
`title`	Title	Description text for the spool request, appears on the default cover page and is displayed in the output controller instead of the value of the Spool Request Name.	N
`authorization`	Authorization	Authorization for the spool request. This can be used to check whether or not a user is allowed to carry out certain actions on the spool request.	N

Print Parameters: Cover Sheets

Property	UI Field Name	Description	Specifications	Required
`sapCoverSheet`	SAP Cover Sheet	Specifies whether a cover page containing details about the print request - such as recipient, department, and format - is to be sent with the with the spool request.	Valid Values: As String = Unspecified, As Value = 0 As String = Default System Administrator Settings , As Value = 1 As String = Do Not Print, As Value = 2 As String = Print, As Value = 3 Default is Unspecified (0).	N
`osCoverSheet`	OS Cover Sheet	Specifies whether the standard cover page of the operating system spooler is to be sent with the spool request.	Valid Values: As String = Unspecified, As Value = 0 As String = Default System Administrator Settings , As Value = 1 As String = Do Not Print, As Value = 2 As String = Print, As Value = 3 Default is Unspecified (0).	Y
`selectionCoverSheet`	Selection Cover Sheet	Specifies whether a cover page with the input values of the selection layout is printed.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`receivers`	Receivers	Recipient name for the SAP cover page.		N
`department`	Department	Department name for the SAP cover page.		N

Print Parameters: Output Options

Property	UI Field Name	Description	Specifications	Required
`deleteAfterPrinting`	Delete After Printing	If Yes (1), spool request is deleted immediately after printing, otherwise after the value of Spool Retention.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`spoolRetention`	Spool Retention	This field specifies how many days a spool request stays in the spool system before it is deleted.	Valid Values: As String = Unspecified, As Value = 0 As String = Delete After 1 Day, As Value = 1 As String = Delete After 2 Days, As Value = 2 As String = Delete After 3 Days, As Value = 3 As String = Delete After 4 Days, As Value = 4 As String = Delete After 5 Days, As Value = 5 As String = Delete After 6 Days, As Value = 6 As String = Delete After 7 Days, As Value = 7 As String = Delete After 8 Days, As Value = 8 As String = Do Not Delete, As Value = 9 Default is Unspecified (0).	N
`newSpoolRequest`	New Spool Request	Specifies whether the system creates a new spool request.	Valid Values: As String = Unspecified, As Value = 0 As String = Yes, As Value = 1 As String = No, As Value = 2 Default is Unspecified (0).	N
`printPriority`	Print Priority	Specifies the priority to be passed on to the spool system of the operating system. A spool request with a higher priority is inserted into the spooler queue in front of a spool request with a lower priority.	Valid Values: As String = Unspecified, As Value = 0 As String = High Priority, As Value = 1 As String = Medium Priority, As Value = 2 As String = Low Priority, As Value = 3 Default is Unspecified (0).	N
`storageMode`	Storage Mode	Specifies the archiving mode.	Valid Values: As String = Unspecified, As Value = 0 As String = Print Only, As Value = 1 As String = Archive Only, As Value = 2 As String = Print And Archive, As Value = 3 Default is Unspecified (0).	N
`objectType`	Object Type	If `storageMode` = Archive Only or Print And Archive, Object type of the SAP object.		N
`documentType`	Document Type	If `storageMode` = Archive Only or Print And Archive, Document type of the archiving object.		N
`information`	Information	If `storageMode` = Archive Only or Print And Archive, Information abbreviation for the archiving request which can contain more information beside the name.		N
`text`	Text	If `storageMode` = Archive Only or Print And Archive, Description text of the archiving request.		N

Temporary Variant

Property	UI Field Name	Specifications	Required
`technicalName`	Technical Name		Y
`type`	Type	Valid Values: As String = Parameter, As Value = 1 As String = Selection, As Value = 2	Y
`low`	Lower Limit/Single Value		Y
`high`	Upper Limit		Y if `option` is `Between` or `Not Between`
`option`	Option	Valid Values: As String = Equals, or, EQ As Value = 1 As String = Not Equals, or, NE, As Value = 2 As String = Greater Than, or, GT, As Value = 3 As String = Greater Than or Equals, or, GE, As Value = 4 As String = Less Than, or, LT, As Value = 5 As String = Less Than or Equals, or, LE, As Value = 6 As String = Contains Pattern, or, CP, As Value = 7 As String = Does Not Contain Pattern, or, NP, As Value = 8 As String = Between, or, BT, As Value = 9 As String = Not Between, or, NB, As Value = 10	Y
`sign`	Sign	Valid Values: As String = Include, As Value = 1 As String = Exclude, As Value = 2	Y

External Command / External Program Job Step

Property	UI Field Name	Description	Specifications	Required
`username`	SAP User Name	User name in the SAP system.		N
`programName`	Name	Name of the ABAP Program, External Program or External Command to be processed in the background.		Y
`type`	Type	Job step type.	XML: `type` is read-only. The job step `type` is determined by its element name (abapProgram, externalCommand, externalProgram). Valid Values: As String = ABAP Program As String = External Command As String = External Program Default is ABAP Program.	N
`stepOrder`	Step Order	Order for Job Steps.	Integer	N
`sysId`	n/a	`sys_id` used within the Controller to identify this Job Step.		N
`parameters`	Parameters	Parameter string to be passed to the external program or command when the step starts.		N
`targetServer`	Target Server	Name of the host system on which you want to process a background job.		Y
`operatingSystem` For External Command Job Step only.	OS	Operating system of the application server.
`waitForTermination`	Job Waiting For External Termination	Informs SAP to wait for termination before returning.	Valid Values: As String = Unspecified, As Value = 0 As String = Do Not Wait, As Value = 1 As String = Wait, As Value = 2 As String = Wait For Event, As Value = 3 Default is Unspecified (0).	N
`logOutput`	Log Output	Specifies how to write the standard job output.	Valid Values: As String = Unspecified, As Value = 0 As String = `No Change`, As Value = 1 As String = `Close Expenditure`, As Value = 2 As String = `Return Expenditure`, As Value = 3 As String = `Return Into Trace Files`, As Value = 4 As String = `Write Into Main Storage`, As Value = 5 Default is Unspecified (0).	N
`logErrors`	Log Errors	Specifies how to write the standard error job output.	Valid Values: As String = Unspecified, As Value = 0 As String = `No Change`, As Value = 1 As String = `Close Expenditure`, As Value = 2 As String = `Return Expenditure`, As Value = 3 As String = `Write Into Main Storage`, As Value = 5 Default is Unspecified (0).	N
`traceLevel`	Activate Trace With Trace Level	Specifies the trace level.	Valid Values: As String = Unspecified, As Value = 0 As String = No Trace, As Value = 1 As String = Function Call Trace, As Value = 2 As String = Minutes Trace, As Value = 3 As String = Expression Of All Messages, As Value = 4 Default is Unspecified (0).	N

Mutually Exclusive Tasks

Property

UI Field Name

Description

Specifications

Required

sysId

n/a

sysId of the task-to-exclusive-task relationship.

N

task

Exclusive Task

Name of this Mutually Exclusive task.

Y

type

Type

Type of Mutually Exclusive task.

Valid values:

Direct

Default is Direct.

N

Notes

Property	UI Field Name	Description	Required
`sysId`	n/a	sys_id used within the Controller to identify this Note.	N
`text`	Text	Text of this note.	N
`title`	Title	Title of this note.	N

Restart Criteria

Note

These properties are for the z/OS task only.

Property	UI Field Name	Description	Specifications	Required
`directives`	Directives List	Collection of directive objects.	Valid values: As String = Start, As Value = 1 As String = Skip, As Value = 2 As String = End, As Value = 3	Y (if `restartOption` is Restart Using Directives (3))
`evaluationOrder`	Evaluation Order	Order for restart criteria evaluation.	Integer; Restart criteria with a lower order are evaluated before restart criteria with a higher order.	N
`programName`	Program	Program name to match.	A blank value or an asterisk ( * ) will match any program name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`pstepName`	Procedure	Procedure step name to match.	A blank value or an asterisk ( * ) will match any procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`restartOption`	Auto-Restart Option	Method of step selection to perform for the restart.	Valid values: As String = Restart From First Job Step, As Value = 1 As String = Restart From Matching Job Step, As Value = 2 As String = Restart Using Directives, As Value = 3 Default is Restart From First Job Step (1).	N
`stepCodes`	Condition Codes	Integer return codes from the program or ABEND codes.	Integer return codes are specified as a comma-separated list of integer values or ranges. Ranges are specified with a dash ( - ) separating the lower and upper bounds of the range. The z/OS job step return code range is 0-4095. ABEND codes are specified directly as either a user ABEND or a system ABEND. The ABEND code must be specified verbatim including leading zeroes.	Y
`stepName`	Step	Job step name to match.	A blank value or an asterisk ( * ) will match any job step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`sysId`	n/a	sys_id used within the Controller to identify this Restart Criteria.		N

RunTime Parameters

Note

These properties are for the PeopleSoft task only.

Property	UI Field Name	Description	Required
parameterName	Parameter Name	Name of this RunTime Parameter.	Y
parameterValue	Parameter Value	Value of this RunTime Parameter.	Y
processName	Process/Job Name	If `command` in PeopleSoft task = Schedule Process or Schedule Job; Name of this process/job.	Y
processType	Process Type	If `command` in PeopleSoft task = Schedule Process or Schedule Job; Type of this process.	Y
sysId	n/a	sys_id used within the Controller to identify this RunTime Parameter.	N

Step Conditions

Note

These properties are for the z/OS task only.

Property	UI Field Name	Description	Specifications	Required
`programName`	Program	Program name to match.	A blank value or an asterisk ( * ) will match any program name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`pstepName`	Procedure	Procedure step name to match.	A blank value or an asterisk ( * ) will match any procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`stepAction`	Action	Action to take and the task status to set if the Step Condition matches.	Valid values: As String = Continue/Success, As Value = 1 As String = Continue/Failed, As Value = 2 As String = Halt/Failed, As Value = 3 As String = Askoper, As Value = 4 Default is Continue/Success (1).	N
`stepCodes`	Condition Codes	Integer return codes from the program or ABEND codes.	Integer return codes are specified as a comma-separated list of integer values or ranges. Ranges are specified with a dash ( - ) separating the lower and upper bounds of the range. The z/OS job step return code range is 0-4095. ABEND codes are specified directly as either a user ABEND or a system ABEND. The ABEND code must be specified verbatim including leading zeroes.	Y
`stepName`	Step	Job step name to match.	A blank value or an asterisk ( * ) will match any job step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.	N
`stepOrder`	Evaluation Order	Order for step condition evaluation.	Integer; Step conditions with a lower order are evaluated before step conditions with a higher order.	N
`sysId`	n/a	sys_id used within the Controller to identify this Step Condition.		N

Stored Procedure Parameters

Note

These properties are for the Stored Procedure task only.

Property	UI Field Name	Description	Specifications	Required
`description`	Description	Description of this parameter.	Integer	N
`isNull`	Value is Null	Applies to the input part of a stored procedure parameter; Value for the parameter is a database NULL value. That is, if a value in a database is undefined, it is NULL, which means it has no set value. An input value can be NULL and is represented by selecting Value is Null.	Boolean; Valid values: true/false. Default is false.	N
`ivalue`	Input Value	If `paramMode` is Input and `isNull` is false; Input value of the parameter.		N
`ovalue`	n/a	If `paramMode` is Input/Output and `isNull` is false; Output value of the parameter.		N
`paramMode`	Parameter Mode	Mode of this parameter.	Valid values: As String = Input, As Value = 1 As String = Output, As Value = 2 As String = Input/Output, As Value = 3 Default is Input (1).	N
`paramType`	Parameter Type	Type of Parameter	Valid values: As String = NUMERIC, As Value = 2 As String = DECIMAL, As Value = 3 As String = INTEGER, As Value = 4 As String = SMALLINT, As Value = 5 As String = FLOAT, As Value = 6 As String = REAL, As Value = 7 As String = DOUBLE, As Value = 8 As String = VARCHAR, As Value = 12 As String = BOOLEAN, As Value = 3 As String = DATE, As Value = 91 As String = TIME, As Value = 92 As String = TIMESTAMP, As Value = 93 As String = VARBINARY, As Value = -3 As String = BIGINT, As Value = -5 Default is VARCHAR (12)	N
`paramVar`	Variable Name	If `paramMode` is Output or Input/Output; Name of the variable to assign the Output value.		Y
`pos`	Parameter Position	Position of this parameter within a list of parameters.	Integer	Y
`sysId`	n/a	sys_id used within the Controller to identify this parameter.		N
`variableScope`	Variable Scope	If `paramMode` is Output or Input/Output; Scope of the variable to assign the Output value.	Valid values: As String = Self, As Value = 1 As String = Parent, As Value = 2 As String = Top Level Parent, As Value = 3 As String = Global, As Value = 4 Default is Self (1).	Y

Variables in Tasks

Property	UI Field Name	Description	Specifications	Required
`description`	Description	Description of this variable.		N
`name`	Name	Name of this variable.	Maximum 40 alphanumerics.	N
`sysId`	n/a	sys_id used within the Controller to identify this Variable.		N
`value`	Value	Value of this variable.		Y

Virtual Resources

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive
`amount`	Amount	Amount of resources to use for this task.	Integer	Y
`sysId`	n/a	sys_id used within the Controller to identify this Virtual Resource.		N
`resource`	Resource Name	Name of this Virtual Resource.	Maximum 40 alphanumerics.	Y (unless `resourceVar` is specified)	`resourceVar`
`resourceVar`	Resource [Unresolved]	Name of a variable that will be resolved at run time to the name of the Virtual Resource.	Format: ${variable name}.	Y (unless `resource` is specified)	`resource`