R3_GET_MONITOR

Use the R3_GET_MONITOR script element to read data from SAP monitors and store it in a file. You can then process and edit the data using script elements for data sequences.

Transaction: RZ20

Interface: Standard

Syntax

R3_GET_MON[ITOR] MONITOR_SET=...,MONITOR=...,FILE=...[,ENCODING=...]

Parameters

Parameter	Description	Format
MONITOR_SET=	Name of the monitor set, limited to 60 characters.	Name or script literal
MONITOR=	Name of the monitor, limited to 60 characters.	Name or script literal
FILE=	Name of the file in which to store the current monitor data. Note: By default, generated files are stored on the computer on which the agent is installed.	Name or script literal
ENCODING= (Optional)	(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.	n.a.

Important Considerations

The SAP agent structures the lines supplied by an SAP monitor in fixed columns. The first line of the output file contains the column names and column widths. 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 displayed with a log attribute

Note: Timestamps are returned in UTC and may differ from your local time. For more information, see CONV_TIMESTAMP.

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