The SmsAlarmAcknowledger component (AX-3.5 and later) provides a way for users to acknowledge alarms by sending a reply to a text message alarm notification. This component is available in the Sms palette.
In order to use the SmsAlarmAcknowledger component, you need to add and configure the component. The SmsAlarmAcknowledger properties include:
-
Status
This display-only field shows the current condition of the SmsAlarmAcknowledger. For example, the current Status may be
ok,disabled,fault, or some other condition. -
Enabled
This field allows you to enable or disable an SmsAlarmAcknowledger component by selecting the
trueorfalseoption, respectively. -
Ack Alarms From Same Source
When you select the
trueoption for this property, in addition to the current alarm, all previous alarms from this source are acknowledged with a single text reply. For example, a single control point may be going in and out of alarm repeatedly and have 23 unacked alarms reported and displayed in the alarm console. If you set this option totrueall 23 alarms are acknowledged when the SmsAlarmAcknowledger receives a single text acknowledgement. If thefalseoption is selected, a single alarm is acknowledged and 22 unacknowledged alarms remain. -
Last Alarm Acked
This field displays the identity of the last alarm that was acknowledged by the SmsAlarmAcknowledger component.
-
Last Alarm Acked Time
This field displays the time that the last alarm was acknowledged by the SmsAlarmAcknowledger component.
-
Last Alarm Acked Failure Time
If there has been a failure in the attempt to acknowledge an alarm, this field displays a message indicating the time of the last failure.
-
Last Alarm Acked Failure Cause
If there has been a failure in the attempt to acknowledge an alarm, this field displays a message indicating the possible reason for the last failure.
-
Total Alarms Acked Today
This field displays the current number of alarms that have been acknowledged for the day. This number is reset to zero at midnight.
-
Total Alarm Acked Failures
This field displays the current number of alarm acknowledgement attempts that have failed for the day. This number is reset to zero at midnight.
-
Total Messages Received Today
This field displays the current number of Sms messages that have been received for the day. This number is reset to zero at midnight.
-
Last Sms Message Received
This field displays the message and phone numbers associated with the last Sms message received.
In order to use the SmsAlarmAcknowledger component, you need to do the following:
-
Setup the SmsService
See About the SmsService.
-
Setup the SmsAlarmAcknowledger
See About the Sms Alarm Acknowledger. This includes linking the ‘Received’ topic on the SmsService to the ‘Received’ slot of the SmsAlarmAcknowleger, as shown, below.
-
Setup the SmsRecipient
In addition, note the following requirements for configuring the SmsRecipient:
-
A User is required
When properly configured, the SmsAlarmAcknowledger checks incoming text messages to see if the the sender’s phone number matches the phone number of a User that is currently in the local UserService database. No alarm is acknowledged unless it is first determined that the acknowledgement message is sent from a matching user and phone number. When validated, the User name is assigned to the alarm database as the person who has acknowledged the alarm.
-
A UUID is required
The UUID is the unique identifier that is assigned to every alarm and is used for keeping track of the alarm. For the SmsRecipient, the UUID must be in the body of the Sms message, so that it is present in the “reply to” acknowledging message. Also, this requires that the cell phone device is configured to “reply to sender with original text” (or the user may manually enter the UUID).
To ensure that the original text contains the required UUID, you must enter the following text in the SmsRecipient Body property:
UUID:%uuid%.
For related information, refer to the Sms Users Guide.