Allows informing a customized filter for alarms, as an expression. The next table describes all fields available for use on this filter expression.
Available fields for the CustomFilter property
Field |
Data Type |
Description |
|---|---|---|
Acked |
Boolean |
Indicates whether a message was already acknowledged |
AckRequired |
Boolean |
Indicates whether users must acknowledge a message |
AckTime |
Date and Time |
Date and time an alarm condition was acknowledged or 0 (zero) if it was not acknowledged yet |
ActiveSource |
Integer |
Active Measurement Source. Possible values are -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 |
Login of the user who acknowledged a message or an empty String if that message was not acknowledged yet |
AlarmSourceName |
String |
Name of an Alarm Source object, without its full path |
AllowShelving |
Boolean |
Indicates whether an alarm can be shelved |
Area |
String |
Area of this alarm |
ChangeMask |
Integer |
Field not currently used by Elipse E3, always in 0 (zero) |
ConditionActive |
Boolean |
Indicates whether the alarm condition is active |
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 time the alarm condition becomes active |
Deleted |
Boolean |
Indicates whether the alarm was removed |
Enabled |
Boolean |
Indicates whether alarm verification on the Alarm Source is enabled |
EventCLSID |
String |
Unique identifier for the lifespan of an alarm |
EventCategory |
String |
Name of the category of an alarm, such as "Level", "Rate of Change", "Dead Band", "Digital", or "Discrete" |
EventTime |
Date and Time |
Date and time of the last update of an event |
EventTimeUTC |
Date and Time |
Date and time of the last update of an event, in UTC format |
EventType |
String |
"Event" or "Condition" (alarm) |
FormattedValue |
String |
Contains the formatted value of the Source at the moment the alarm condition becomes active |
FullAlarmSourceName |
String |
Full name of an Alarm Source object |
InTime |
Date and Time |
Date and time an alarm condition becomes active |
Message |
String |
Alarm message |
OutTime |
Date and Time |
Date and time a condition left the alarm condition or 0 (zero) if it is still active |
Quality |
String |
Quality, such as "Good (xxx)", "Bad (xxx)", or "Uncertain (xxx)" |
Severity |
Integer |
Alarm severity. Possible values are -2: Critical, 0: High, 1: Medium, or 2: Low |
ShelveActorID |
String |
Login of the user who shelved the alarm |
ShelveCount |
Word |
Number of times an event was shelved |
Shelved |
Boolean |
Indicates whether an event was shelved |
ShelvedOutTime |
Date and Time |
Date and time this event was unshelved |
ShelvedTime |
Date and Time |
Date and time this event was shelved |
ShelveDuration |
Double Word |
Time, in minutes, this event remained shelved |
ShelveMaxCount |
Word |
Maximum number of times this event can be shelved |
ShelveMaxDuration |
Double Word |
Maximum time, in minutes, this event can remain shelved |
ShelveReason |
String |
Reason to shelve this event |
Source |
String |
Link of the Alarm Source |
SubConditionName |
String |
Name of an alarm sub-condition, such as "LOLO", "LO", "HI", "HIHI", or "DIG" |
Unbound |
Boolean |
Indicates whether an alarm is linked to an Alarm Source |
UserFieldArray |
Variant |
User-defined fields. Use the field name directly in this expression, such as "UserField1 = 123" |
Altogether, all messages that appear on an Alarm Filter list always pass through these filters:
•Filter by type, defined in the FilterType property
•Filter by severity, defined in the ShowCriticalPriority, ShowLowPriority, ShowMediumPriority, and ShowHighPriority properties
•Filter by area, defined in the AreaFilter and SimpleAreaFilter properties
•Filter by this 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.