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

R3_ACTIVATE_REPORT

Processes the specified report. If required, you can select a variant and parameters for list controlling matters.

Transaction: SM36, SM37

Interface: AE and Standard

Syntax

R3_ACTIVATE_REP[ORT]

Syntax Description/Format
REP[ORT]= The name of the report.
Format: script literal
VAR[IANT]= The name of the variant.
Format: script literal
Print Parameters  
DEST[INATION]=

The 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 you cannot use the long SAP printer names for technical reasons caused by SAP's XBP interface. Use the 4-digit technical name instead.

COPIES=

The number of copies.
Format: Integer

Default value: 0

Here you specify the number of document copies that should be printed.

LIST_N[AME]=

The name of the spool request.
Format: script literal

This parameter can be used to specify 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 can be used to specify the descriptive text for the spool request. It can consist of any letters, numbers, special characters and blanks.

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 will be deleted immediately after printing at the output device or only when the spool retention period has expired.

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 how many days a spool request is kept in the spool system before it will be deleted.

LINE_COUNT=

The page length of list.
Format: Integer

Default value: 0

The number of lines per list page. When this field contains a zero or if it is empty, the number of pages of the particular list is not limited (not allowed for printing). In this case, the page length of the list is only determined by its content. For printing, the maximum number of lines per page depends on the selected format. You can select a different format to have the number of lines changed.

LINE_SIZE=

The 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=

Editing for printout.
Format: script literal

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

COVER[PAGE]=

The selection of a cover page.
Format: script literal

Allowed values: YES and NO (default value)

This parameter determines whether a cover page with report selections is printed at the beginning. When a cover page is created, it will be adjusted to the job report. This documents which parameters were used for this execution.

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.

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.

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's name is used by default.

DEPART[MENT]=

The departmentDepartment name to which the Automation Engine user belongs. name as it is printed on the cover page.
Format: script literal

This parameter contains the department name for the spool request.

AUTHORITY=

Authorization.
Format: script literal

This parameter contains authorization for the spool request (maximum of 12 characters). The content of the spool request is only displayed to authorized users.

DATA_SET= The name of the spool dataset.
Format: script literal
TYPE= The type of spool request.
Format: script literal
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_M[ODE]=

The archiving mode.
Format: script literal

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

1 - The document should only be printed.
2 -The document should only be saved in the optical archive.
3 - The 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.

See:  Archive Parameters with R3_ACTIVATE_REPORT

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 logging of status monitoring in the activation log.
Format: script literal

Allowed Values: YES and NO (default value)

Parameters for
parent child relationship

 

WAIT=

Waits for SAP job children to end.
Format: script literal or UC Name

Allowed values: YES and NO (default value)

YES - Wait for all children to end. Children are logged in the activation report.
NO - Do not wait for all children to end.

ABORTED=

Reaction to abnormal end of SAP job children.
Format: script literal or AE name

Allowed values: YES (default value) and NO

YES - SAP job (parent) is aborted. The script is not continued and the AE job ends abnormally.
NO - SAP job (parent) is not aborted. The script is continued and the AE job ends normally. 

REPL[ICATE]=

The handling of children of intercepted jobs.
Format of the value: script literal

Allowed values: YES and NO (default value)

YES - The children of a job are replicated in the AE system. They are displayed in the UserInterface's Activity Window. Statistical records and reports are created in the AE system.
NO - There is no replication in the AE system.

BEG_LOGLINES= This parameter determines the number of lines that should be assumed to the AE job report (starting with the SAP job log's beginning).
END_LOGLINES=

The number of lines that should be written to the AE job report (starting with the SAP job log's ending).

By default, the complete job log is used if neither the parameter END_LOGLINES nor BEG_LOGLINES has been specified. If only one of these two parameters has been specified, the corresponding job-log lines (either from the beginning or the end) are read.
No job log is transferred if the value "0" has been specified in both parameters.

In both parameters, you can only use numeric values.

GET_SPOOL=

This requests the spool list of the started job.
Format of the value: script literal

Allowed values: YES or NO (default)

YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP agent's INI file with the parameter Download_dir= (section [GLOBAL]). The name of this file is structured as follows:
<SAP job count>_<step number>_<spool number>.txt
This file is also registered as job output in the AE job.

NO = The spool list is not requested.

The spool list is requested for ALL child jobs if you use this script element several times in an SAP job and if you combine all the individual job steps by using the option "Combine job steps" in the Connection objecteven if the parameter GET_SPOOL="YES" is only set for one R3_ACTIVE_REPORT.

Spool entries of children are only requested when the parameter REPLICATE= is either set to YES or to ALL.

Comments

This script element enables the modification of an ABAP step. The name of the report, variant and various archiving and print parameters for the ABAP step can be reset when the SAP job has been selected. 

This parameter corresponds to the SAP Dictionary Structure PRI_PARAMS and ARC_PARAMS fields. Please use the dictionary or the BAPI Browser to get detailed information about the individual fields.

Instead of using a variant, the selection criteria can also be assigned using the script element R3_SET_SELECT_OPTION.

Example

R3_ACTIVATE_REPORT REPORT='ZSUSER00',VARIANT='ALL_USERS',COVERPAGE='YES',DESTINATION='LT77',IMMEDIATELY='YES'

 

 

See also: