Properties

The AlarmArea module has the following properties:

Name Description ID Flags
AckRequired By disabling this property, alarms generated by this module will be sent with acknowledge not required. 3400 Persisted, ExpertPage
AlmSeverityOfInactive The severity of events when going from active to inactive. 1670 Persisted, Enumerated, ExpertPage
AlmSeverityStep The step in severity when moving from one subcondition to another e.g. from HI to HIHI. 1650 Persisted, ExpertPage
AreaName The name of the process area this module represents. Several areas can be listed using ';' (semicolon). 1010 Persisted
AreaPath The path to the area this module represents. A hierarchical is specified using '.' (dot). 1020 Persisted, ExpertPage
DefaultAlmSeverity The default value of the AlmSeverity attribute for new alarm items. 1600 Persisted, ExpertPage
DefaultWatchdogPeriods The default value of the AlmWatchdogPeriods attribute for new watchdog category items. 1700 Persisted, ExpertPage
EnableAlarmEvaluation This is used to disable alarm evaluation 3300 Persisted, ExpertPage
EnableEvaluationItem If set, this item's value will enable (true) or disable (false) alarm evaluation. 3310 Persisted, ApisItem, ExpertPage
EnableInitialNormalReport By default, the first evaluation of an alarm condition is not reported if the alarm is in normal state. This property, when set, makes the AlarmAreaBee always report the result of the initial alarm evaluation. 3330 Persisted, ExpertPage
FreshestValue When TRUE, all items will be read directly from their physical source to receive the freshest possible values. 2010 Persisted, ExpertPage
GEMAreaID The SECS GEM alarm ID used to identify the alarm through SECS GEM. The value must be >1000. Value 0 is disable (default) 3600 Persisted, ExpertPage
InhibitAll Supress all alarm generation from this module. 3200 Persisted
InhibitQuality Supress alarms when quality is equal or worse than this. 3100 Persisted, Enumerated, ExpertPage
InvertInhibitSignals Invert the value read from the inhibit signals, so that a 'false' inhibit value will prevent the alarm. 1710 Persisted, ExpertPage
PriorityLevel Specifies the priority level for the working thread of this ApisAlarmAreaBee instance. 3000 Persisted, Enumerated, ExpertPage
ResetAlarms By setting this property to true all alarms will be reset if either EnablealarmEvaluation or EnableEvaluationItem is FALSE 3320 Persisted, ExpertPage
ScanPeriod The scan period in milliseconds for testing the event conditions. 1300 Persisted
TimeReferenceItem An item who's value will be used as the time reference for this module instead of the system time, when timestamping items. 200 Persisted, ApisItem, ExpertPage
UseSourceTimestamps If set to 'true', the timestamps of the monitored items will be used as event timestamps when they occur. If set to 'false', the time the event was detected by this AlarmArea module is used. 1400 Persisted, ExpertPage
WatchdogQualityEvaluation Set this property to true to include evaluation of the different quality OPC_QUALITY_GOOD 3550 Persisted, Enumerated, ExpertPage

Informational properties:

Name Description ID Flags
AlmAttributeID The global alarm attribute ID assigned from Apis Hive. 301200 InfoPage
ApisConditionEventSinkCookie The value of the cookie assigned to this module from the Apis Event Server. 301800 InfoPage
AreaName The name of the process area this module represents. Several areas can be listed using ';' (semicolon). 1010 Persisted
ConfigObserverCookie The cookie identifying this module amongst the configuration aware clients of Apis Hive. 301400 InfoPage
Server compatibility Status about which version of interface supported 301600 InfoPage
TimeSrvEventID The time client event ID assigned from the Apis time server. 301100 InfoPage

Performance properties:

NameDescriptionIDFlags
AlarmEvalTimeThe time in milliseconds used to evaluate alarms.101007PerformancePage
HiveLastUpdCountThe number of items reported as updated at the previous request.101006PerformancePage
NumAlmItemsNumber of items this ApisAlarmArea instance stores to its database.101000PerformancePage
UpdSinceQueryTimeThe time used when requesting updated items from the Hive.101005PerformancePage

See also Module Properties