Versions Compared

Key

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

...

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

Program Name

Name of the ABAP program to be processed in the background.


Y

type

Type

Job step type.

Read-only.

N

language

Execution Language

Specifies the language in which the system executes and prints the output.


N

stepOrdern

/aStep 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>
                    <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.

N

...

...

These properties are for the SAP task only.

Print Parameters

Property

UI Field Name

Description

Specifications

Required

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

outputDevice

Output Device

Specifies the printer or fax machine.


N

...

titleNote

...

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

...