Alert Actions Macros

Home  Previous  Next

A macro is a variable whose value is replaced when an Alert Action is triggered. Macros can be used to customize the content of each Alert Action.

For example: %{VALUE} is replaced by the actual current value of the parameter that triggered the alert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced by the actual current value of the parameter that triggered the alert.

Each macro listed in the tables below contains information about what triggered the PATROL alert.

Macros

Description

%{/…}

Recommended for advanced users only.

Provides an internal instance variable name to be inserted. The path is relative to the object triggering the alert.

Example: %{/worstParam} will  contain the name of the worst parameter on this instance, which is an application instance built-in variable (see the "PATROL Script Language Reference" document)

%{ALARM_TYPE}

Alarm type (INFORMATION, WARNING or ALARM)

%{ASCTIME:…}

Current date and time formatted as specified in the macro
Example: %{ASCTIME:%m %d %T %Y} will produce Jan 6 11:14:53 2015
The available formats for the %{ASCTIME:…} macro are listed in the asctime() description of the PSL Reference Guide (Book 2).

%{DATE}

Current date in the YYYY-MM-dd format.

%{HOSTNAME}

Name of the computer monitored with the PATROL Agent.

%{NEWLINE}

Linefeed. This is useful to produce multi-line information.

%{OBJECT_CLASS}

Class of the instance that triggered the alert.

%{OBJECT_ID}

PATROL internal ID of the instance that triggered the alert.

%{OBJECT_LABEL}

Display name of the instance that triggered the alert.

%{PARAMETER_NAME}

Name of the parameter that triggered the alert.

%{PARENT_CLASS}

Class of the object that the faulty instance is attached to.

%{PARENT_ID}

PATROL internal ID of the object that the faulty instance is attached to.

%{PARENT_LABEL}

Display name of the object that the faulty instance is attached to.

%{TIME}

Current time in the HH:MM:SS format.

%{VALUE}

Raw value of the parameter that triggered the alert.