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

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 Program, External Program or External Command to be processed in the background.


Y

type

Type

Job step type.Read-only

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 Task-Related Records Properties#Task-Related Records Properties#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 Task-Related Records Properties#Task-Related Records Properties#Print Parameters payload properties.

N

Anchor
Print Parameters
Print Parameters

Job Steps: 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

outputDevice
format

Output Device

Specifies the printer or fax machine.
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

Anchor
output_content
output_content

Print Parameters:  Output Content

Property

UI Field Name

Description

Specifications

Required

maxSpoolWidth

Spool Request Maximum 255 Character Width


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


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

noShade

Suppress Colors/Shading In Printout


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

structureInformation

Spool List With Structure Information


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

noFrame

No Frame 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

Anchor
spool_request
spool_request

Print Parameters:  Spool Request

Property

UI Field Name

Description

Specifications

Required

name

Spool Request Name



N

title

Title



N

authorization

Authorization



N

Anchor
cover_sheets
cover_sheets

Print Parameters:  Cover Sheets

Property

UI Field Name

Description

Specifications

Required

sapCoverSheet

SAP Cover Sheet


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


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

selectionCoverSheet

Selection Cover Sheet


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



N

department

Department



N

Anchor
output_options
output_options

Print Parameters:  Output Options

Property

UI Field Name

Description

Specifications

Required

deleteAfterPrinting

Delete After Printing


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

spoolRetention

Spool Retention


Valid Values:

  • As String = Unspecified, As Value = 0

  • As String = Delete After 1 Day, As Value = 1

  • As String = Delete After 2 Days, As Value = 2

  • As String = Delete After 3 Days, As Value = 3

  • As String = Delete After 4 Days, As Value = 4

  • As String = Delete After 5 Days, As Value = 5

  • As String = Delete After 6 Days, As Value = 6

  • As String = Delete After 7 Days, As Value = 7

  • As String = Delete After 8 Days, As Value = 8

  • As String = Do Not Delete, As Value = 9

Default is Unspecified (0).

N

newSpoolRequest

New Spool Request


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

printPriority

Print Priority


Valid Values:

  • As String = Unspecified, As Value = 0

  • As String = High Priority, As Value = 1

  • As String = Medium Priority, As Value = 2

  • As String = Low Priority, As Value = 3

Default is Unspecified (0).

N

storageMode

Storage Mode


Valid Values:

  • As String = Unspecified, As Value = 0

  • As String = Print Only, As Value = 1

  • As String = Archive Only, As Value = 2

  • As String = Print And Archive, As Value = 3

Default is Unspecified (0).

N

objectType

Object Type



N

documentType

Document Type



N

information

Information



N

text

Text



N

Anchor
Temporary Variant
Temporary Variant

...