has an ON time of when the
expression returned TRUE.Advanced Alarms have the following properties.
Alarm Tag
The name of the alarm. The name needs to be unique to the cluster. Alarm Tag names need to adhere to the Tag name syntax. If the name is not unique or is not syntactically correct it may not be recognized. If you have many tags, use a naming convention (see Using structured tag names). This makes it easier to find and debug your tags.
Note: Where Cluster Name is left blank, the name needs to be unique for defined clusters.
Cluster Name
The name of the cluster that runs this alarm. If the Cluster Name is not set, then this alarm will run on ever defined clusters.
Alarm Name
The name of the physical device associated with the alarm. This property is optional. It is only used when details of the alarm are displayed on the screen or logged to a device.
Alarm Desc
The description of the alarm. This can include variable data. This property is optional. It is only used when details of the alarm are displayed on the screen or logged to a device.
Expression
The Cicode expression that triggers the alarm. Whenever the result of the expression changes to TRUE, the alarm is triggered.
Category
The alarm category number or label.
This property is optional. If you do not specify a category, the alarm defaults to Category 0.
Delay
The delay period for the Advanced Alarm.
An Advanced Alarm becomes active when the result
of the Cicode expression triggering the alarm remains TRUE for the
duration of the delay period. The active
alarm has an ON time of when the
expression returned TRUE.
This property is optional. If you do not specify a value, the alarm becomes active as soon as the triggering expression becomes true.
Note: The delay period needs to be entered in the format HH:MM:SS (Hours:Minutes:Seconds). The value needs to be between 0 seconds (00::00) and 24 hours (24:00:00).
Help
The name of the graphics page that displays when the AlarmHelp() function is called by a user-defined command. This property is optional. If you don’t specify a help page, no action occurs when the AlarmHelp() function is called.
Comment
Any useful comment.
Extended forms fields
The following fields are implemented with extended forms (press F2).
Privilege
The privilege needed by an operator to acknowledge or disable the alarm.
Note: If you assign an acknowledgment privilege to an alarm, do not assign a privilege to the command(s) that acknowledge the alarm. If you do assign a different privilege to the commands, then an operator needs to have both privileges to acknowledge the command.
Area
The area to which the alarm belongs. If an operator does not have access to an area, the alarm is not visible on the alarm display. For example, if you enter Area 1 here, operators needs to have access to Area 1 (plus any required privileges) to acknowledge or disable this alarm.
Custom Filter1...Custom Filter8
A user-defined string for filtering active alarms.
Used in a custom Cicode query function as search
criteria, the custom alarm
filter expression enable
operators to identify and display a sub-set of active alarms.
Note:
1) The custom filters are visible only when the Digital
Alarms form is open in Extended mode.
2) The fields are not case sensitive, and can contain
'A'..'Z', 'a'..'z', '0'..'9', and the underscore '_'.
3) A custom filter cannot start with a digit.
Paging
A read/write property that indicates whether the alarm will be paged. When the value is 1 (TRUE) the alarm will be paged. The default value is 0 (FALSE). See Alarm Paging Properties. This property can be read using alarm tag browsing and read or modified when tag properties are enabled using the tag name "myCluster.myAlarm.paging".
Paging Group
A read only text string that indicates the paging group to which the alarm belongs. Maximum length is 80 characters. See your third-party paging system documentation for information on how to use this Paging Group string. This property can be read using alarm tag browsing or when tag properties are enabled read using the tagname "myCluster.myAlarm.paginggroup". For example, assign the value of PagingGroup to a variable:
myString = myCluster.Alarm_1.paginggroup
See Also