| GENERAL DESCRIPTION |
NAME: GMV USER
TAG: RPC
ROUTINE: GMVRPCU
RETURN VALUE TYPE: GLOBAL ARRAY
AVAILABILITY: SUBSCRIPTION
INACTIVE: ACTIVE
WORD WRAP ON: TRUE
DESCRIPTION:
Retrieves data about the user (e.g., parameter settings).
This remote procedure call is documented in Integration Agreement 4366.
INPUT PARAMETER: OPTION
PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 10
REQUIRED: YES
SEQUENCE NUMBER: 1
DESCRIPTION:
Routine tag line to call in GMVRPCU.
INPUT PARAMETER: DATA
PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 100
REQUIRED: YES
SEQUENCE NUMBER: 2
DESCRIPTION:
Other data as required for the call.
RETURN PARAMETER DESCRIPTION:
This Remote Procedure Call (RPC) performs various actions focusing on
the user. The entry point is RPC^GMVRPCU. It has input parameters of
RESULTS, OPTION and DATA (e.g., RPC^GMVRPCU(RESULTS,OPTION,DATA)).
The RESULTS variable contains the results of the call or the location
where the results can be found.
The OPTION variable identifies another entry point in the GMVRPCU
routine that is invoked to process the call.
The DATA variable contains any values needed by the OPTION variable to
process the call.
1) When the OPTION value is SETPAR, this RPC will set and/or delete the
value of a GMV USER DEFAULTS setting (e.g., the user's default template).
The DATA value is a two part value separated by a caret. The first part
is name of a setting. The second part is the value of the setting. If
the second part is null, the existing value of the setting is deleted.
The TMP global contains:
^TMP("GMVUSER",$J,0)=1^Parameter set.
or
^TMP("GMVUSER",$J,0)=1^Parameter cleared
Example:
> S DATA="DefaultTemplate^547;VA(200,|MY DEFAULT",OPTION="SETPAR"|
> D RPC^GMVRPCU(.RESULT,OPTION,DATA) ZW RESULT
> RESULT="^TMP("GMVUSER",539374023)"
> D ^%G
> Global ^TMP("GMVUSER",$J
> ^TMP("GMVUSER",539374023,0)=1^Parameter set.
If an error is encountered, a "-1" followed by a caret and the error
message text (i.e., -1^error message) is returned.
2) When the OPTION value is GETPAR, this RPC will return the value of the
GMV USER DEFAULTS setting specified in the DATA value.
The DATA value is a one part value. It is the name of a setting (e.g.,
the user's default template).
The TMP global contains:
^TMP("GMVUSER",$J,0)=value of setting or null
Example:
> S DATA="DefaultTemplate",OPTION="GETPAR"
> D RPC^GMVRPCU(.RESULT,OPTION,DATA) ZW RESULT
> RESULT="^TMP("GMVUSER",539374023)"
> D ^%G
> Global ^TMP("GMVUSER",$J
> ^TMP("GMVUSER",539374023,0)=547;VA(200,|ONE VITAL TYPE ONLY|
3) When the OPTION value is SIGNON, this RPC will return information
about the user who is currently signed onto the system.
The DATA value is not used. The user's IEN (i.e., DUZ) to the NEW PERSON
(#200) file value must be defined when this call is made.
The RESULT variable will return the following array:
RESULT(0)=NEW PERSON (#200) file internal entry number (DUZ)
RESULT(1)=User's name (FILE 200, Field .01)
RESULT(2)=Domain (FILE 4.2) internal entry number
RESULT(3)=Domain name (FILE 4.2, Field .01)
RESULT(4)=Institution (FILE 4) internal entry number the user is signed
into (i.e., DUZ(2))
RESULT(5)=Institution name (FILE 4, Field .01)
RESULT(6)="0" or "1". "1" indicates the user has the GMV MANAGER or
programmer key. "0" indicates the user has neither key.
RESULT(7)=The user's title (FILE 200, Field 8)
RESULT(8)=This value is always null.
RESULT(9)=Number of seconds the system will wait for a response from
the user (i.e., DTIME). The default time is 300 seconds.
RESULT(10)=INSTITUTION (#4) file IEN^FILE 4 external value^station
number (e.g., 499^SUPPORT ISC^499).
Example:
> S OPTION="SIGNON"
> D RPC(.RESULT,OPTION) ZW RESULT
> RESULT="^TMP("GMVUSER",539375907)"
> D ^%G
> Global ^TMP("GMVUSER",$J
> ^TMP("GMVUSER",539375907,0)=547
1)=VITUSER,ONE
2)=334
3)=DEV.DEV.DNS
4)=499
5)=SUPPORT ISC
6)=1
7)=PROGRAMMER
8)=
9)=9999
10)=499^SUPPORT ISC^499
|
