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

USERDATA^XQALBUTL(): Get User Information for an Alert

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

Description

The USERDATA^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 XQALUSER array. If the specified alert is not present, the root array is returned with a NULL value.

Format

  USERDATA^XQALBUTL(xqaid,xqauser,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.
xqauser:

(required) This is the Internal Entry Number (IEN, DUZ value) in the NEW PERSON (#200) file for the desired user.
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 XQALUSER 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 USERDATA^XQALBUTL(XQAID,20,"XXX")

>ZW XXX

XXX(.01)=20^USER,XXX XXX(.01,"RECIPIENT")=
XXX(.02)=2990212.112954^FEB 12, 1999@11:29:54XXX(.02,"ALERT FIRST DISPLAYED")= 
XXX(.03)=2990212.145609^FEB 12, 1999@14:56:09 XXX(.03,"FIRST SELECTED ALERT")=
XXX(.04)=2990212.145621^FEB 12, 1999@14:56:21 XXX(.04,"PROCESSED ALERT")= XXX(.05)=2990212.145621^FEB 12, 1999@14:56:21 
XXX(.05,"DELETED ON")= 
XXX(.06)= XXX(.06,"AUTO DELETED")=
XXX(.07)= XXX(.07,"FORWARDED BY")= 
XXX(.08)= XXX(.08,"DATE/TIME FORWARDED")=
XXX(.09)= XXX(.09,"DELETED BY USER")=