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

R3_GET_MONITOR

Reads data from an SAP monitor.

Transaction: RZ20

Interface: Standard

Syntax

R3_GET_MON[ITOR]

Syntax

Description/Format

MONITOR_SET=

Name of monitor set (maximum 60 characters).
Format: Name or script literal

MONITOR=

Name of  monitor (maximum 60 characters).
Format: Name or script literal

FILE=

Name of the file in which the result (current monitor data) should be stored.
Format: Name or script literal

ENCODING=

Encoding for the generated output file (Parameter FILE=).

For example: UTF-8

Default value: ISO-8859-1

When you specify an encoding that is not supported or invalid, the job will abort with an error message.

The SAP Forms provide an input assistant for this field which lists all the supported encodings.

Comments

This script element is used to read data from an SAP monitor and store it in a file.

The SAP agent puts individual lines that are supplied by an SAP monitor into fixed columns. It stores column names and column size as the first line in the file and provides data for the current monitor. The following columns are available:

PATH - Path specification of a value,
NAME - Name of the value,
VALUE - Current value,
STATUS - Status: 1 = green, 2 = yellow, 3 = red,
DATE - Date of test,
TIME - Time of test,
MESSAGE - Message which is displayed with a protocol attribute.

Note that the time stamp is returned in UTC and can differ from your local time. Use the script element CONV_TIMESTAMP in order to convert date and time to another TimeZone (see PROP_PROCESS).

You can also prepare and edit monitor data using script elements for the data sequences. R3_GET_MONITOR is used in the event job "EVENT.R3MONITOR" in client 0000. You can create a data sequence from an SAP monitor by using the script function PREP_PROCESS.

The data sequence is processed by the script statements :PROCESS and :ENDPROCESS. In combination with the script function GET_PROCESS_LINE, you can access each individual line of the data sequence and its columns.

Note that by default, created files are saved on the computer on which the agent is installed  (for example, R3_GET_JOB_SPOOL; FILE=).

 

See also: