Reference Type: Supported, Category: Alerts, Integration Agreement: 10081
This API deletes (clears) all alerts with the same software application
identifier, for the current user (XQAKILL=1) or all recipients (XQAKILL=0 or
XQAKILL undefined). The current user (as identified by the value of DUZ) does
not need to be a recipient of an alert; however, in that case, only a value of
0 (or undefined) for XQAKILL makes sense.
One example of the use of DELETEA^XQALERT is when a troublesome condition has been resolved. You can use this API to delete any unprocessed alerts associated with the condition. It deletes all alerts whose software application identifiers match the software application identifier you pass in the xqaid input parameter (multiple alerts can potentially share the same software application identifier).
NOTE: For more information on software application identifiers, please refer to the "Package Identifier versus Alert Identifier" topic in the Kernel Programmer Manual.
Make sure to perform the following steps before calling this API:
(required) All alerts whose software application identifier
matches the value of this input parameter will be deleted, for the
alert recipients designated by the xqakill input parameter.
(optional) XQAKILL determines how the alert is deleted. If XQAKILL is undefined or 0, the Alert Handler deletes matching alerts for all recipients. If XQAKILL is set to 1, Alert Handler deletes matching alerts for the current user, as identified by DUZ (using a value of 1 only makes sense if the current user is also a recipient, however).
August 26, 2011