Print Page as PDF
XQALSURO ICR (2790)

XQALSURO    ICR (2790)

Name Value
NUMBER 2790
IA # 2790
DATE CREATED 1999/03/25
CUSTODIAL PACKAGE KERNEL
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XQALSURO
NAME XQALSURO
GENERAL DESCRIPTION
This DBIA describes supported references in the routine
XQALSURO which may be used to obtain information on, set, or remove a
surrogate for alerts for a user.
STATUS Active
KEYWORDS
  • XQALSURO
  • ALERTS
  • SURROGATE
DURATION Till Otherwise Agreed
ID XQALSURO
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
CURRSURO
This reference is used to obtain the current
surrogate for alerts (if any for the user with DUZ specified by XQAUSER.

Usage is $$CURRSURO^XQALSURO(XQAUSER)

The value returned is the DUZ of the surrogate or -1 if there is no surrogate
specified.
VARIABLES TYPE VARIABLES DESCRIPTION
XQAUSER Input
This is the internal entry number in file 200 (DUZ
value) for the user that the surrogate inquiry is for.
SETSURO
This entry point is used to establish (or replace) a
surrogate for the user specified by XQAUSER.  The Surrogate is specified by
passing the value of DUZ in the variable XQALSURO.  XQALSTRT is an optional
date/time for the surrogate to become active.  If XQALSTRT is not specified,
the surrogate becomes active immediately.  XQALEND is an optional date/time
when the surrogate would be removed.  If XQALEND is not specified, the
surrogate will remain active until removed.  During a period with an active
surrogate, all alerts for the user (XQAUSER) are directed towards the
surrogate (XQALSURO).
VARIABLES TYPE VARIABLES DESCRIPTION
XQAUSER Input
This is the internal entry number in file 200 (DUZ
value) for the user that the surrogate is to be set for.
XQALSURO Input
This is the internal entry number in file 200 for the
NEW PERSON entry who is to act as surrogate and receive the alerts instead of
the user XQAUSER.
XQALSTRT Input
This is an optional date-time value for when the
surrogate activity is to start, if this value is not specified, then the
surrogate will become active at the time it is set.
XQALEND Input
This is an optional date-time value for when the
surrogate activity is to stop.  When an alert is sent that is after the
specified date-time, the surrogate will be removed and alerts will be sent to
the user specified instead of the surrogate.  If this value is not specified,
the surrogate will remain active until the removed or another surrogate
specified.
REMVSURO
This entry point is used to remove any surrogates for
alerts for the specified user.
VARIABLES TYPE VARIABLES DESCRIPTION
XQAUSER Input
This is the internal entry number in file 200 (DUZ
value) for the desired user.
ACTVSURO
This entry point provides a method to determine who
is currently the active recipient for a specified user.  This may be the DUZ
of the user, or the DUZ of a surrogate designated for the user, or if the user
is no longer an active user, a value of -1.

Usage is $$ACTVSURO^XQALSURO(XQAUSER)
VARIABLES TYPE VARIABLES DESCRIPTION
XQAUSER Input
This is the DUZ value of the user for whom the
currently active alert recipient is desired.
EDITOR IVEY,JOEL
MAIL MESSAGE 29629426
Generated from AUG 12, 2020@ IA Listing Descriptions