Alarm Router Tag

Help Contents
  1. Fernhill SCADA
  2. Help
  3. Drivers
  4. Message Services
  5. Alarm Router Tag

Introduction

The Alarm Router Tag Alarm Router Tag Icon forwards alarms to an email recipient. The alarms forwarded depend on:

Configuration Properties

The Alarm Router Tag supports the properties of the Core Tag plus these properties:

Property Type Version Description
ScanInterval TIME 3.26 How often the alarm router tags scans the alarms in the SCADA database. See Interval and Offset for information on how Intervals and Offsets define the time of activities.
ScanOffset WSTRING 3.26 The offset added to the ScanInterval to get the actual time the alarms are scanned.
AlarmArea1 WSTRING 3.26 The first tag database folder to scan for alarms.
AlarmArea2 WSTRING 3.26 The second tag database folder to scan for alarms.
AlarmArea3 WSTRING 3.26 The third tag database folder to scan for alarms.
AlarmArea4 WSTRING 3.26 The fourth tag database folder to scan for alarms.
MaxSeverity UINT 3.26 The highest severity alarm to include in the scan.
MinSeverity UINT 3.26 The lowest severity alarm to include in the scan.
Condition USINT 3.26 The condition needed to send an alarm. This condition must be true for the time defined by the ConditionPersistence property before the alarm is sent.
ConditionPersistence TIME 3.26 The time interval that the Condition must be true before an alarm is sent.
SendWhenConditionNotMet BOOL 3.26 Whether to send an email if an alarm no longer meets the condition.
SendWhileConditionMet BOOL 3.26 Whether to send an email if an alarm changes state while the condition is met.
EmailAddress WSTRING 3.26 The email address to send alarms to. If this property is blank, the alarm router tag will not scan for alarms.
EmailSMTPConnector WSTRING 3.26 The SMTP Connector used to send the email containing alarms. If this property is blank, the alarm router tag will not scan for alarms.
EmailSubject WSTRING 3.26 The subject line to use when sending the report using email.

AlarmArea1 to AlarmArea4

The properties AlarmArea1 to AlarmArea4 define up to four database folders to scan for alarms.

If you want to scan the entire tag database for alarms, leave all four folder names blank.

Condition Property

The Condition property sets the state an alarm must be in before it is sent as an email. The Condition property has these values:

ConditionDescription
Enabled, Active, Not Acknowledged The alarm must be enabled, active and not acknowledged before it is forwarded.
Enabled, Not Acknowledged The alarm must be enabled and not acknowledged before it is forwarded.
Note: This option usually results in the lowest number of emails sent.
Enabled, Active The alarm must be enabled and active before it is forwarded.
Enabled The alarm must be enabled before it is forwarded.
Note: This option can lead to a large number of alarm emails sent. Disabling an alarm is not a common action. Most alarms are usually enabled.
None All alarm changes are forwarded.
Note: This option can lead to a large number of alarm emails sent.

For information on alarm states see Alarm Handling.

EmailAddress and EmailSMTPConnector

The tag will not scan for alarms unless both of these properties are configured:

Dynamic Properties

The Alarm Router Tag supports the dynamic properties of the Core Tag plus these properties:

Property Type Description
MonitoredAlarmCount UDINT The number of alarms monitored by this alarm router tag. This number reflects the number of alarms that match the alarm filter.
ConditionNotMetCount UDINT The number of alarms that do not meet the Condition property.
ConditionPendingCount UDINT The number of alarms that meet the Condition property for less than the ConditionPersistence property.
ConditionMetCount UDINT The number of alarms that meet the Condition property for longer than the ConditionPersistence property.
EmailSendCount UDINT The total number of emails sent by this alarm router tag.
EmailSendState USINT A code to show the status of sending alarms by email.
EmailSendStateDescription STRING[120] The text description of the EmailSendState property.

EmailSendState Property

The EmailSendState property shows the outcome of sending the report using email. This property can have these values:

EmailSendState Description
1 No email address configured.
2 No SMTP server configured.
3 No emails sent.
4 Send in progress.
5 Send failed.
6 Send completed successfully.

Tag Commands

The Alarm Router Tag does not support any tag commands.

Relationships to Other Tag Types

The Alarm Router Tag builds on the features of these tag types:

Further Information

SMTP Connector

To learn about setting up an SMTP connector to send emails.

Alarm Handling

To learn alarm concepts in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.