Print Page as PDF
DBIA4054 ICR (4054)

DBIA4054    ICR (4054)

Name Value
NUMBER 4054
IA # 4054
DATE CREATED 2003/04/01
CUSTODIAL PACKAGE KERNEL
CUSTODIAL ISC San Francisco
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XUSRB
NAME DBIA4054
STATUS Active
KEYWORDS VISTALINK
DURATION Till Otherwise Agreed
ID XUSRB
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
LOGOUT
To log out a VistaLink user from M.
CVC
To change a VistaLink user's verify code.
VARIABLES TYPE VARIABLES DESCRIPTION
DUZ Output
If DUZ is defined, we consider the "change verify
code" operation to have been successful.
VALIDAV
To validate a VistaLink user's credentials for signon
to M.
VARIABLES TYPE VARIABLES DESCRIPTION
FIRST PARAMETER Output

;Return R(0)=DUZ, R(1)=(0=OK, 1,2...=Can't sign-on for some reason)
; R(2)=verify needs changing, R(3)=Message, R(4)=0, R(5)=msg cnt, R(5+n)
; R(R(5)+6)=# div user must select from, R(R(5)+6+n)=div
SECOND PARAMETER Input
A credential (typically the encoded "access
code;verify code" string) to use to attempt a signon for the current user.
SETUP
To setup a VistaLink user's partition in M prior to
signon.
VARIABLES TYPE VARIABLES DESCRIPTION
XWBTIP Input
We set XWBTIP to the return value of $$GETPEER^%ZOSV
prior to calling SETUP^XUSRB.
FIRST PARAMETER Output
upon return, has values set in the following
subscripts of the first parameter passed by reference: ;0=server name,
1=volume, 2=uci, 3=device, 4=# attempts, 5=skip signon-screen
XWBVER Input
If undefined, or set to less than 1.1, initiating
Kernel auto-signon will not be supported. If set to 1.1 or higher, the call to
SETUP^XUSRB will also set up the signon environment such that a subsequent
call to AUTOXWB^XUSRB can initiate Kernel auto-signon (i.e., create a handle
with the Broker client agent), if the client agent is running on the
workstation.
INTRO
To retrieve the introductory text from M to display
in VistaLink.
VARIABLES TYPE VARIABLES DESCRIPTION
FIRST PARAMETER Output
Each line in the introductory text is returned as a
value stored at the first subscript level node of the pass-by-reference first
parameter to the method call. E.g.,

RETURN(0)=line 1 RETURN(1)=line 2 etc.
$$VCVALID()
Used during the VistALink reauthentication process,
which includes support for the login capabilities of FatKAAT and KAAJEE, to
check whether a user's verify code is current.
VARIABLES TYPE VARIABLES DESCRIPTION
DUZ Input
IEN for the user in the New Person file.
$$VCVALID Output
Performs validity checks using the DUZ value.
0 if the verify code is current
1 if the verify code needs to be changed
$$INHIB1()
Used by VistALink prior to listener creation and also
during the reauthentication process to check whether logins are inhibited for
a volume set.

Environment/volume set parameters are already defined via call to XUVOL^XUS
(see IA #4762 for more information).
VARIABLES TYPE VARIABLES DESCRIPTION
$$INHIB1 Output

0 - if logins are allowed
1 - if logins to volume set are inhibited (disabled)
$$INHIB2()

Used by VistALink prior to listener creation to check if all available job
slots for a volume set are used.

Environment/volume set parameters are already defined via call to XUVOL^XUS
(see IA #4762 for more information).
VARIABLES TYPE VARIABLES DESCRIPTION
$$INHIB2 Output

0 - if job slots are available
2 - if all job slots are used
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
VISTALINK SECURITY Oakland
VISTA SERVICES ASSEMBLER