RaiseEvent()

The RaiseEvent(); rule uses the standard Network Manager alerts library to raise an event and send it to the Tivoli Netcool/OMNIbus Object Server using the Probe for Tivoli Netcool/OMNIbus, nco_p_ncpmonitor.

Syntax

The RaiseEvent(); statement uses following syntax.

RaiseEvent ( event name, 
                   severity, 
                   type, 
                   entity name, 
                   description 
                   [, optional record with extra info] );

Arguments

The following table lists the properties of the arguments of this stitcher rule.
Table 1. Arguments of RaiseEvent()
Argument Description Accepts constants Accepts variables Accepts eval clauses
event name A string value that will be available in the probe rules as the EventName field, and that by default populates the alerts.status EventId field. Yes Yes Yes
severity An integer value that will be available in the probe rules as the Severity field, and that by default populates the alerts.status Severity field. Yes Yes Yes
type An integer value that is restricted to the following values:
  • 1 (Problem)
  • 2 (Resolution)
  • 13 (Information)
This value will be available in the probe rules as the ExtraInfo_EVENTTYPE field, and that by default populates the alerts.status Type field.
Yes Yes Yes
entity name A string value that will be available in the probe rules as the EntityName field, and that by default populates the alerts.status Node field. Yes Yes Yes
description A string value that will be available in the probe rules as the Description field, and that by default populates the alerts.status Summary field. Yes Yes Yes
optional record with extra info All fields from this record will be available in the probe rules as part of the ExtraInfo field. No Yes No

Example

The following example shows how the RaiseEvent() rule is used to raise an event.

int eventSeverity = 1;
int eventType = 13; // Information

text eventDescription = "My big old test event";
text eventName = "CustomEvent";
text entityName = "SomeEntity";

Record extraInfo;
@extraInfo.ALERTGROUP = "ITNM Status";

RaiseEvent( eventName, 
       eventSeverity,
       eventType,
       entityName,
       eventDescription,
       extraInfo );