Kernel V. 8.0 APIs Banner [skip navigation]
VHA Office of Information - Health Systems Design and Development (HSD&D) Banner

GETACT^XQALERT(): Return Alert Variables

Reference Type: Supported, Category: Alerts, Integration Agreement: 10081

Description

This 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 file (#8992.1)

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 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.

 

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: November 15, 2006

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.