SignedAckAll()
- Last UpdatedJul 22, 2024
- 4 minute read
SignedAckAll is a script function for ArchestrA graphics to perform an acknowledgment of all the alarms on ArchestrA attributes or IADAS references within a graphic - optionally requiring a signature depending on whether any of the indicated alarms is currently waiting for an ACK and falls within a designated priority range. If so, a user must perform a log-in operation to acknowledge the alarms. This function returns an integer status indicating success or failure:
-
zero if the function succeeds
-
non-zero if the function fails or operation is canceled by the user
SignedAckAll has the similar design-time and runtime behaviors as SignedAlarmAck script function except the following:
-
Automatically detects all the ArchestrA alarms and IADAS alarms within a graphic that are waiting for an ACK
-
ACK both ArchestrA alarms and IADAS alarms
Note: AVEVA OMI ViewApps do not support the SignedAckAll method. Web Client does not support the SignedAckAll method.
Category
Miscellaneous
Syntax
int SignedAckAll(String Graphic_Instance_Name,
Boolean Include_Parent_Symbol,
Boolean Signature_Reqd_for_Range,
Integer Min_Priority,
Integer Max_Priority,
String Default_Ack_Comment,
Boolean Ack_Comment_Is_Editable,
String TitleBar_Caption,
String Message_Caption
);
Parameters
Graphic_Instance_Name
-
The Graphic_Instance_Name is the name of the embedded Visualization folder graphic or object graphic. For example, Graphic_Instance_Name = cp1, cp1 is a string type of custom property, cp1 = "symbol_0011" or cp1 = "Pump001_s11".
-
The Graphic_Instance_Name also can be the name of a specific graphic element inside a graphic. For example, "symbol_0011.Text1".
-
If Graphic_Instance_Name is empty "", this script function will ack all the alarms of the graphic where this script function resides.
Data Type
String
Valid Range
Limit 1024 characters
Additional Information
Can be a constant string, a reference, or an expression.
Include_Parent_Symbol
Indicates whether all the applicable alarms on all level parent graphics will be acknowledged when Graphic_Instance_Name is empty. If Graphic_Instance_Name is empty and Include_Parent_Symbol is true, all the applicable alarms on all level parent graphics of the graphic owning graphic will be acknowledged. If Graphic_Instance_Name is empty and Include_Parent_Symbol is false, only the applicable alarms on the graphic owning graphic will be acknowledged. If Graphic_Instance_Name is not empty, Include_Parent_Symbol option will be ignored.
Data Type
Bool
Additional Information
Can be a constant, a reference, or an expression.
Signature_Reqd_for_Range
Indicates whether a signature is required for acknowledging alarms.
Data Type
Bool
Additional Information
Can be a constant, a reference, or an expression.
Min_Priority
Represents the minimum priority value of the range for which the signature is required.
Data Type
Integer
Valid Range
1-999; must be less than or equal to the Max_Priority value.
Additional Information
Can be a constant, a reference, or an expression.
Max_Priority
Represents the maximum priority value of the range for which the signature is required.
Data Type
Integer
Valid Range
1-999; must be greater than or equal to the Min_Priority value.
Additional Information
Can be a constant, a reference, or an expression.
Default_Ack_Comment
Comment to be shown in the Acknowledge Alarms dialog box.
Data Type
String
Valid Range
Limit 200 characters
Additional Information
Can be a constant, a reference or an expression. If the parameter is empty, then no default comment is shown in the Acknowledge Alarms dialog box.
Ack_Comment_Is_ Editable
Indicates whether the run-time user can modify the acknowledgement comment.
Data Type
Bool
Additional Information
Can be a constant, a reference, or an expression. If set to False, the Comment box in the Acknowledge Alarms dialog box is unavailable.
TitleBar_Caption
Shows a title in the title bar of the Acknowledge Alarms dialog box.
Data Type
String
Valid Range
Limit 1024 characters
Additional Information
Can be a constant, a reference, or an expression. If the TitleBar_Caption is empty, the default title, Acknowledge Alarms, is shown.
Message_Caption
Shows a customizable message to the run-time user in the Acknowledge Alarms dialog box.
Data Type
String
Valid Range
Limit 250 characters
Additional Information
Can be a constant, a reference, or an expression. Use the parameter to provide more information on the alarm to the run-time user. This message is not propagated to the event record.
Return values
|
Return Value |
Data type |
Description |
|
status |
Integer |
The status values are as follows: 0 : The function returns a value of 0 (meaning success) if the following are all true:
4: If the Min_Priority > Max_Priority, the function writes a message to the Logger identifying the problem and displaying the actual values. |
Example
n = SignedAckAll ("",false,false,1,999,"Ack all by script",false,"","")