SignedAlarmAck() applied example

You can create a dashboard application to automate routine use of the SignedAlarmAck() function.

To configure signature required for alarm acknowledgement

1. Use the Industrial Graphic Editor to create a graphic. Embed the graphic elements you require, such as buttons, Alarm Control, alarm acknowledgement and commenting configuration, and comment text boxes. Examples are shown in the following illustration.

   If you embed an Alarm Control, as shown in this example, enable Requires ACK Signature in the Runtime Behavior animation to require a signature for alarm acknowledgement.

2. Add the SignedAlarmAck() script function as required. The following Industrial Graphic Editor detail shows two buttons configured with action scripts:

   

3. Configure the scripted functionality you require. Scripts for the buttons shown in the example, plus scripts for other possible button functions, are as follows:

   1. The alarm list and all other parameters are hard-coded into the script function.

      The following example requests acknowledgement of three alarms. If the alarms are within the priority range 1-500 an authentication signature will be required. The comment is disabled from the operator.

      ReturnCode = SignedAlarmAck ("Tank1.TankLevel.Lo Tank1.TankLevel.Hi Tank1.TankLevel.HiHi", True, 1, 500, "Ack Tank Level", False, "Acknowledge Alarms", "Please Acknowledge the Tank Level Alarms");

   2. The alarm list is passed as a parameter to the script from a string type Custom Property.

      The following example is the same as example 4a above, except that the alarm list is a parameter pointing to a string type Custom Property which has concatenated the names of the alarms.

      ReturnCode = SignedAlarmAck (TankLevel_Alarm_List, True, 1, 500, "Ack Tank Level", False, "Acknowledge Alarms", "Please Acknowledge the Tank Level Alarms");

   3. The alarm list is passed as a parameter to the script from an Attribute which is an array of strings.

      The following example is the same as example 4a above, except that the alarm list is a parameter pointing to a string type array Attribute which has each of the alarm names as an array element.

      ReturnCode = SignedAlarmAck (DataUDO.StringArray[], True, 1, 500, "Ack Tank Level", False, "Acknowledge Alarms", "Please Acknowledge the Tank Level Alarms");

   4. The alarm list is passed as a parameter to the script from an Attribute which is an array of strings. All other parameters are passed as script variables.

      ReturnCode = SignedAlarmAck( DataUDO.StringArray[], EnableAckSig, FromPriority, ToPriority, Default_Ack_Comment, Comment_Is_Editable, Title_Bar_Caption, Message_Caption);