Kernel APIs: $$CREATE^XUSAP

$$CREATE^XUSAP(): Create Application Proxy User

Reference Type: Controlled Subscription, Category: Signon/Security, Integration Agreement: 4677

Description

Released with Kernel Patch XU*8.0*361, this extrinsic function is a non-interactive API to create an Application Proxy User to support J2EE middle-tier applications. The Application Proxy User represents an application and not an end-user.

The Application Proxy User is a special category of user account that gets created in the NEW PERSON file (#200) and can execute authorized RPCs. The Application Proxy User created must adhere to the following criteria:

The name added to the NEW PERSON file (#200) must be unique.
It must have a user class of "Application Proxy," as defined in the USER CLASS file (#201) and pointed to by the USER CLASS field (#9.5) in the NEW PERSON file (#200).
It must not have an Access or Verify code assigned to it.
It must not have a Primary menu assigned to it.
It must have one or more Secondary menu options assigned to it.
The RPCs that the menu options reference must have the APP PROXY ALLOWED field (#.11) in the REMOTE PROCEDURE file (#8994) set to "YES."

Format

  $$CREATE^XUSAP(proxyusername[,filemanaccesscode][,options])

Input Parameters

proxyusername:	(required) This is the name of the Application Proxy User. This name must be unique and should be namespaced.
filemanaccesscode:	(optional) This is the VA FileMan Access code. It cannot be an at-sign ("@"). NOTE: For more information, please refer to the VA FileMan Advanced User Manual.
options:	(optional) This is the name of a single option name (e.g., XUS FATKAAT PROXY LOGON) or an array of options, such as XUOPT("XMUSER")=1. Applications can only access the Remote Procedure Calls (RPCs) contained in the options provided in this input parameter. RPCs are tied to "B"-type options.

Output

returns:

Returns:

IEN of entry created in NEW PERSON file (#200)—Successful; writes new Application Proxy User to the NEW PERSON file (#200).
"0^Name In Use"—Unsuccessful; Application Proxy User of that name already exists in the the NEW PERSON file (#200).
-1—Unsuccessful; could not create Application Proxy User OR error in call to UPDATE^DIE.

NOTE: For more information on UPDATE^DIE-related error, users should check ^TMP("DIERR",$J).

Example

The following example shows a successful creation of an Application Proxy User:

>IF $$CREATE^XUSAP("FATKAAT,PROXY","","XUS FATKAAT PROXY LOGON")>0 W !,"Proxy Created"

Proxy Created

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: January 18, 2007

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.