CfgAlarmCondition

Description

Alarm Conditions specify events that you might want to know about and manage as soon as they occur.

Filter Keys

Filter Name	Type	Description
state	int	Current state of an alarm condition (see CfgObjectState). If specified, Configuration Server will return information only about alarm conditions that are currently in this state.
name	string	Name of an alarm condition. Shall be specified as a character string. If specified, Configuration Server will return information only about the alarm condition(s) with that name.
dbid	int	A unique identifier of an alarm condition. If specified, Configuration Server will return information only about this alarm condition.

Attributes

• DBID — An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.
• name — A pointer to the name of the alarm condition. Mandatory. Must be unique within the Configuration Database.
• description — A pointer to the description of the alarm condition.
• category — The category of the alarm condition. Mandatory. See type CfgAlarmCategory. Default value is CFGACMajor.
• alarmDetectEvent — A pointer to the CfgAlarmEvent structure which is used to describe a log event upon which an alarm based on this alarm condition should be detected. Mandatory.
• alarmRemovalEvent — A pointer to the CfgAlarmEvent structure which is used to describe a log event upon which an alarm based on this alarm condition should be removed.
• alarmDetectScriptDBID — A unique identifier of a script which describes the logic to be applied to detect an alarm based on this alarm condition. Only a script whose type is CFGAlarmDetection can be specified. Reserved for future use. See CfgScript.
• clearanceTimeout — The period of time, in seconds, upon which an alarm based on this alarm condition has to be cleared since the moment it was detected. Default value is 24 hours (24*60*60 = 86400).
• reactionScriptDBIDs — A pointer to a list of identifiers of the CfgScript that describe reactions to an alarm based on this alarm condition. Only scripts whose type is CFGAlarmReaction can be specified. When used as an entry in CfgDeltaAlarmCondition (see below), it is a pointer to a list of identifiers of the scripts added to the existing list. See CfgScript.
• isMasked — Determines whether an alarm which is based on this alarm condition should be communicated to Solution Control Interface and reactions to the alarm should be performed. This corresponds to the default value of CFGFalse. Mandatory. See CfgFlag.
• state — Current object state. Mandatory. Refer to CfgObjectState.
• userProperties — A pointer to the list of user-defined properties. Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
• clearanceScriptDBIDs — A pointer to a list of identifiers of the CfgScript that describe clearance to an alarm based on this alarm condition. Only scripts whose type is CFGAlarmReaction can be specified. When used as an entry in CfgDeltaAlarmCondition (see below), it is a pointer to a list of identifiers of the scripts added to the existing list. See CfgScript.

XML Representation

Tip

This XML was created using the Configuration Server 7.5 schema.

<CfgAlarmCondition>
	<DBID value="101" />
	<name value="An Alarm" />
	<description value="Description." />
	<category value="2" />
	<CfgDetectEvent>
		<logEventID value="2001" />
		<selectionMode value="3" />
		<appType value="0" />
		<appDBID value="0" />
	</CfgDetectEvent>
	<CfgRemovalEvent>
		<logEventID value="2002" />
		<selectionMode value="3" />
		<appType value="0" />
		<appDBID value="0" />
	</CfgRemovalEvent>
	<alarmDetectScriptDBID value="0" />
	<clearanceTimeout value="172800" />
	<isMasked value="1" />
	<state value="1" />
</CfgAlarmCondition>

See Also

CfgDeltaAlarmCondition

CfgScript

CfgApplication