| NAME |
XUS IAM RA ADD OR REPLACE |
| TAG |
ADDRA |
| ROUTINE |
XUREMAP |
| RETURN VALUE TYPE |
ARRAY |
| AVAILABILITY |
AGREEMENT |
| VERSION |
1 |
| APP PROXY ALLOWED |
No |
| DESCRIPTION |
This restricted RPC is used exclusively by the Identity and Access
Management (IAM) service to add or update (rip/replace) an entry in the
REMOTE APPLICATION file (#8994.5).
|
| INPUT PARAMETER |
-
- XUARR
- PARAMETER TYPE: LIST
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
The internal values are used to add or update a remote application.
XUARR(#)="8994.5;.01^NAME^<name of remote application>"
XUARR(#)="8994.5;.02^CONTEXTOPTION^<name of context option>"
XUARR(#)="8994.5;.03^APPLICATIONCODE^<unencrypted application code
(security phrase)>"
XUARR(#)="8994.5;.04^CAN ADD USERS^<optional: default YES {YES, NO}>"
XUARR(#)="8994.5;.05^DISABLED^<optional: default NO {YES, NO}>"
XUARR(#)="8994.51;.01^CALLBACKTYPE^<callback type {RPC-BROKER,
M2M-BROKER, HTTP, STATION-NUMBER>"
XUARR(#)="8994.51;.02^CALLBACKPORT^<optional: callback port>"
XUARR(#)="8994.51;.03^CALLBACKSERVER^<optional: callback server>"
XUARR(#)="8994.51;.04^URLSTRING^<optional: URL string>"
XUARR(#) = FILE #;FIELD #^FIELD NAME^INTERNAL VALUE^EXTERNAL VALUE
XUARR(#)="8994.5;.01^NAME^^"
XUARR(#)="8994.5;.02^CONTEXTOPTION^^" <-- must exist
XUARR(#)="8994.5;.03^APPLICATIONCODE^^"
All fields below not marked optional are required.
|
| RETURN PARAMETER DESCRIPTION |
This RPC returns success or failure.
RETURN(0) = "-1^Context Option does not exist"
RETURN(0) = "-1^Input missing Application Code."
RETURN(0) = "-1^Application Code already in use."
RETURN(0) = "-1^ <FileMan UPDATER error> "
Success (input provided to RPC updates or adds a REMOTE APPLICATION):
RETURN(0) = 1^LOCAL REM APP IEN^STATION NUMBER
Failure (no add or update occurred):
RETURN(0) = "-1^No data passed"
|