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

SUROFOR^XQALSURO(): Return a Surrogate's List of Users

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

Description

The SUROFOR^XQALSURO API returns a list of users for which the user, as defined by the xqauser input parameter, is acting as a surrogate.

Format

  SUROFOR^XQALSURO(xqauser,.xqalist)

Input Parameters

xqauser:

(required) This is the Internal Entry Number (IEN, DUZ value) in the NEW PERSON (#200) file for the specified user.
xqalist:

(required) Passed by reference; it contains the name of the output array.

Output Parameters

xqalist

The output contains the list of current and future surrogates for the specified user. The data in the list includes the following:

  • User's internal entry number (DUZ)

  • User's name

  • Start and end dates for the surrogate period

Set to a number equal to the count of the total number of surrogates returned in the list:

    XQALIST(n)

Where n is a sequential integer starting with 1. Each entry in the array contains:

    IEN^Name^Start Date/Time^End Date/Time

Example

>S XQAUSER=DUZ
>D SUROFOR^XQALSURO(XQAUSER,.USERLIST)

Returns:

USERLIST=count
USERLIST(1)=IEN2^NEWPERSON,USER2^STARTDATETIME^ENDDATETIME
USERLIST(2)=3^NAME,USER3^3050407.1227^3050406

>ZW USERLIST
USERLIST=2
USERLIST(1)="5206652^PERSON,FIRST^3071113.141547^3071113.142"
USERLIST(2)="5206656^PERSON,SECOND^3071114^3071114.08"