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

GETACT^XQALERT(): Return Alert Variables

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

Description

The GETACT^XQALERT API returns to the calling routine the required variables to act on a specific alert.

Format

  GETACT^XQALERT(alertid)

Input Parameters

alertid:

(required) This is the alert identifier in the ALERT TRACKING (#8992.1) file

Output Variables

XQAID:

This is the full alert identifier.
XQADATA:

The XQADATA variable stores any software application-specific data string that was passed at the time the alert was generated.
XQAOPT:

Indicates a non-menu type option on the user's primary, secondary or common menu to be run if not NULL.
XQAROU:

Indicates the routine or tag^routine to run when the alert is processed. It can have three values:

  • NULL—A NULL value indicates no routine to be used (XQAOPT contains option name to be run).

  • ^<space>—A value of ^<space> indicates that the alert is information only (no routine or option action involved).

  • ^ROUTINE or TAG^ROUTINE—The name of the routine as ^ROUTINE or TAG^ROUTINE.