Page Comparison

...

Note

title	Note

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 Task-Related Records Properties#Task-Related Records Properties#Temporary 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 Task-Related Records Properties#Task-Related Records Properties#Print 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
`format`	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

...

Property	UI Field Name	Description	Specifications	Required
`maxSpoolWidth`	Spool Request Maximum 255 Character Width	Specification for a line break in spool after 255 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
`textOnly`	Text Only	Specification to print text output 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: Specifies if colors/shading are included in spool list.	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	Specifies if structure information is inserted into the print 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
`noFrame`	No Frame Characters	Specifies if no frame characters are 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

...

Property	UI Field Name	Description	Required
`name`	Spool Request Name	The name of the spool request if not printed immediately.	N
`title`	Title	Description text for the spool request, appears on the default cover page and is displayed in the output controller instead of the value of the Spool Request Name.	N
`authorization`	Authorization	N

...

Authorization for the spool request. This can be used to check whether or not a user is allowed to carry out certain actions on the spool request.

N

Anchor

	cover_sheets
	cover_sheets

Print Parameters: Cover Sheets

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

	output_options
	output_options

...

Property	UI Field Name	Description	Specifications	Required
`deleteAfterPrinting`	Delete After Printing	If Yes (1), spool request is deleted immediately after printing, otherwise after the value of Spool Retention.	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	This field specifies how many days a spool request stays in the spool system before it is deleted.	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:	Specifies whether the system creates a 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	Specifies the priority to be passed on to the spool system of the operating system. A spool request with a higher priority is inserted into the spooler queue in front of a spool request with a lower 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	Specifies the archiving 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	If `storageMode` = Archive Only or Print And Archive, Object type of the SAP object.		N
`documentType`	Document Type	N	`information`	InformationIf `storageMode` = Archive Only or Print And Archive, Document type of the archiving object.	N
`information`	Information	If `storageMode` = Archive Only or Print And Archive, Information abbreviation for the archiving request which can contain more information beside the name.		N
`text`	Text	If `storageMode` = Archive Only or Print And Archive, Description text of the archiving request.		N

Anchor

	Temporary Variant
	Temporary Variant

...

Temporary Variant

Property	UI Field Name	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

operatingSystem

Note
For 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

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

...

Versions Compared

Old Version 2

New Version Current

Key

ABAP Program Job Step

Print Parameters

Print Parameters: Cover Sheets

Temporary Variant

External Command / External Program Job Step

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

ABAP Program Job Step

Print Parameters

Print Parameters: Cover Sheets

Temporary Variant

External Command / External Program Job Step

AnchorMutually Exclusive TasksMutually Exclusive TasksMutually Exclusive Tasks

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks