DBIA4765 ICR (4765)

Name

Value

NUMBER

4765

IA #

4765

DATE CREATED

2005/10/06

CUSTODIAL PACKAGE

KERNEL

USAGE

Private

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUSAP

NAME

DBIA4765

GENERAL DESCRIPTION

This agreement allows the VistaLink package to use
routine XUSAP to implement the Kernel Connector Proxy/Application Proxy APIs.
These APIs are used in both VistaLink initial authentication and
reauthentication processes.  These methods have been approved by the Single
Sign-On/User Context (SSO/UC) project (part of Infrastructure & Security
Services).

See Kernel supported reference #4677 for more information.

STATUS

Active

KEYWORDS

VISTALINK SECURITY

DURATION

Till Otherwise Agreed

XUSAP

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$APFIND(NAME)

Application proxy user lookup by name.

VARIABLES	TYPE	VARIABLES DESCRIPTION
NAME	Input	NAME field (#.01) in the NEW PERSON file (#200).
$$APFIND	Output	Result returns: On failure, result returns 0. On success, result returns "IEN^VPID" of the application proxy user. (VPID = VA Person ID Number)

CONT

Interactively create (or edit if record already
exists) Connector Proxy user in the NEW PERSON file (#200).

VARIABLES	TYPE	VARIABLES DESCRIPTION
Record	Output	To create a Connector Proxy user using this option, user must hold the XUMGR key. Code will automatically set the following fields in the NEW PERSON file (#200): o FILE MANAGER ACCESS CODE (#3) = "#" o VERIFY CODE never expires (#7.2) = "Yes" o MULTIPLE SIGN-ON (#200.04) = "ALLOWED" o In the USER CLASS multiple (#200.07): o User Class (#.01) = "CONNECTOR PROXY" o ISPRIMARY (#2) = "Yes"
NAME	Input	Enter Connector Proxy name.
ACCESS CODE	Input	Can edit Access Code of Connector Proxy user.
VERIFY CODE	Input	Can edit Verify Code of Connector Proxy user.
PRIMARY MENU	Input	Can edit Primary Menu of Connector Proxy user.

$$CPCHK(IEN)

VistaLink uses this to perform Connector Proxy user
validation checks such as:
o  Check that the zero node record for the user in the NEW PERSON file
(#200) is defined.
o  Check that User Class = "CONNECTOR PROXY"
User Class value can be found by navigating to the User Class field
(#.01) of the USER CLASS sub-field (#9.5) of the NEW PERSON file
(#200)).

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

IEN of Connector Proxy user in NEW PERSON file
(#200).

$$CPCHK

Output

Used in VistaLink to validate the connector proxy
user.

If failure, result returned as "0^Error Message".
Examples:  "0^IEN not valid"
"0^Not a CONNECTOR PROXY User"

If success, result = 1.

$$RPC(RPC)

Validate that the Application Proxy user is allowed
to run a specific RPC.

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$RPC

Output

Result returns:
If failure (not allowed to run RPC), result = 0.

If success, result = 1 (the value of the APP PROXY ALLOWED field (#.11)
of the RPC BROKER file (#8994)).

RPC

Input

IEN from the RPC BROKER file (#8994).

SUBSCRIBING PACKAGE