Automation Engine Script Guide > AE JCL for Applications > SAP > R3_SET_PRINT_DEFAULTS

R3_SET_PRINT_DEFAULTS

Sets default values for the print parameters that are used in order to execute reports.

Transaction: -

Interface: AE and Standard

Syntax

R3_SET_PRINT_DEF[AULTS] 

Syntax

Description/Format

DEST[INATION]=

Output device.
Format: script literal

This parameter specifies the name of the output device. In most cases, this is a printer name but it can also be the name of a fax machine or the like.

Note that the long forms of SAP printer names cannot be used for technical reasons on the part of SAP's XBP interface. Use the 4-digit technical name instead.

Print Parameters

 

COVER[PAGE]=

The selection of the cover page.
Format: script literal

Allowed values: "YES" and "NO" (default value)

This parameter determines if a cover page with report selections is printed at the beginning. When a cover page is created, it is adopted to the job report. Doing so documents the parameters that have been used for this execution.

IMM[EDIATELY]=

Print immediately.
Format: script literal

Allowed values: "YES" and "NO" (default value)

REL[EASE]=

Delete after printing.
Format: script literal

Allowed values: "YES" and "NO" (default value)

This parameter specifies whether the spool request is deleted immediately after the printing process at the output device or only if the spool retention period has expired.

COPIES=

The number of copies.
Format: Integer

Default value: "0"

You can specify the number of document copies that should be printed.

LIST_N[AME]=

The name of spool request.
Format: script literal

This parameter specifies the name of the spool request. It can consist of any letters, numbers, special characters and blanks. The suggested standard name for a spool request consists of the 8 letters of the report name, the separator '_' and the first 3 letters of the user nameName of the Automation Engine user..

LIST_T[EXT]=

The text for the cover page.
Format: script literal

This parameter specifies the descriptive text for the spool request. It can consist of any letters, numbers, special characters and blanks.

NEW_LIST_ID=

A new spool request.
Format: script literal

Allowed Values: "YES" (default value) and "NO"

EXPIR[ATION]=

The spool retention period.
Format: Integer

Default value: "0"

This parameter specifies the number of days that a spool request is kept in the spool system before it is deleted.

LINE_COUNT=

Page length of list
Format: Integer

Default value: "0"

Number of lines per list page. If this field contains a zero or is empty, there is no limit in the number of pages of the particular list (not allowed for printing). The page length of the list is then only determined by its content. For printing, the maximum number of lines per page depends on the selected format. Choose another format to have the number of lines changed.

LINE_SIZE=

Width of list.
Format: Integer

Default value: "0"

This parameter contains the current line width of the list. For printing, the maximum line width depends on the selected format. Select another format to change the line width.

LAYOUT=

Print formatting.
Format: script literal

This parameter defines the print format of the spool request. The format mainly defines the page format, i.e., the maximum number of lines and columns on one printed page.

SAP_COVER[_PAGE]=

The SAP cover page.
Format: script literal

Allowed values: "" (default value), "X" and "D"

"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device (printer) whether a cover page is printed.

This parameter determines if a cover page that states the receiver name, departmentDepartment name to which the Automation Engine user belongs. name, format used and the like is printed together with the spool request.

RECEIVER=

Recipient.
Format: script literal

This parameter contains the receiver name of the spool request. This name is printed on the cover page. The current user name is the standard for the receiver name.

DEPART[MENT]=

The department name that is printed on the cover page.
Format: script literal

This parameter contains the department name for the spool request. This name is printed on the cover page.

AUTHORITY=

Authorization
Format: script literal

This parameter contains authorization for the spool request (maximum of 12 characters). Only authorized users can have content of the spool request displayed.

DATA_SET=

The name of the spool dataset.
Format: script literal

TYPE=

The type of spool request.
Format: script literal

OS_COVER[_PAGE]=

The host spool cover page.
Format: script literal

Allowed values: "" (default value), "X" and "D"

"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device (printer) whether a cover page is printed.

SPOOL_PRI[ORITY]=

The spool request priority.
Format: Integer

Default value: "5"

TEXTO[NLY]=

Plain text.
Format: script literal

Allowed values: "YES" and "NO" (default value)

Controls the output of non-ASCII characters of a print list.

FRAMES=

Frame characters.
Format: script literal

Allowed values: "YES" (default value) and "NO"

Handles default framing.

SUPPRESS_SHADING=

Colors and shades are not printed.

Allowed values: "YES", "NO" (default value)

WITH_STRUCTURE=

Structured information is included.

Allowed values: "YES", "NO" (default value)

DEFAULT_SPOOL_SIZE=

This is the definition of 255 characters as the maximum line width.

Allowed values: "YES", "NO" (default value)
"YES" = A forced line break is made after the 255th column.
"NO" = The length of the line is not limited.

PRINTER_MAIL_ADDRESS=

The email address of an email printer.
Format: script literal

SPOOL_PAGE_FROM=
SPOOL_PAGE_TO=

The number of the page as of which and until which you want to print.
Format: number

The default setting is that all pages are printed.

Archive Parameters

Archive Parameters with R3_ACTIVATE_REPORT

ARCHIVE_M[ODE]=

The archiving mode.
Format: script literal

Allowed values: "1" (default value), "2" and "3"

"1" - This document should only be printed.
"2" - This document should only be saved in the optical archive.
"3" - This document should be printed and saved in the optical archive.

ARCHIVE_S[APOBJECT]=

The object type of the business object.
Format: script literal

SAP objects are classified with object types.

ARCHIVE_O[BJECT]=

The document type.
Format: script literal

Archive objects are classified according to document types.

ARCHIVE_I[NFO]=

The information field.
Format: script literal

Information code for the archiving request.

ARCHIVE_T[EXT]=

The text information field.
Format: script literal

Descriptive text for the archiving request. It can consist of any letters, numbers, special characters and blanks.

Control Parameters

 

MON[ITOR]=

The log status monitoring in the activation log.
Format: script literal

Allowed Values: "YES" and "NO" (default value)

Comments

This script element can be used to assign default values to print parameters. They apply for the whole script or until a new default value is assigned in the script. These values only apply to the job for which they have been set.

Specifying default values increases the clarity of the AE Script. Problems with the limitation to 1024 characters per script line are avoided because the actual processing instruction is only made in the SAP agent.

This script element can exclusively be used for R3_ACTIVATE_REPORT in order to assign default values to the print parameters.

Example

In the following example, default values are set for the output device and the number of outputs that should be made.  During report execution, the number of outputs is changed to "6". This modification only applies for this particular report. The default value ("8") remains unchanged.

R3_SET_PRINT_DEFAULTS DESTINATION=PR01
R3_SET_PRINT_DEFAULTS COPIES=8
R3_ACTIVATE_REPORT REPORT=RSM04000,COPIES=6

 

See also: