This documentation space contains information about PATROL Agents when deployed in a BMC Helix Operations Management environment. If you are a TrueSight Operations Management user, see PATROL Agent 22.1.

Defining event descriptions

You can modify standard event descriptions to provide information in the context of your environment. Thus, the event descriptions are more meaningful. You can do this by using the EventRules configuration variable (see Setting event rules) or by using Agent macros in a custom event catalog. This topic details the following information:

Using agent macros

If you are writing a new KM, insert an agent macro in the event description. If you are customizing an existing KM, define the Substitute Event Rule and then add an agent macro to it. Agent macros are expanded to the actual agent value at event publishing time. You specify the formal arguments and agent macros for an event in the event class.


In the custom event catalog "MY_KM", event class "MyClass" defines a description template as: "On host %{HOSTNAME}%, at time %{TIME}%, alert on '%s' from %s parameter '%s' cancelled; exception no longer exists.". In this example, 3 formal string arguments are "alert on '%s' from %s parameter '%s' cancelled; exception no longer exists." and the two agent macros are "%{HOSTNAME}%" and "%{TIME}%".

You must specify the 3 actual arguments for publishing time as:

event_trigger("MY_KM","MyClass", ## class "MYclass" from the "MY_KM"
event catalog "ALARM","3", ## ALARM and numerical severity of 3 "arg1", "arg2", "arg3"); ## actual argument to the event

The resulting event description will be "On host maxpc, at time 18:48:30, alert on '%s' from %s parameter '%s' cancelled; exception no longer exists." Note that the event trigger does not pass an actual argument to expand the agent macros. The agent does it automatically.

List of macros

You can use the following Agent macros to modify your event descriptions:

List of agent macros

Agent macro



PATROL Agent version (example, V3.5.00)


Upper threshold of current alarm range (example, 100)


Lower threshold of current alarm range (example, 90)


Application Class Name (example, ORACLE)


Instance Name (example, PROD1)


Average of last 10 Parameter Values (example, 3.00)


Date of Alert (MM/DD/YYYY)


Event catalog name of originating event (example, 0)


Event class name of originating event (example, 11)


Event Manager's Event Id for the alert (example, 8765)


Event severity of originating event (example, 4)


Event status of originating event (example, OPEN)


Event type of originating event (example, ALARM)


Computer name


Instance Icon Name (example, PROD1)


IP Address (example,


Instance display name (example, MEMORY)


Last 10 Parameter Values (example, 1.00 2.00 3.00 4.00 and so on.)


Overall Time Period, in minutes, of LAST10 (example, 50.00)


Last 10 Parameter Time stamps (example, 957359389 957359395 and so on.)


Values of customid1 and customid2


Operating System type (example NT, SOLARIS)


Parameter Name (example CPUBusy)


Parameter Status (example ALARM,WARN,OK)


Parameter Value (example, 99.65)


Parent Instance Name (example, /ORACLE/ORACLE)


Agent's TCP listening port (example, 3181)


Time of Alert (HH:MM:SS)


Time Zone on affected System (example, 'US/Eastern/EDT')


Agent's UDP listening port (example, 3181)

Note: Not valid for PATROL Agent version 3.9.00


Value of variable '/_my_%APPCLASS%_%APPINSTANCE%_%PARAMETER_NAME%'

The following macros cannot be expanded by the agent:




Custom identifier assigned to object


Custom identifier assigned to object


Event Manager's event id for the NOTIFY_EVENT (example, 5439)


Event Manager's event status of the NOTIFY_EVENT (example, OPEN)


Event Manager's event type of the NOTIFY_EVENT (example, ALARM)


The LOOKUP macro will not work for event catalogs.

Was this page helpful? Yes No Submitting... Thank you