08/29/2006 4.1 Added new REMOTE APPLICATION file (#8994.5) to the file list. This file was released with RPC Broker Patch XWB*1.1*45 as part of the Broker Security Enhancement (BSE) Project. Project Manager: J. She. Project Planner: L. R. Developers: W. F. & J. I. SQA: M. A. Functional Analyst: L. G. Technical Writer: T. B. Security Engineer: J. M. Release Managers: M. P. and L. T. 02/28/2005 4.0 Revised Version for RPC Broker Patches XWB*1.1*35 and 40. Also, reviewed document and edited for the “Data Scrubbing” and the “PDF 508 Compliance” projects. Data Scrubbing—Changed all patient/user TEST data to conform to standards and conventions as indicated below: The first three digits (prefix) of any Social Security Numbers (SSN) start with “000” or “666.” Patient or user names are formatted as follows: XWBPATIENT,[N] or XWBUSER,[N] respectively, where the N is a number written out and incremented with each new entry (e.g., XWBPATIENT, ONE, XWBPATIENT, TWO, etc.). Other personal demographic-related data (e.g., addresses, phones, IP addresses, etc.) were also changed to be generic. PDF 508 Compliance—The final PDF document was recreated and now supports the minimum requirements to be 508 compliant (i.e., accessibility tags, language selection, alternate text for all images/icons, fully functional Web links, successfully passed Adobe Acrobat Quick Check). Project Manager: J. Sch. Developer: J. I. Technical Writer: T. B. 05/08/2002 3.0 Revised Version for RPC Broker Patch XWB*1.1*26. Developer: J. I. Technical Writer: T. B. 04/08/2002 2.0 Revised Version for RPC Broker XWB*1.1*13. Developer: J. I. Technical Writer: T. B. 09/--/1997 1.0 Initial RPC Broker Version 1.1 software release. Developer: J. I. Technical Writer: T. B.
the array is equal to 1. XWB DEFERRED GETDATA Availability: PUBLIC RTNDATA^XWBDRPC HANDLE: The HANDLE from the XWB DEFERRED RPC. It is used to link the call to the data. Returns: 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”. This RPC is used to return the data from the XWB DEFERRED RPC call. XWB DEFERRED RPC Availability: PUBLIC EN1^XWBDRPC RPC: This parameter is the name of the RPC to be run in the background. This first input parameter can include optional version information about the RPC, making the syntax like this: The optional version number will be placed in XWBAPVER when the RPC runs in the background. P1 through P10: These parameters Returns: 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 text”. This is the RPC that is called to request that a RPC be run through TaskMan in the background.
XWB DIRECT RPC Availability: SUBSCRIPTION DIRECT^XWB2HL7 LOC: This is the INSTITUTION file (#4) station # to send the RPC to. RRPC: This is the name of the remote RPC to be run. Returns: 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 text”. 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 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. *XWB EGCHO BIG LIST Availability: RETIRED NONE Returns: 32K String. This RPC brings back a lot of meaningless data to the client. It exists for support of EGcho - Broker demonstration program *XWB EGCHO LIST Availability: RETIRED LIST^XWBZ1 NONE Returns: List with 28 entries. This RPC brings back a list of elements to the client. It exists for support of EGcho - Broker demonstration program. *XWB EGCHO MEMO Availability: RETIRED MEMO^XWBZ1 X: Array of strings. Returns: Array echoing back the input array. This RPC accepts text from a client which it will send right back to the client. It exists for support of EGcho - Broker demonstration program. *XWB EGCHO SORT LIST Availability: RETIRED SRT^XWBZ1 DIRECTION: The string LO or HI. ARRAY: The array of numbers. Pass using . syntax. Returns: Sorted Sorts a given numeric array, starting from HI or LO. It exists for support of EGcho - Broker demonstration program.
XWB EXAMPLE GLOBAL SORT Availability: RESTRICTED GSORT^XWBEXMPL DIRCTN: Direction to sort in HI or LO. ROOT: Array of numbers to sort. Returns: An array of sorted numbers. This RPC uses the Global call to send down a BIG list of numbers to sort. In the old Broker it would cause an allocation error, but this one saves the data into a temp global. It exists for support of RPC Broker Example program. XWB EXAMPLE SORT NUMBERS Availability: RESTRICTED SORTNUM^XWBEXMPL DIRCTN: Direction to sort in HI or LO. ARRAY: Array of numbers to sort. Returns: An array of sorted numbers. This RPC sorts an array of numbers. It exists for support of RPC Broker Example program. XWB EXAMPLE WPTEXT Availability: RESTRICTED WPTEXT^XWBEXMPL NONE. Returns: A word processing This RPC uses a FileMan DBS call to retrieve the file description for the REMOTE PROCEDURE file (#8994). It exists for support of RPC Broker Example program. XWB GET BROKER INFO Availability: RESTRICTED BRKRINFO^XWBLIB NONE. Returns: A 0-based array. Currently returns a single value containing the length of the handler read timeout Returns info regarding setup and parameters of the Broker. XWB GET VARIABLE VALUE Availability: SUBSCRIPTION VARVAL^XWBLIB VARIABLE: Name of M environment variable whose value is to be returned. Returns: The value of the input variable. This RPC accepts the name of a variable that is evaluated and its value returned to the server. For example, this RPC can be called with a parameter variable like DUZ, which is returned as 123456.
XWB REMOTE Availability: SUBSCRIPTION CLEAR^XWBDRPC HANDLE: This is the HANDLE from the XWB REMOTE RPC. Returns: The return value is always an array. The first node of the array is equal to 1. This RPC is used to CLEAR the data under a HANDLE in the ^XTMP global. XWB REMOTE GETDATA Availability: SUBSCRIPTION RTNDATA^XWBDRPC HANDLE: This is the HANDLE from the XWB REMOTE RPC call. It is used to link the call to the data. Returns: 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”. This RPC will return an array with whatever data has been sent back from the remote site. XWB REMOTE RPC Availability: SUBSCRIPTION EN1^XWB2HL7 LOC: This is the INSTITUTION file (#4) station # to send the RPC to. RRPC: This is the name of the remote RPC to be run. IP1: This is the first input parameter to the remote RPC. IP2: This is the second input parameter to the remote RPC. Returns: 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 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.
ICRs—Detailed Information To obtain detailed information on a specific ICR: Sign on to the FORUM system. Go to the DBA menu [DBA]. Select the Integration Agreements Menu option [DBA IA ISC]. Select the Inquire option [DBA IA INQUIRY]. When prompted for “INTEGRATION REFERENCES,” enter the specific Integration Control Registration (ICR) number you would like to display. The option then lists the full text of the ICR you requested. ICRs—Current List for RPC Broker as Subscriber To obtain the current list of ICRs, if any, to which the RPC Broker software is a subscriber, perform the following procedure: Sign on to the FORUM system. Go to the DBA menu [DBA]. Select the Integration Agreements Menu option [DBA IA ISC]. Select the Subscriber Package Menu option [DBA IA SUBSCRIBER MENU]. Choose the Print ACTIVE by Subscribing Package option [DBA IA SUBSCRIBER]. When prompted with WITH SUBSCRIBING PACKAGE,” enter XWB or RPC BROKER (uppercase). When prompted with “GO TO SUBSCRIBING PACKAGE,” enter XWB or RPC BROKER (uppercase). All current ICRs to which the RPC Broker (XWB) software is a subscriber are listed.
Index ^ ^XWB Global, 8 Archiving, 16 Purging, 16 ^XWB(8994, Global, 5 ^XWB(8994.1, Global, 5 ^XWB(8994.5, Global, 5 A Acronyms Intranet Website, 45 ACTIVE by Custodial Package Option, 34 Alerts, 37 Applications rpctest.exe, 13 Applications Diagnostic, 13 rpctest.exe, 13 Archiving, 16 Assumptions, xiv B Broker FAQs, 43 BROKERSERVER, 42 C Callable Points, 16 CALLBACKTYPE Multiple (#1), 5 Callout Boxes, xii Clear XWB Log Files Option, 12, 14 Client Files, 7 Commonly Used xiii Components RPCBroker, 32 TCCOWRPCBroker, 32 TContextorControl, 32 TRPCBroker, 32 TXWBRichEdit, 32 TXWBSSOiToken, 32 Connections, 37 Diagnostics, 41 Contents, vii Custodial Package Menu, 34 D Data Dictionary Data Dictionary Utilities Menu, xiii Listings, xiii DBA Approvals, 34 DBA Approvals and ICRs, 34 DBA IA CUSTODIAL MENU, 34 DBA IA CUSTODIAL Option, 34 DBA IA INQUIRY Option, 35 DBA IA ISC Menu, 34, 35 DBA IA SUBSCRIBER MENU, 35 DBA IA SUBSCRIBER Option, 35 DBA Menu, 34, 35 Debug Parameter Edit Option, 12, 14 DECRYP^XUSRB1, 33 Decryption Functions, 33 Demographics, 5 Diagnostic application, 13 Diagnostics Connection, 41 Disclaimers, x Software, x DLL, 1, 16, 33 WINSOCK.DLL, 42 DNS, 42 Documentation Revisions, ii Symbols, xi Documentation Conventions, xi Documentation Navigation, xii Dynamic Link Library, 33 E Electronic Signatures, 38 ENCRYP^XUSRB1, 33 Encryption, 37 Functions, 33 End-User Workstation Files, 7 Entry Points Callable, 16 Environment, 34 Exported Options, 12
External Interfaces, 32 Relations, 33 Relationships, 32 F FAQs, 43 Features Server, 13 Fields CALLBACKTYPE Multiple (#1), 5 RPC (#.01), 5 RPC (#19.05), 5 Figures, ix Files, 5 Client, 7 End-User Workstations, 7 42 NEW PERSON (#200), 5 OPTION (#19), 5, 12 Programmer Workstations, 7 REMOTE APPLICATION (#8994.5), 5, 38 REMOTE PROCEDURE (#8994), 1, 5, 33 Archiving, 16 Purging, 16 Security, 16, 38 REMOVE APPLICATION (#8994.5), 9 RPC BROKER SITE PARAMETERS (#8994.1), 5, 13, 14 Archiving, 16 Purging, 16 Security, 38 Security, 38 Frequently Asked Questions, 43 Functions Decryption, 33 Encryption, 33 Pascal, 33 Piece, 33 Translate, 33 G GetServerInfo Method, 33 Global Variables, 36 Globals, 5 ^XWB, 8 Archiving, 16 Purging, 16 ^XWB(8994,, 5 ^XWB(8994.1,, 5 ^XWB(8994.5,, 5 Journaling, 8 Protection, 8 Translation, 8 Glossary, 44 Intranet Website, 45 H Help At Prompts, xiii Online, xiii Question Marks, xiii History Revisions, ii Home Pages Acronyms Intranet Website, 45 Adobe Website, xv Glossary Intranet Website, 45 RPC Broker Website, xv VA Software Document Library (VDL) Website, xv HOSTS File, 42 How to Obtain Technical Information Online, xiii Use this Manual, x I ICRs, 34 Implementation, 3 Inquire Option, 35 Integration Agreements Menu Option, 34, 35 Integration Control Registration (ICR), 34 Current List for RPC Broker Custodian, 34 Subscriber, 35 Detailed Information, 35 Intended Audience, x Interfaces, 38 External, 32 Internal Relationships, 36 Introduction, 1 J Journaling, 8