Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

USERLIST^XQALBUTL(): Get Recipient Information for an Alert

Reference Type: Supported, Category: Alerts, ICR#: 2788

Description

The USERLIST^XQALBUTL API returns recipients of the alert with the xqaid input parameter as its alert ID from the ALERT TRACKING (#8992.1) file in the array specified by the root input parameter. If root is not specified, then the data is returned in the XQALUSRS array. If the specified alert is not present, the root array is returned with a NULL value.

Format

  USERLIST^XQALBUTL(xqaid,root)

Input Parameters

xqaid:

(required) This is the value of the alert identifier. It is passed to the routine or option that is run when the alert is selected. It can also be obtained from a listing of all of the xqaid values for a specified user and/or patient.
root:

(optional) This parameter is a closed reference to a local or global root. If root is not specified, then the data is returned in the XQALUSRS array.

Output

returns:

Returns:

  • ALERT TRACKING File Entry—The information associated with the desired entry in the ALERT TRACKING (#8992.1) file descendent from the specified root.

  • NULL—If the specified alert is not present, the array root is returned with a NULL value.

Example

>D USERLIST^XQALBUTL(XQAID)

>ZW XQALUSRS XQALUSRS(1)=20^USER,XXX