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

Name

Name of the ABAP Program, External Program or External Command to be processed in the background.


Y

type

Type

Job step type.


Note

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

...

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.


Note

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

operatingSystemOS

Note

For

Type =

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).

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

...