Important

   

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

event_catalog_get()

Return information from a PATROL event catalog.

Syntax

event_catalog_get(catalog,class,format)

Parameters

ParameterDefinition

catalog

event catalog name whose information is retrieved To use the PATROL STANDARD catalog, specify STANDARD or STD.

class

event class name whose information is retrieved

format

format string used to present event catalog information See Specifying the event_catalog_get Output Format.

Description

The event_catalog_get() function returns a text string containing information from a PATROL event catalog. The event_catalog_get() function can return the following information:

  • expert advice
  • snmp support flag
  • event description text
  • escalation, notification, and acknowledge command scripts

Specifying the event_catalog_get output format

The event_catalog_get() function format parameter is similar to the specification string for the standard C library printf() function. The format parameter can contain alphanumeric characters for use as titles and field names, and string literals for spacing, tabbing, and carriage control. 

PATROL macro variables within the format parameter identify the fields that the event_catalog_get() function returns. The following table describes the macro variables available to the event_catalog_get() function.

The event_catalog_get() function macro variables return the same information that appears in the PATROL Developer Console Event Editor dialog box.

Example

The following event_catalog_get() function retrieves the text of the Escalation Command edit window for event catalog ORACLEx and event class ResetCounters:

event_catalog_get("ORACLEx","ResetCounters","%{EV_ESCL_TEXT}");



The following event_catalog_get() function also retrieves the text from the Notification Command edit window and formats each field in order to identify it in the output:

event_catalog_get(
"ORACLEx",
"ResetCounters",
"Escalation: %{EV_ESCL_TEXT}\nNotification: %{EV_NOTIFY_TEXT}"
);
Was this page helpful? Yes No Submitting... Thank you

Comments