Versions Compared

Old Version 7

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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



Panel
Table of Contents

Anchor
Advanced Criteria
Advanced Criteria
Advanced Criteria

...

Note
titleNote

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.


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

Anchor
Print Parameters
Print Parameters

...

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

formatFormat

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

...

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

NY

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

...

Anchor
Temporary Variant
Temporary Variant

...

Temporary Variant

Property

UI Field Name

Description

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.


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

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

...