Print Page as PDF
XQALBUTL ICR (3197)

XQALBUTL    ICR (3197)

Name Value
NUMBER 3197
IA # 3197
DATE CREATED 2000/09/19
CUSTODIAL PACKAGE TOOLKIT
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XQALBUTL
NAME XQALBUTL
GENERAL DESCRIPTION
The DELSTAT entry point in XQALBUTL is a SUPPORTED
reference for obtaining information on the recipients of the most recent alert
with a specified alert id and the status of whether the alert has been deleted
or not for those recipients.

DELSTAT - For the most recent alert with XQAIDVAL as the PackageID passed in,
on return array VALUES contains the DUZ for users in VALUES along with an
indicator of whether the alert has been deleted or not, e.g., DUZ^0 if not
deleted or DUZ^1 if deleted.  Note that contents of VALUES will be killed
prior to building the list.

Example:   D DELSTAT^XQALBUTL("OR;14765;23",.RESULTS)

Returned:   The value of RESULTS indicates the number of entries in
the array.  The entries are then ordered in numerical
order in the RESULTS array.
RESULTS = 3
RESULTS(1) = "146^0"   User 146 - not deleted
RESULTS(2) = "297^1"   User 297 - deleted
RESULTS(3) = "673^0"   User 673 - not deleted
STATUS Active
KEYWORDS
  • ALERTS
  • DELETION
  • DELETE
  • STATUS
  • ALERT
  • RECIPIENTS
DURATION Till Otherwise Agreed
ID XQALBUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DELSTAT
DELSTAT - For the most recent alert with XQAIDVAL as
the PackageID passed in, on return array VALUES contains the DUZ for users in
VALUES along with an indicator of whether the alert has been deleted or not,
e.g., DUZ^0 if not deleted or DUZ^1 if deleted.  Note that contents of VALUES
will be killed prior to building the list.

Example:   D DELSTAT^XQALBUTL("OR;14765;23",.RESULTS)

Returned:   The value of RESULTS indicates the number of entries in
the array.  The entries are then ordered in numerical
order in the RESULTS array.
RESULTS = 3
RESULTS(1) = "146^0"   User 146 - not deleted
RESULTS(2) = "297^1"   User 297 - deleted
RESULTS(3) = "673^0"   User 673 - not deleted
VARIABLES TYPE VARIABLES DESCRIPTION
XQAIDVAL Input
XQAIDVAL is a value which has been used as the XQAID
value for generating an alert by a package.  This value is used to identify
the most recent alert generated with this XQAID value and that alert is used
to generate the responses in terms of recipients and deletion status of the
alert for each of the recipients.
VALUES Output
This variable is passed by reference and is returned
as an array.  This value is KILLED prior to generation of the results for
return.

Returned:   The value of VALUES indicates the number of entries in
the array.  The entries are then ordered in numerical
order in the VALUES array.
VALUES = 3
VALUES(1) = "146^0"   User 146 - not deleted
VALUES(2) = "297^1"   User 297 - deleted
VALUES(3) = "673^0"   User 673 - not deleted