Versions Compared

Key

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

...

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

...

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

...