Task-Related Records Properties

Body

If bodyFilter is any value other than None, Is Blank, or Is Not Blank; bodyFilter condition value.

N

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

Case Sensitive

Text-based filters should be treated as case-sensitive.

Boolean; Valid values: true/false. Default is false.

N

Cc

If ccFilter is any value other than None, Is Blank, or Is Not Blank; ccFilter condition value.

N

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

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

If fromFilter is any value other than None; fromFilter condition value.

N

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

If subjectFilter is any value other than None, Is Blank, or Is Not Blank; subjectFilter condition value.

N

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

If toFilter is any value other than None, Is Blank, or Is Not Blank; toFilter condition value.

N

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

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.

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

userCredentials

SAP User Credentials

SAP User Credentials to run the Job Step. These Credentials override the task-level SAP Credentials.

If both userCredentials and userCredentialsVar are specified, userCredentialsVar will be used.

N

userCredentialsVar

SAP User Credentials

Name of a variable that will be resolved at run time to the name of the Credentials to use.

If both userCredentials and userCredentialsVar are specified, userCredentialsVar will be used.

N

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

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

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