All ICR List

Package: RPC Broker ICR List

IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
1626 XWB FILE LIST Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB FILE LIST
1627 XWB FILENAME CHECK Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB FILENAME CHECK
1628 XWB API LIST Remote Procedure RPC BROKER 2006/11/17 Retired Private XWB API LIST
1629 XWB GET VARIABLE VALUE Remote Procedure RPC BROKER 2006/11/28 APPROVED Active Controlled Subscription
One can call the XWB GET VARIABLE VALUE RPC
(distributed with the RPC Broker) to retrieve the value of any M variable in
the server environment. Pass the variable name in Param[0].Value, and the
type (reference) in Param[0].PType. Also, the current context of the user
must give them permission to execute the XWB GET VARIABLE VALUE RPC (it must
be included in the RPC multiple of the "B"-type option registered with the
CreateContext function).		 XWB GET VARIABLE VALUE
1745 XWB EGCHO STRING Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB EGCHO STRING
1746 XWB EGCHO LIST Remote Procedure RPC BROKER 2006/11/17 Retired Private XWB EGCHO LIST
1747 XWB EGCHO BIG LIST Remote Procedure RPC BROKER 2006/11/17 Retired Private XWB EGCHO BIG LIST
1748 XWB EGCHO SORT LIST Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB EGCHO SORT LIST
1749 XWB EGCHO MEMO Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB EGCHO MEMO
1750 XWB RPC LIST Remote Procedure RPC BROKER 2006/11/17 Retired Supported XWB RPC LIST
1751 XWB CREATE CONTEXT Remote Procedure RPC BROKER 2006/11/17 Active Private XWB CREATE CONTEXT 2014/04/09
2018 Determining RPC Broker context Other RPC BROKER 2003/10/28 APPROVED Active Controlled Subscription
This integration agreement is temporary. The Kernel
RPC Broker is going to publish a standard method that will replace this
agreement. Subscribing packages should be prepared to use that standard
method within three months of its availability, or within a time frame
negotiated and approved by the Kernel RPC Broker.
This agreement allows packages to check for the existence of the variable
XWBOS to determine if the current routine execution was called from an RPC
Broker context. This is needed to control user interface actions that are
dependent on whether they are roll-and-scroll based or GUI based.
2198 TEST FOR BROKER CONTEXT Routine RPC BROKER 1997/11/19 APPROVED Active Supported
Use this function in the M code called by an RPC to
determine if the current process is being executed by the Broker.		 XWBLIB
2238 CHANGE RPC RETURN TYPE Routine RPC BROKER 1997/11/19 APPROVED Active Supported
Use this function in the M code called by an RPC to
change the return value type that the RPC will return on the fly.		 XWBLIB
2239 XWBAPVER -- RPC VERSION Other RPC BROKER 1997/11/19 APPROVED Active Supported
XWBAPVER is a documented variable that will contain an
RPC version if one was set in the client application (using the RPCVersion
property). Otherwise XWBAPVER defaults to 0.
2837 RPC Broker Programmatic Login Other RPC BROKER 1999/06/10 Withdrawn Private
The Event Monitor Service at VAPSHCS monitors incoming
HL7 messages so as to implement automated medical alerts and reminders. The
application must run as a Windows NT Service in unattended mode. The Event
Monitor Service extensively utilizes RPC Broker when implementing medical
alerts. As a consequence, I am requesting to use the undocumented "silent
login" feature released in XWB*1.1*4 until such time when an official Broker
patch supporting this functionality is released.
2838 RPC Broker Silent Feature Other RPC BROKER 1999/06/01 Withdrawn Supported
This request is for a new broker "silent running"
feature. This feature, when enabled, would dictate that under no
circumstances should the broker display message dialogs to the user. A
possible method of accomplishing this task would be to add an RPC Broker
boolean property, that, when set to true, disables the display of all user
dialogs. It is suggested that when the silent property is set, that the the
broker, as an alternative to displaying a message, merely throw an equivalent
silent exception. This feature will allow use of the broker by Windows NT
services that need to run in unattended mode.
2855 RPCBroker.AccessVerifyCodes Remote Procedure RPC BROKER 1999/06/24 Withdrawn Supported
I am using this call in the RPC Broker for a "silent
login" to VistA for an Active Server Page DLL component.
3011 XWB IS RPC AVAILABLE Remote Procedure RPC BROKER 1999/12/08 APPROVED Active Supported
This RPC allows an application to determine if a
particular RPC is available on a server.
INPUT PARAMETER: RPC PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 1 (Required)
DESCRIPTION: Name of the RPC to be tested. INPUT PARAMETER: RUN CONTEXT
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 2 (Optional)
DESCRIPTION: Specific context in which RPC will run. Possible values
are:
L = run Locally (on the server the user is logged on to)
R = run Remotely (on a server the user is not logged on to)
If this parameter is not sent, RPC is checked for both local and remote.
The check is done against the value in the INACTIVE field in the Remote
Procedure file. See that field's description for more details. INPUT
PARAMETER: VERSION NUMBER PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 3 (Optional)
DESCRIPTION: Minimum version number of the RPC.
This parameter is only used if the RUN CONTEXT parameter = "R". If a
numeric value is in this parameter, the value must be less than or equal
to the value in the VERSION field of the Remote Procedure file for the
RPC is be marked available. Note: if the VERSION field is null, the
check will fail for any numeric value in this parameter.
RETURN VALUE DESCRIPTION:
Boolean. 1 = RPC available.
0 = RPC not available.
3012 XWB ARE RPCS AVAILABLE Remote Procedure RPC BROKER 1999/12/08 APPROVED Active Supported
This RPC allows an application to determine if a list
of RPCs are available for use on the server.
INPUT PARAMETER: RUN CONTEXT PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 1 (Optional)
DESCRIPTION: Specific context in which RPCs will run. Possible values
are:
L = run Locally (on the server the user is logged on to)
R = run Remotely (on a server the user is not logged on to)
If this parameter is not sent, RPC is checked for both local and remote.
The check is done against the value in the INACTIVE field in the Remote
Procedure file. See that field's description for more details. INPUT
PARAMETER: RPC PARAMETER TYPE: LIST
SEQUENCE NUMBER: 2 (Required)
DESCRIPTION: This 0-based array contains list of RPCs to be checked
along with (optionally) a minimum acceptable version of the RPC. The
format is:
RPCName^RPCVersionNumber
The RPCVersionNumber is only used if the RUN CONTEXT parameter = "R".
If a numeric value is in the second ^-piece and the RUN CONTEXT ="R",
the value must be less than or equal to the value in the VERSION field
of the Remote Procedure file for the RPC to be marked available. Note:
if the VERSION field is null, the check will fail for any numeric value.
RETURN VALUE DESCRIPTION:
A 0-based array. The index corresponds to the index of the RPC in the
RPC Input Parameter. A value of 1 means the corresponding RPC is
available; a value of 0 means it is not available.
3030 Protect Broker Variables in KILL Routine RPC BROKER 2000/02/03 Withdrawn Private
This DBIA gives Kernel permission to access a tag in a
Broker routine to extract a list of variables that Broker needs protected when
KILL^XUSCLEAN is called by a package in an RPC.		 XWBLIB
3031 Remote RPCs Remote Procedure RPC BROKER 2003/04/29 APPROVED Active Controlled Subscription
This DBIA describes the Broker RPCs that provide the
capability of running any application RPC on a remote system. They were
developed to support the CPRS Remote Data Views project.
NOTE: This 'Server to Server RPC' functionality is currently limited to sites
that have implemented CIRN. CIRN makes it possible for an application to know
a patient's current list of treating facilities. Furthermore, CIRN has
assumed responsibility for supervising the proper configuration and activation
of the VA network nodes that will be used for HL7 message exchange.
XWB REMOTE RPC
This is the RPC that is called to request that an application RPC
be run on a remote system. The data is passed by HL7 to the remote system
as is the return value.
This RPC will return a HANDLE that can be used to check if the data has
been sent back from the remote system. The HANDLE can be used in another
RPC to check the status of the RPC.
Parameters:
(location<station #>,rpc name,[rpc version],[1 to 10 params to the RPC))
Return:
The return value is always an array. The first node of the array is equal to
a string that serves as a HANDLE. This is used to check the status of a RPC
request and to retrieve the results of the RPC.
In the case of an error condition, the first node of the array is equal to a
string with the syntax "-1^error text".
XWB REMOTE STATUS CHECK
This RPC will return the status of a remote RPC.
Parameters:
The HANDLE from the XWB REMOTE RPC.
Return:
The return value is always an array. The first node of the array is
equal to one of the following values:
"-1^Bad Handle" - An invalid handle has been passed.
"0^New" - The request has been sent.
"0^Running" - HL7 indicates that the message is being processed.
"1^Done" - RPC has completed and the data has returned to the local
server. The data is not returned by this RPC. Use the XWB REMOTE
GETDATA RPC to retrieve the data.
The second node of the array is the status from the HL7 package.
XWB REMOTE GETDATA
This RPC will return an ARRAY with what ever data has been sent back from
the remote site.
Parameters:
The HANDLE from the XWB REMOTE RPC. It is used to link the call to the
data.
Return:
The return value is the array of data. In the event of an error condition,
the first node of the array is equal to a string with the syntax "-1^error
text".
XWB REMOTE CLEAR
This RPC is used to CLEAR the data under the HANDLE in the ^XTMP global.
Parameters:
The HANDLE from the XWB REMOTE RPC.
Return:
The return value is always an array. The first node of the array is equal to
1
3032 Direct RPCs Remote Procedure RPC BROKER 2000/02/03 Withdrawn Controlled Subscription
XWB DIRECT RPC
This is the Broker RPC that is called to request that a RPC be run on a
remote system. The data is passed by HL7 to the remote system as is the
return value. The difference between this and the XWB REMOTE RPC is this is a
blocking call meaning the user's workstation will not process anything else
until the data returns from the remote system.
NOTE: This 'Server to Server RPC' functionality is currently limited to sites
that have implemented CIRN. CIRN makes it possible for an application to know
a patient's current list of treating facilities. Furthermore, CIRN has
assumed responsibility for supervising the proper configuration and activation
of the VA network nodes that will be used for HL7 message exchange.
Parameters:
(location<station #>,rpc name,[rpc version],[1 to 10 params to the RPC])
Return:
The return value is the array of data. In the case of an error condition,
the first node of the array is equal to a string with the syntax "-1^error
text".
3033 Deferred RPCs Remote Procedure RPC BROKER 2000/02/03 Withdrawn Supported
This describes the Broker RPCs that are used in support
of running a RPC as a background task.
This RPC will return a HANDLE that can be used to check if the data has
returned. The HANDLE can be used in another RPC to check the status of the
RPC.
XWB DEFERRED RPC
This is the RPC that is called to request that a RPC be run through taskman
in the background.
Parameters:
(rpc name[^rpc version],[1 to 10 params to the RPC])
Return:
The return value is always an array. The first node of the array is equal
to a string that serves as a HANDLE. This is used to check the status of a RPC
request and to retrieve the results of the RPC.
In the case of an error condition, the first node of the array is equal to a
string with the syntax "-1^error text".
XWB DEFERRED STATUS
This RPC will return the status of a deferred RPC.
Parameters:
The HANDLE from the XWB DEFERRED RPC.
Return:
The return value is always an array. The first node of the array is equal to
one of the following values:
"-1^Bad Handle" - An invalid handle has been passed.
"0^New" - The request has been sent.
"0^Running" - RPC is still processing
"1^Done" - RPC has completed and the data has returned to the local
server. The data is not returned by this RPC. Use the XWB REMOTE
GETDATA RPC to retrieve the data.
XWB DEFERRED GETDATA
This RPC is used to return the data from the XWB DEFERRED RPC call.
Parameters:
The HANDLE from the XWB DEFERRED RPC. It is used to link the call to the
data.
Return:
The return value is the array of data. In the event of an error
condition, the first node of the array is equal to a string with the
syntax "-1^error text".
XWB DEFERRED CLEAR
This RPC is used to CLEAR the data under the HANDLE in the ^XTMP global.
Parameters:
The HANDLE from the XWB DEFERRED RPC.
Return:
The return value is always an array. The first node of the array is
equal to 1.
XWB DEFERRED CLEARALL
This RPC is used to CLEAR ALL the data known to this job in the ^XTMP
global. Makes use of the list in ^TMP("XWBHDL",$J,handle).
Return:
The return value is always an array. The first node of the array is
equal to 1.
3144 DIRECT RPC CALL Routine RPC BROKER 2000/10/27 Active Controlled Subscription
This call is to make a RPC call on a remote facility.
Users of this API should be prepared to modifiy their calls to support support
strong authentication when made available by Infrastructure.		 XWB2HL7
3149 XWBDRPC Routine RPC BROKER 2000/07/26 APPROVED Active Controlled Subscription
This routine contains API's for deferred RPC's used by
HL7 utilities.		 XWBDRPC
4053 DBIA4053 Routine RPC BROKER 2003/04/01 APPROVED Active Controlled Subscription XWBSEC
4059 DBIA4059 Other RPC BROKER 2003/04/01 APPROVED Active Controlled Subscription
VistaLink requests permission to set, check and kill
the local variables XQY and XQY0 which represent a user's RPC Broker context.
4073 XUS GET TOKEN Other RPC BROKER 2003/04/03 APPROVED Active Private
From inside CPRS, the Event Capture Interface could be
launched without presenting the scond log on window for user(so called silent
sign-on). In order to fulfill it, CPRS need to call broker's RPC "XUS GET
TOKEN" to get application handle and pass this handle to the Event Capture for
silent log on. Because the RPC "XUS GET TOKEN" is not automatically available
to the CPRS user, OE/RR has to export this RPC into the CPRS menu option "OR
CPRS GUI CHART" to avoid missing RPC error when launching Event Capture
Interface application.
CPRS will insert RPC "XUS GET TOKEN" into "OR CPRS GUI CHART" menu option by
following code: EN ; N RPC,MENU
S RPC="XUS GET TOKEN"
S MENU="OR CPRS GUI CHART"
D INSERT(MENU,RPC)
Q
;
INSERT(OPTION,RPC) ; Call FM Updater with each RPC
; Input -- OPTION Option file (#19) Name field (#.01)
; RPC RPC sub-file (#19.05) RPC field (#.01)
; Output -- None
N FDA,FDAIEN,ERR,DIERR
S FDA(19,"?1,",.01)=OPTION
S FDA(19.05,"?+2,?1,",.01)=RPC
D UPDATE^DIE("E","FDA","FDAIEN","ERR")
Q
Will no longer be needed after release of XWB*1.1*30.		 XUS GET TOKEN
4085 DBIA4085 File RPC BROKER 2003/04/30 Withdrawn Private
4186 M2M BROKER - M Client/Server Connection Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$CONNECT^XWBM2MC()- This API establishes the initial
connection to the VISTA M server. It is a function call that returns a
success/fail indicator of 1 or 0, respectively.
4187 M2M BROKER - Set Application Context Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$SETCONTX^XWBM2MC() - This API sets the context. It
sets up the necessary environment to run the RPCs. It is a function call that
returns a success/fail indicator of 1 or 0, respectively.
4188 M2M BROKER - Build the PARAM Data Structure Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$PARAM^XWBM2MC() - This API sets up the PARAM data
structure necessary to run the RPCs. This is a function call that returns a
success/fail indicator of 1 or 0, respectively.
4189 M2M BROKER - Build the Remote Procedure Data Structure Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$CALLRPC^XWBM2MC() - This API builds the Remote
Procedure Call (RPC) data structure, and then makes the call to the RPC on the
server. The request message is transported in XML and is parsed by using the
VISTA Extensible Markup Language (XML) Parser, introduced in Kernel Toolkit
Patch XT*7.3*58.
This API is a function call returning a success/fail indicator of 1 or 0,
respectively.
4190 M2M BROKER - Close Connection Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$CLOSE^XWBM2MC() - This API closes the connection
between that particular instance of the "requesting" VISTA M server and the
"receiving" VISTA M server, and does any necessary cleanup. It is a function
call that returns a success/fail indicator of 1 or 0, respectively.
4191 M2M BROKER - Returns CURRENT Application Context Routine RPC BROKER 2003/08/07 APPROVED Active Supported
$$GETCONTX^XWBM2MC() - This API returns the current
application context so that a new context may be established, thereby
restoring the previous application context prior to switching to the new one.
It is a function call returning a success/fail indicator of 1 or 0,
respectively.
4645 START/STOP XWBTCP LISTENER Routine RPC BROKER 2005/03/24 APPROVED Active Private
This is a IA for KIDS new auto patch utility to start
and stop the RPC Broker (XWBTCP) listener. In the code KIDS will make
reference to STOPALL^XWBTCP and RESTART^XWBTCP. Some patches require that the
Broker listener be stopped.		 XWBTCP
5660 DSIC DDR GETS ENTRY DATA Remote Procedure RPC BROKER 2011/05/06 APPROVED Active Private
This is the Broker RPC that is called to request that a
RPC be run on a remote system. The data is passed by HL7 to the remote system
as is the return value. The difference between this and the XWB REMOTE RPC is
this is a blocking call meaning the user's workstation will not process
anything else until the data returns from the remote system.		 DSIC DDR GETS ENTRY DATA 2011/06/02
5910 XWB IM HERE Remote Procedure RPC BROKER 2013/05/02 APPROVED Active Private XWB IM HERE 2013/05/13
7101 XWB GET BROKER INFO Remote Procedure RPC BROKER 2019/09/16 APPROVED Active Private
The WebVRAM package needs to get the details of the RPC
broker for use in the web applications used by WebVRAM users and WebVRAM
administrative users.
"Kernel understands this ICR was created to track which application is using
the Kernel resource. The WebVRAM team has been working with IAM and the
Kernel team for future official alternatives."		 XWB GET BROKER INFO 2019/09/20