R3_GET_MONITOR

Use the R3_GET_MONITOR script function to read data from SAP monitors and stores this information to a file. You can then prepare and edit this data by using script elements for data sequences.

Note: The timestamp is returned in UTC and may differ from your local time. You can write a script to convert the date and time to a different time zone.

More information:

Transaction: RZ20
Interface: Standard

Syntax

R3_GET_MON[ITOR]

MONITOR_SET=...
,MONITOR=...
,FILE=...

Parameters

R3_GET_MON[ITOR]
Reads data from SAP monitors

MONITOR_SET=
Name of a monitor set, limited to 60 characters
Format: name or script literal
MONITOR=
Name of a monitor, limited to 60 characters
Format: name or script literal
FILE=
Name of the file in which the result such as the current monitor data should be stored.
Format: name or script literal
Note: By default, the created files are stored on the computer on which the agent is installed. For example, R3_GET_JOB_SPOOL; FILE=
ENCODING=

(Optional) Encoding that should be used for the generated output file (FILE= parameter).

Example: UTF-8

Default value: ISO-8859-1

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

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

The SAP agent structures the individual lines that are supplied by an SAP monitor in fixed columns. The file that includes the current monitored data shows the column names and column sizes in its first line. The following columns are available:

PATH
Path specification of a value
NAME
Name of the value
VALUE
Current value
STATUS
- 1
  green
- 2
  yellow
- 3
  red
DATE
Date of monitoring
TIME
Time of monitoring
MESSAGE
Message that is displayed with a log attribute

Tips:

Client 0 includes a example of an event job that uses the R3_GET_MONITOR script element it its Pre-Process page. It reads data from an SAP monitor. You can use the PREP_PROCESS script function to generate a data sequence from the data that is read. For more information, see PREP_PROCESS.
Use the :PROCESS and :ENDPROCESS script elements to process a data sequence. Combine them with the GET_PROCESS_LINE script function to access each individual line of the data sequence and its columns. For more information, see Script Elements for Data Sequences.