SPD_alarmEvent

Purpose

D efines the portion of an event report that is specific to alert event reports. This structure is contained in SPD_event, defined elsewhere in this section. It defines the parsed version of an alert event report.

Syntax

public struct SPD_alarmEvent
{
   public SPD_alarmSeverityType severity;
   public string alarmIdentifier;
   public string alarmQualifier;
   public string alarmText;
   public string helpFile;
   public string externalActionList;
}

Description

severity

indicates the severity of the alert. SPD_alarmSeverityType is defined elsewhere in this section.

alarmIdentifier

identifies the type of alert. This value can also be the name of the optional help text file for the alert, if the value returned for helpText is NULL. This value can also be the name of the optional external action list, if the value returned for externalActionList is NULL.

alarmQualifier

further qualifies the type of alert when multiple alerts with the same alarmIdentifier are raised and must be kept distinct from one another. This value may be NULL.

alarmText

explains the alert condition.

helpText

provides help text for this alert. Help text is identified for an alert using the following set of rules:

If the value of helpText is the name of a file name in the Operations Sentinel help text folder, the contents of that file is the help text.
Otherwise, if the value of helpText is not NULL, the value of helpText is the actual help text.
Otherwise, if the value of helpText is NULL and the value of alarmIdentifier is the name of a file in the Operations Sentinel help text folder, then the contents of that file is the help text.
Otherwise, there is no help text for the alert.

externalActionList

identifies the external action list that is associated with this alert. External action lists are defined in alert policies. This value may be NULL.