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

USER^XQALERT(): Get Alerts for a User

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

Description

The USER^XQALERT API returns a list of alerts for a given user. You can return a list of all alerts for a particular user that are either:

Format

  USER^XQALERT(root[,duz][,startdate][,enddate])

Input Parameters

root:

(required) Fully resolved global or local reference in which to return a list of matching alerts.
duz:

(optional) DUZ number of user for whom the alert list is returned. If you do not pass a number, the current user's DUZ is used.
startdate:

(optional) Starting date to check for alerts. If you pass this parameter, all alerts are returned, open or closed, from the startdate until the enddate (if no enddate is specified, all alerts beyond the startdate are returned). If you omit the startdate parameter (and enddate), only currently open alerts are returned.
enddate:

(optional) Ending date to check for alerts. If you omit this parameter, but pass a startdate, all alerts are returned beyond the startdate.

Output Parameters

root:

All alerts matching the request are returned in the input parameter you specified in root, in the following format:

  root=number of matching alerts
  root(1)= "I   "_messagetext_"^"_alertid
  root(2)=...

Where the first three characters are either:

  • "I ": if the alert is informational

  • " ": if the alert runs a routine

In addition, where alertid (Alert Identifier) contains three semicolon-delimited pieces:

  1. The original software application identifier (value of XQAID).

  2. The DUZ of the alert creator.

  3. The VA FileMan date and time the alert was created.

Example

>D USER^XQALERT("ZZALRT",ZZDUZ,2900101)

>ZW ZZALRT
ZZALRT=1
ZZLART(1)="I  Test Message^NO-ID;92;2940729.10312"