Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 2

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

UI Field Name

Description

Specifications

Required

Anchor
body - AC
body - AC
body

Body

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


N

Anchor
bodyFilter - AC
bodyFilter - AC
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

Anchor
caseSensitive - AC
caseSensitive - AC
caseSensitive

Case Sensitive

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

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

N

Anchor
cc - AC
cc - AC
cc

Cc

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


N

Anchor
ccFilter - AC
ccFilter - AC
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

Anchor
filterLogic - AC
filterLogic - AC
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

Anchor
from - AC
from - AC
from

From

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


N

Anchor
fromFilter - AC
fromFilter - AC
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

Anchor
subject - AC
subject - AC
subject

Subject

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


N

Anchor
subjectFilter - AC
subjectFilter - AC
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

Anchor
to - AC
to - AC
to

To

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


N

Anchor
toFilter - ACM
toFilter - ACM
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

Property

UI Field Name

Description

Specifications

Required

username

SAP User Name




variantName

Variant Name




programName

Program Name



Y

type

Type


Read-only.


language

Execution Language




stepOrder

Step Order


Integer


sysId

n/a

sys_id used within the Controller to identify this Job Step.



useTemporaryVariant

Use Temporary Variant


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


temporaryVariant

Temporary Variant

XML:

            <temporaryVariant>
                <variantParameter>
                    <high>Z</high>
                    <low>A*</low>
                    <name>NAME1</name>
                    <option>Between</option>
                    <sign>Include</sign>
                    <type>Selection</type>
                </variantParameter>
                <variantParameter>
                    <high />
                    <low>ABC*</low>
                    <name>NAME2</name>
                    <option>Contains Pattern</option>
                    <sign>Exclude</sign>
                    <type>Parameter</type>
                </variantParameter>
            </temporaryVariant>

JSON:

            "temporaryVariant": [
                {
                    "high": "Z",
                    "low": "A*",
                    "name": "NAME1",
                    "option": "Between",
                    "sign": "Include",
                    "type": "Selection"
                },
                {
                    "high": null,
                    "low": "ABC*",
                    "name": "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


Print Parameter

Property

UI Field Name

Description

Specifications

Required

printTime

Print Time


Valid Values:

  • As String = SAP Spool Only, As Value = 1

  • As String = Immediately, As Value = 2

Default is SAP Spool Only (1).


numberOfCopies

Number of Copies


Integer


pageFrom

Page From


Integer

Y if pageArea is Page

pageTo

Page To


Integer

Y if pageArea is Page

pageArea

Page Area


Valid Values:

  • As String = Everything, As Value = 1

  • As String = Page, As Value = 2

Default is Everything (1).


outputDevice

Output Device




Temporary Variant

Property

UI Field Name

Description

Specifications

Required

name

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

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

...