<< Click to Display Table of Contents >>
CustomFilter |
Allows informing a customized filter for alarms, as an expression. The following fields are available for use on this filter expression:
•Acked (Boolean): Indicates whether this message was already acknowledged or not
•AckRequired (Boolean): Indicates whether this message must be acknowledged or not
•AckTime (Date): Date and time this alarm condition was acknowledged or zero if it was not acknowledged
•ActiveSource (Integer): -1 - None, 0 - ActiveSource, 1 - Scada, 2 - Operator, 3 - CCLink, 4 - Billing, 5 - Calculated, 6 - Database, 100 - TopologyProcessor, 101 - PowerFlow, 102 - StateEstimator, 103 - LoadShedding, 104 - DistLoadModelling, 105 - SelfHealing, or 106 - ExternalReader
•ActorID (String): User login that acknowledged this message or an empty String if this message was still not acknowledged
•AlarmSourceName (String): Name of the Alarm Source object, without its full path
•Area (String): Area of this alarm
•ChangeMask (Integer): Field not used by E3 currently, always in 0 (zero)
•ConditionActive (Boolean): Indicates whether the alarm condition is active or not
•ConditionName (String): Name of the last active alarm condition
•Cookie (Integer): Identifies an Alarm Source during an execution session
•CurrentValue (Double): Value of the Source at the moment this alarm condition became active
•Enabled (Boolean): Indicates whether the alarm check on the Alarm Source is enabled or not
•EventCategory (String): Name of the alarm category, such as "Level", "Rate of Change", "Dead Band", "Digital", ou "Discrete"
•EventTime (Date): Date and time of the last event update
•EventTimeUTC (Date): Date and time of the last event update
•EventType (String): "Event" or "Condition" (alarm)
•FormattedValue (String): Contains the formatted value of the Source at the moment this alarm condition became active
•FullAlarmSourceName (String): Full name of the Alarm Source object
•InTime (Date): Date and time this alarm condition became active
•Message (String): Alarm message
•OutTime (Date): Date and time this condition left its alarm condition or zero if it is still active
•Quality (String): "Good (xxx)", "Bad (xxx)", or "Uncertain (xxx)"
•Severity (Integer): -2: Critical, 0 - High, 1 - Medium, or 2 - Low
•Source (String): Link of the Alarm Source
•SubConditionName (String): Name of this alarm's subcondition, such as "LOLO", "LO", "HI", "HIHI", or "DIG"
User-defined fields can also be used on a filter expression, by using the named defined on the Alarm Server.
Altogether, all messages that appear on an Alarm Filter list always pass through these filters:
•Filter by type (alarm or event) (the FilterType property)
•Filter by severity (the ShowCriticalPriority, ShowLowPriority, ShowMediumPriority, and ShowHighPriority properties)
•Filter by area (the AreaFilter and SimpleAreaFilter properties)
•Filter by the CustomFilter property
•Filter by the alarm summary, which is equivalent to the expression "Enabled AND (ConditionActive OR (AckRequired AND NOT Acked))"
For usage examples of this property, please check E3Alarm's CustomFilter property.