RPC Broker V. 1.1 Technical Manual
Contents
1. 23 DBA Approvals and Database ntegration Agreements DBIAs 24 Internal Relations M HS 27 Package wide Variables 29 Software Product Security e 31 Security M 31 Malil Groups and 31 Remote Syst MSa oce trata ve D D RE DO Ea D E ORE D ath En avast 31 lt E C 32 Electronic SIQNACUES 32 Security eur egt uuo verd Da cd 32 T T 32 32 GLOSS Y 33 Hinr d M 39 iv RPC Broker V 1 1 Technical Manual September 1997 Orientation HowTo USE THIS MANUAL This manual uses several methods to highlight different aspects of the material All uppercase is reserved for the representation of M code variable names or the formal name of options field and file names and security keys e g the XUPROGMODE key Various symbols are used throughout the documentation to alert th2. 14 Dynamic Link Library 21 ENCRYP XUSRB1 function 21 Encryption 31 Encryption functions 21 Environment 23 Exported Options XWB Broker EXAMPLE 13 XWB EGCHO 13 XWB LISTENER STARTER 13 14 XWB RPC TEST 13 Exported Options 13 External Relations 23 F File Attributes vi File List 5 File Security 32 Files REMOTE PROCEDURE 5 RPC BROKER SITE PARAMETERS 5 September 1997 RPC Broker V G GetServerl nfo function 21 Global J ournaling 10 Global Map Format vi Global Protection 10 Global Translation 9 Globals XWB 10 Glossary 33 H Home Page RPC Broker 2 How to Use this Manual v How to Generate T echnical Information Online vi http www adobe com 2 http www vista med va gov softserv i nfrastr uct broker index html 2 Implementation and Maintenance 3 Internal Relations 27 J J ournaling 10 K KIDS Build File vi L List File Attributes option vi Listeners Broker 3 M Manuals related 2 Mapping Routine 12 Online Technical Information How to Generate vi 1 1 Technical Manual 39 Index OPTION file 19 13 Orientation v vi P Package wide Variables 29 Pascal Functions 21 Performance 4 Piece function 21 Protection 10 Purging 17 R REMOTE PROCEDURE file 5 Routine List 11 XWBBRK 11 XWBBRK2 11 XWBCAGNT 11 XWBEXMPL 11 XWBFM 11 XWBLIB 11 XWBSEC 11 XWBTCP 11 XWBTCPC 11 XWBTCPL 11 XWBZ1 12 Routine Mapping
3. MWB RPG 14 5 ceci reto ret oet 14 OE OXERAM ERA EANO MANERA EET VA BANK ANO VERA Eni E 17 17 17 Callable lies 19 September 1997 RPC Broker 1 1 Technical Manual iii Table of Contents External 1 5 ud Va ww ERE CIR 21 TRPCHBLPoOKOP COIDOD GE 4 t aedes 21 TRPCBroker Dynamic Link Library DLL enn 21 Pascal FUNG ONS T 21 RPC Broker Remote 22 External Relations 23 Relationship to Other Packages 4 23 Relationship with Kernel VA 23 Relationships with Operating
4. 12 RPC Broker H ome Page 2 RPC BROKER SITE PARAMETERS file 5 RPCTEST EXE program 14 Splash Screen functions 21 SplashClose function 21 SplashOpen function 21 T Translate function 21 Translation 9 TRPCBroker Component 21 TRPCBroker DLL 21 Web sites http www adobe com 2 Web Sites http www vista med va gov softser v infrastr uct broker i ndex html 2 X XUPROGMODE security key 32 XWB Broker EXAMPLE 13 XWB EGCHO 13 XWB GET VARIABLE VALUE RPC 22 XWB LISTENER STARTER 13 14 XWB RPC TEST 13 XWBBRK 11 XWBBRK2 11 XWBCAGNT 11 XWBEXMPL 11 XWBFM 11 S XWBLIB 11 XWBSEC 11 Scalability 4 XWBTCP 11 Security and Keys 31 XWBTCPC 11 Single sign on 3 XWBTCPL 11 Site Parameters 3 XWBZ1 12 40 RPC Broker V 1 1 Technical Manual September 1997 A RPC BROKER TECHNICAL MANUAL Version 1 1 September 1997 Department of Veterans Affairs VISTA Software Development OpenV STA Product Line Table of Contents gt aaan v How to Obtain Technical Information Online 1 0 1 ee vi rn odia ako rotes d east vi KIDS BHIIQOTF IG node et 1 Product Oye AV a TI xm 1 Related
5. List CLIENT FILES End User Workstation Program Files Vista Broker Clagent exe Clagent hlp RPCTest exe RPCTest hlp Windows System 32 Bapi32 dll VistaBroker dpl Programmer Workstation Program Files Vista Broker BrokerProgPref exe BrokerProgPref hlp ServerList exe Serverlsit hlp Program Files Vista Bdk32 D2 FrmSignonMessage dcu FrmSignonMessage dfm Splvista dfm Hash dcu Loginfrm dcu Loginfrm dfm funStr dcu RpcbEdtr dcu RpcbErr dcu Rpcberr dfm RpcConfl dcu Rpcconfl dfm rpcnet dcu Rpcnet dfm SgnonCnf dcu SgnonCnf dfm SplVista dcu Trpcb dcr Trpcb dcu VCI Edit dcu Vcedit dfm WSockc dcu XWButl dcu RPC Broker V 1 1 Technical Manual September 1997 Program Files Vista Bdk32 D3 FrmSignonMessage dcu FrmSignonMessage dfm Hash dcu Loginfrm dcu Loginfrm dfm MfunStr dcu RpcbEdtr dcu RpcbErr dcu Rpcberr dfm RpcConfl dcu Rpcconfl dfm rpcnet dcu Rpcnet dfm SgnonCnf dcu SgnonCnf dfm SplVista dcu Splvista dfm Trpcb dcu VCEdit dcu Vcedit dfm VistABroker dcp VistABroker dpl WSockc dcu XWButl dcu Program Files Vista Bdk32 Doc Broker Broker Broker cnt hlp kwf BrokerSM cnt BrokerSM hlp xwbl l1DG PDF xwbl l1IG PDF xwbl l1RN PDF xwbl 1SM PDF xwbl 1TM PDF Program Files Vista Bdk32 Headers BAPI32 Bapi32 Bapi32 bas Program Files Vista Bdk32 Samples BrokerEx BrokerExampl BrokerExa
6. Manuals and Other 2 Implementation and 3 Sit PaEatTietels dr o d 3 Performance and Scalability iio rot ee toe REPRE honte een REEL Mns 4 5 oontra eti erts iyd 5 REMOTE PROCEDURE File 8994 5 RPC BROKER SITE PARAMETERS file 8994 1 5 CBE PICS tectae 6 End User WOK SEGUE OFT 6 DRE pu XR crue cae 6 Global Translation J ournaling and Protection nennen 9 TN ONDE 9 m 10 E Pacha trend rr vr 10 RoO the E soncceennvanersansasieuiucuteeedecvaausauenansbaanctucbaugudeGsiesvauanaaneanduannvuuassedudesuteavanvuacusentna 11 PROUT ESM AD DITO ee D 12 Exported 13 XWB EGC HO 13 AWB LISTENER STARTER 14
7. access and verify code once to create an active connection to the server they don t need to enter them again to make additional connections Connections include GUI applications like CPRS and alsothe traditional roll and scroll system through telnet Fields in the NEW PERSON file 200 and the KERNEL SYSTEM PARAMETERS file 248989 3 control access to the single signon feature For moreinformation about configuring site parameters for single signon pleaserefer to the RPC Broker V 1 1 Systems Manual September 1997 RPC Broker V 1 1 Technical Manual 3 Implementation and Maintenance PERFORMANCE AND SCALABILITY Current performance statistics are limited However results indicate that the processing time and resources consumed by the Broker itself are minimal The RPC Broker doesn t introduce any additional overhead to the messages sent between the client and the server Performance should be measured at the application level to determine the amount of resources consumed by VISTA client server applications that use the Broker We anticipate collecting more data from this release of the Broker to provide us with comparison statistics on performance and scalability in a production environment that we can pass on to all users of the Broker 4 RPC Broker V 1 1 Technical Manual September 1997 File List M SERVER FILES The RPC Broker consists of a single global with two files This chapter describes the RPC Broker files inc
8. computer Y our code is greater than six and less than twenty characters long can be numeric alphabetic or a combination of both and is usually assigned by a site manager or application coordinator It is used by the Kernel s Sign on Security system to identify the user see Verify Code Brief online notices that are issued to users as they complete a cycle through the menu system Alerts are designed to provide interactive notification of pending computing activities such as the need to reorder supplies or review a patient s clinical test results Along with the alert message is an indication that the View Alerts common option should be chosen to take further action TheMUMPS programming language is a standard that is an American National Standard ANS MUMPS stands for Massachusetts Utility Multi programming System and is abbreviated as M Programmer calls provided by the Kernel for use by application programmers APIs allow programmers to carry out standard computing activities without needing to duplicate Kernel utilities in their own packages APIs also further DBA goals of system integration by channeling activities such as adding new users through a limited number of callable entry points An arrangement of elements in one or more dimensions An M array is a set of nodes referenced by subscripts that share the same variable name An authorized programmer call that may be used in any VISTA application package The DBA mai
9. themselves if they want to try out the EGCHO application For programmers who have the XUPROGMODE key however assigning this option to themselves is not necessary September 1997 RPC Broker V 1 1 Technical Manual 13 Exported Options XWB LISTENER STARTER The XWB LISTENER STARTER option can be used to start one or more Broker Listeners at one time It works in combination with the new CONTROLLED BY LISTENER STARTER 2 subfield of the Port 1 subfield of the Listener 7 multiple field in the RPC BROKER SITE PARAMETERS file 8994 1 The CONTROLLED BY LISTENER STARTER field is a Yes No Set of codes type field All of the Listener entries in this file that have CONTROLLED BY LISTENER STARTER set to Y es will be started when the XWB LISTENER STARTER option is run Additionally the XWB LISTENER STARTER option can be scheduled through TaskMan such that whenever TaskMan starts up the listener processes are started To do this schedule the XWB LISTENER STARTER option with SPECIAL QUEUING set to STARTUP This option should only be made available to system managers XWB RPC TEST It is recommended that the XWB RPC TEST option be given to users running Broker based VISTA dient server applications The RPCTEST EXE program on the dient workstation runs the RPC Broker Diagnostic Program This tool can be used to verify and test the Broker client server connection and signon process It displays information about the dient and the server a
10. AND VA FILEMAN Before installing the RPC Broker Kernel V 8 0 Kernel Toolkit V 7 3 and VA FileMan V 21 0 must bein place and fully patched RELATIONSHIPS WITH OPERATING SYSTEMS On the client side it was decided that the 32 bit Microsoft Windows environment would be the supported platform Thus the client portions of the RPC Broker are compatible with Microsoft Windows 95 or higher and Microsoft Windows NT 3 5 or higher On the server side the RPC Broker supports the following ANSI M environments e Digital Standard M DSM V6 3 031 for OpenVMS AXP or greater e InterSystems OpenM for NT version 7 e Micronetics Standard M MSM for Windows NT V 4 2 4 or greater September 1997 RPC Broker V 1 1 Technical Manual 23 External Relations DBA APPROVALS and DATABASE INTEGRATION AGREEMENTS DBIAs To obtain the current list of DBIAs that the RPC Broker is a custodian of Sign on to the Forum system forum va gov Gotothe menu Select the ntegration Agreements menu Select the Custodial Package menu Choose the ACTIVE by Custodial Package option When this option prompts you for a package enter RPC BROKER All current DBIAs for which the RPC Broker package is custodian are listed NOU BR WN To obtain detailed information on a specific integration agreement Sign on to the Forum system forum va gov Gotothe menu Select the Integration Agreements menu Select the Inquire option Wh
11. Introduction This manual provides information about the structure of the Veterans Health Information Systems and Technology Architecture VISTA software known as the Remote Procedure Call RPC Broker also referred to as Broker This manual consists of technical material specifically intended for VISTA systems managers and developers PRODUCT OVERVIEW The RPC Broker is considered to be part of the infrastructure of VISTA It establishes a common and consistent foundation for communication between clients and VISTA M servers The RPC Broker is a bridge connecting the client application front end on the workstation e g Delphi GUI applications to the M based data and business rules on the server It links one part of a program running on a workstation to its counterpart on the server The dient and the server can be and most often are written in different computer languages Therefore the RPC Broker bridges the gap between the traditionally proprietary VISTA and COTS HOST products The RPC Broker includes e A common communications driver for the M server interface that handles the device specific characteristics of the supported communications protocol e An interface component on the M server separate from the communications driver that interprets client messages executes the required code and eventually returns data to the communications driver e A common file on the M server which all applications useto store the infor
12. agers Guide for instructions and recommendations regarding journaling translation and replication the information here may not apply September 1997 RPC Broker V 1 1 Technical Manual 9 Global Translation ournaling and Protection J OURNALING J ournaling of this global is not required since the XWB global for the most part is static except during the addition of new remote procedures PROTECTION The following global protection should be set Protection Global DSM for OpenVMS Name XWB System RWD Owner RWD System RWD World RW Group N World RWD Group RW World N Group RWD User RW Network RWD User RWD Table 3 RPC Broker Global Information 10 RPC Broker V 1 1 Technical Manual September 1997 Routine List This chapter contains a list of the routines exported with the RPC Broker A brief description of the routines is provided Routine XWBBRK XWBBRK2 XWBCAGNT XWBEXMPL XWBFM XWBLIB XWBSEC XWBTCP XWBTCPC XWBTCPL September 1997 Description This routine contains calls that are designed to parse the various attributes of the Broker messages All of this information is used internally In the case of large arrays sent by the client the function BREAD is used to read in the variable length subscripts and values This routine is a continuation of XWBBRK The main entry point i e actually calls the application RPC Server code for RPC Broker client agent app
13. ation Agreement a formal understanding between two or more application packages which describes how data is shared or how packages interact The DBA maintains list of DBI As between package developers allowing the use of internal entry points or other package specific features that are not available to the general programming public A programmer call that is made when working in direct programmer mode A direct mode utility is entered at the M prompt e g gt D XUP Calls that are documented as direct mode utilities cannot be used in application package code RPC Broker V 1 1 Technical Manual September 1997 DLL ERROR TRAP FORUM GUI IRM KERNEL September 17 Glossary Dynamic Link Library A DLL allows executable routines to be stored separately as files with a DLL extension These routines are only loaded when a program calls for them DLLs provide several advantages 1 DLLs help save on computer memory since memory is only consumed when a DLL is loaded 2 DLLs ease maintenance tasks Because the DLL isa separate file any modifications made to the DLL will not affect the operation of the calling program or any other DLL 3 DLLs help avoid redundant routines They provide generic functions that can be utilized by a variety of programs A mechanism to capture system errors and record facts about the computing context such as the local symbol table last global reference and routine in use Operatin
14. ctions and APIs It is distributed with the Broker RouTINE MAPPING RPC Broker routines are not required to be mapped to any account 12 RPC Broker V 1 1 Technical Manual September 1997 Exported Options The following options are exported with the RPC Broker Wm Wem o mm _ XWB BROKER RPC BROKER PROGRAMMING Broker Client Server EXAMPLE EXAMPLE XWB EGCHO RPC BROKER DEMO TEST Broker Client Server XWB LISTENER Start RPC Broker Listeners Run Routine STARTER XWB RPC TEST RPC Broker Client Server Table 4 Exported Options Client server applications are a new type of option i e Type B Broker client server options in the OPTION file 19 The user must have the dient server application option assigned to them as with any other assigned option in VISTA The dient server application will only run for those users who are allowed to activate it Theclient server application options will not displayed the user s menu tree XWB BROKER EXAMPLE This option supports the Broker Example demonstration program provided in the Broker Development Kit Developers should assign this option to themselves if they want to try out the Broker Example application For programmers who have the XUPROGMODE key however assigning this option to themselves is not necessary XWB EGCHO This option supports the EGCHO demonstration program provided in the Broker Development Kit Developers should assign this option to
15. e reader to special information The following table gives a description of each of these symbols U sed to inform the reader of general information induding references to additional reading material U sed to caution the reader to take special notice of critical informati on Table 1 Documentation Symbol Descriptions ASSUMPTIONS ABOUT THE READER This manual is written with the assumption that the reader is familiar with the following e VISTA computing environment e g Kernel Installation and Distribution System KIDS e VA FileMan data structures and terminology e Microsoft Windows e M programming language September 1997 RPC Broker V 1 1 Technical Manual V Orientation How TO OBTAIN TECHNICAL INFORMATION ONLINE Technical information about the RPC Broker is available online It can be obtained in a number of ways as described below List File Attributes The VA FileMan List File Attributes option allows you to generate documentation pertaining to files and file structure stored in the Data Dictionary Listing the data dictionary in Standard format yields the following Data Dictionary information for a specified file e g REMOTE PROCEDURE file 8994 e Filename and description Fieldsin the file including descriptions e Identifiers e Cross references e Files pointed to by the file specified e Files that point to the file specified e Input templates e Print templates e Sort templates Listin
16. en prompted for INTEGRATION REFERENCES enter the integration agreement number of the DBIA you would like to display 6 The option then lists the full text of the DBIA you requested gt 24 RPC Broker V 1 1 Technical Manual September 1997 External Relations To obtain the current list of DBIAs that the RPC Broker is a subscriber to Sign on to the Forum system forum va gov Go tothe DBA menu Select the ntegration Agreements menu Select the Subscriber Package menu Choose the Print ACTIVE by Subscribing Package option When prompted START WITH SUBSCRIBING PACKAGE enter RPC BROKER in uppercase When prompted GO TO SUBSCRIBING PACKAGE enter RPC BROKER in uppercase 7 All current DBIAs to which the RPC Broker package is a subscriber are listed OT Bow NP September 17 RPC Broker V 1 1 Technical Manual 25 External Relations 26 RPC Broker V 1 1 Technical Manual September 1997 Internal Relations No options in the RPC Broker product assume that the entry exit logic of another option has already occurred September 1997 RPC Broker V 1 1 Technical Manual 27 Internal Relations 28 RPC Broker V 1 1 Technical Manual September 1997 Package wide Variables The RPC Broker does not create any package wide variables that have recei ved Programming Standards and Conventi ons Committee SACC exemptions September 1997 RPC Broker V 1 1 Technical Manual 29 Package wide Variab
17. functions Decrypt and Encrypt o For moreinformation on these Pascal functions pleaserefer tothe RPC Broker V 1 1 Getting Started with the Broker Development Kit and OnlineRPC Broker Developer s Guide manuals September 1997 RPC Broker V 1 1 Technical Manual 21 External Interfaces RPC BROKER REMOTE PROCEDURES The following RPC is provided for use by developers e XWB GET VARIABLE VALUE For moreinformation pleaserefer to the RPC Broker V 1 1 Getting Started with the Broker Development Kit and Online RPC Broker Devdoper s Guide manuals 22 RPC Broker V 1 1 Technical Manual September 1997 External Relations RELATIONSHIP TO OTHER PACKAGES The RPC Broker software has been developed to aid the VISTA development community and Information Resources Management IRM and is considered to be part of the infrastructure of VISTA Other infrastructure products include VA FileMan Kernel and MailMan The RPC Broker will be used by all client applications written as part of VISTA The RPC Broker fully integrates with VA FileMan V 21 0 and Kernel V 8 0 The absence of RPC Broker software on an M server will disable the functioning of any client application that depends on the RPC Broker to communicate with the M Server It is possible that the use of RPCs will also be extended to non client applications In this case the REMOTE PROCEDURE FILE must be present for those applications to function correctly RELATIONSHIP WITH KERNEL
18. g systems provide tools such as the ER utility The Kernel provides a generic error trapping mechanism with use of the 96Z TER global and XTER routines Errors be trapped and when possible the user is returned to the menu system The central e mail system within VISTA Developers use FORUM to communicate at a national level about programming and other issues FORUM is located at the Washington DC CIO Field Office 162 2 Graphical User Interface A type of display format that enables users to choose commands initiate programs and other options by selecting pictorial representations icons via a mouse or a keyboard Information Resource Management A service at VA medical centers responsible for computer management and system security A set of M software routines that function as an intermediary between the host operating system and the VISTA application packages enabling packages to coexist in a standard OS independent computing environment The Kernel provides a standard and consistent user and programmer interface between application packages and the underlying M implementations RPC Broker V 1 1 Technical Manual 35 Glossary MAILMAN MENU MANAGER METHOD MULTIPLE MUMPS ANSI STANDARD NAMESPACING NODE OPTION 36 The Kernel module that provides a mechanism for handling electronic communication whether it is user oriented mail messages automatic firing of bulletins or initiation of ser
19. g the data dictionary in Global Map format generates a list of all cross references for the file selected global location of each field in the file input templates print templates and sort templates For moreinformation regarding VA FileMan Data Dictionary options please refer to Chapter 1 How to Display Information About Files in theVA FileMan V 21 0User Manual KIDS Build File Y ou can list the server side components that are distributed with the RPC Broker by using the Build File Print option The menu path to that option is Programmer Options XUPROG KIDS Kernel Installation amp Distribution System XPD MAIN Utilities XPD UTILITY Build File Print XPD PRINT BUILD vi RPC Broker V 1 1 Technical Manual September 1997
20. les 30 RPC Broker V 1 1 Technical Manual September 1997 Software Product Security SECURITY MANAGEMENT There are no special legal requirements involved in the use of the RPC Broker product MAIL GROUPS AND ALERTS The RPC Broker does not make use of mail groups or alerts REMOTE SYSTEMS The server process of the RPC Broker allows connections from client applications Connection by those client applications is subject to authentication as any normal logon requires Client applications can use any remote procedure call RPC authorized to the application if the application is authorized to the signed on user Data is typically exchanged between clients and the RPC Broker server Clients can be anywhere on VA s TCP IP network Encryption is used when a user s access and verify codes are sent from the client to the server In addition an encryption API is provided for developer use their own applications to encode and decode messages passed between client and server Security with the RPC Broker is a four part process 1 Client workstations must send a valid connection request tothe M Server 2 Users must have valid Access and Verify codes 3 Users must be valid users of a VISTA client server application 4 Any remote procedure call must be registered and valid for the application being executed e For moreinformation regarding Broker security please refer to Chapter 2 Security in theRPC Broker V 1 1 Systems Ma
21. lication This routine is used to support the Broker Example application The Broker Example application is used to test the RPC Broker connectivity actions and RPCs It is distributed with the Broker This routine contains entry points used to interface to the VA FileMan database server This routine contains various functions and procedures used by the Broker It is best described as a library or depository This routine contains various functions and procedures used by the Broker Calls in this routine are used for client server security This routine contains functions and procedures used to control the Broker TCP IP Listener process Systems personnel can use calls in this routine to start stop and debug the Broker process This job is started for each Broker request The Listener process i e XWBTCPL will receive a connection request from a client and then dispatch using the M J OB command XWBTCPC to manage the rest of the interaction This is the Broker Listener process IRM starts this job It remains running on a system listening for TCP IP connection requests Once a request is received this routine will start a separate process to manage the rest of the connection then returns to listening for a new request RPC Broker V 1 1 Technical Manual 11 Routine List Routine Description XWBZI1 This routine is used to support the E cho application The Echo application is used to test the RPC Broker connectivity a
22. luding the file number file name global location and description of the files 8994 REMOTE PROCEDURE XWB 8994 8994 1 RPC BROKER SITE PARAMETERS XWB 8994 1 Table 2 RPC Broker Files REMOTE PROCEDURE File 8994 This file is used as a repository of server based procedures i e remote procedure calls RPCs in the context of the Client Server architecture All RPCs used by any site specific client server application software using the RPC Broker interface must be registered and stored in this file Applications running on client workstations can invoke call the RPCs in this file to be executed by the server and the results are returned to the client application Each RPC is associated with an entry point i e ROUTINE with optional TAG e TheRPC subfidd 919 05 of the OPTION File 19 points to RPC fied 01 of theREMOTE PROCEDURE file 8994 Data is not distributed with this file RPCs are distributed and installed as separate components during the installation of the RPC Broker however RPC BROKER SITE PARAMETERS file 8994 1 Site managers can usethis file to configure and adjust many characteristics of an RPC Broker installation at a site Data is not distributed with this file If you arean MSM 4 3 0 siteor greater and using MSERVER instead of the Broker Listener the current functionality provided by this fileis not applicable to your site September 1997 RPC Broker V 1 1 Technical Manual 5 File
23. mation about the queries to which they respond REMOTE PROCEDURE file 8994 e TheClient Agent application that runs on dient workstations supporting single signon e The TRPCBroker component for Delphi enabling development of client applications that can communicate via the RPC Broker A dynamiclink library DLL that provides access to Broker functionality for development environments other than Delphi September 1997 RPC Broker V 1 1 Technical Manual 1 Introduction RELATED MANUALS AND OTHER REFERENCES Readers who wish to learn more about the RPC Broker should consult the following RPC Broker V 1 1 Getting Started with the Broker Devdopment Kit RPC Broker V 1 1 Installation Guide RPC Broker V 1 1 Redease Notes RPC Broker V 1 1 Systems Manual OnlineRPC Broker Devdoper s Guide i e BROKER HLP The MIRMO ISC Operations Document Chapter 10 Programming Standards and Conventions SAC RPC Broker Home Page at the following web address http www vista med va gov softser v i nfrastr uct broker index html This site contains additional information and documentation e g F requently Asked Questions F AQs available in Hypertext Markup Language HTML Broker documentation is made available online on paper and in Adobe Acrobat Portable Document F ormat PDF The PDF documents must be read using the Adobe Acrobat Reader i e ACROREAD EXE which is freely distributed by Adobe Systems Inco
24. mpl BrokerExampl Brokerl Exampl Brokerl Exampl e DPR eAboutFrm DFM eAboutFrm PAS eFrm DFM eFrm PAS Program Files Vista Bdk32 Samples Vb5egcho September 17 BAPI32 bas egcho bas Egcho frm egcho vbp RPC Broker V 1 1 Technical Manual FileList same file as in the Windows System directory File List 8 RPC Broker V 1 1 Technical Manual September 1997 Global Translation Journaling and Protection TRANSLATION Translation is recommended for the sole RPC Broker global i e XWB global The XWB global has the potential to be read intensive as more and more remote procedures are added to it in the future For DSM and OpenM Systems It is best to translate the global to volume set other than ROU In order for translation to take effect on DSM and OpenM systems DSM and OpenM must be rebooted Cookbook recommendations should also be consulted for suggestions regarding journaling translation and replication the information here may not apply DSM for OpenVMS sites should consult the most recent Computer Operations Management and Procedures for AXP Systems COMPAS manual e OpenM sites should refer to the Configuring OpenM chapter in the VISTA NT Conversion Checklist For MSM Systems It is best to translate the global to a file server Cookbook recommendations should also be consulted MSM sites should consult the most recent 486 Cookbook and MSM Systen Man
25. nd can be a useful debugging tool for IRM To enable remote troubleshooting by I RM for all users you can put this option on the Common menu i e System Command Options menu XU COMMAND This enables any user to run the RPCTEST EXE program on their workstation at your request EXPORTED RPCs The RPC Broker distributes the following remote procedure calls RP Cs XWB CREATE CONTEXT XWB EGCHO BIGLIST XWB EGCHOLIST XWB EGCHO MEMO XWB EGCHO SORT LIST XWB EGCHO STRING XWB EXAMPLE ECHO STRING XWB EXAMPLE GET LIST XWB EXAMPLE SORT NUMBERS XWB EXAMPLE WPTEXT 14 RPC Broker V 1 1 Technical Manual September 1997 Exported Options XWB GET VARIABLE VALUE XWB FILE LIST XWB FILENAME CHECK XWB GET VARIABLE VALUE XWB RPC LIST September 17 RPC Broker V 1 1 Technical Manual 15 Exported Options 16 RPC Broker V 1 1 Technical Manual September 1997 Archiving and Purging ARCHIVING There are no package specific archiving procedures or recommendations for the RPC Broker XWB global or the REMOTE PROCEDURE and RPC BROKER SITE PARAMETERS files PURGING There are no package specific purging procedures or recommendations for the RPC Broker XWB global or the REMOTE PROCEDURE and RPC BROKER SITE PARAMETERS files September 1997 RPC Broker V 1 1 Technical Manual 17 Archiving and Purging 18 RPC Broker V 1 1 Technical Manual September 1997 Callable Routines The RPC Broker does not provide any callable M routine
26. ntains the list of DBI C approved entry points A single term used interchangeably to refer to the user the workstation and the portion of the program that runs on the workstation n an object oriented environment a client is a member of a group that uses the services of an unrelated group If the client is on a local area network LAN it can share resources with another computer server RPC Broker V 1 1 Technical Manual 33 Glossary COMPONENT COTS DATA DICTIONARY DBIA DIRECT MODE UTILITY 34 An object oriented term used to describe the building blocks of GUI applications A software object that contains data and code A component may or may not be visible These components interact with other components on a form to create the GUI user application interface Commercial Off the Shelf COTS refers to software packages that can be purchased by the public and used in support of VISTA The Data Dictionary is a global containing a description of what kind of data is stored in the global corresponding toa particular file The data is used internally by VA FileMan for interpreting and processing files A Data Dictionary DD contains the definitions of a file s elements fields or data attributes relationships to other files and structure or design Users generally review the definitions of a file s elements or data attributes programmers review the definitions of a file s internal structure Database Integr
27. nual September 1997 RPC Broker V 1 1 Technical Manual 31 Software Product Security INTERFACING Nonon VA products are embedded in or required by the RPC Broker other than those provided by the underlying operating systems ELECTRONIC SIGNATURES Electronic signatures are not used within the RPC Broker SECURITY KEYS There are no specific security keys exported with the RPC Broker software However to bypass security for development purposes we recommend client server application developers be assigned the XUPROGMODE security key All users assigned the XUPROGM ODE security key can do the following Run VISTA client server application regardless of whether it is in their menu tree or not and e Access any RPC without regard to the application context FILE SECURITY The RPC Broker establishes the following security over its files qeenemoswm e e e e efe a 1 RPC BROKER SITE PARAMETERS Table 5 File Security OFFICIAL POLICIES Modification of any part of the RPC Broker software is strongly discouraged Distribution of the RPC Broker software is unrestricted 32 RPC Broker V 1 1 Technical Manual September 1997 Glossary ACCESS CODE ALERTS ANSI MUMPS APPLICATION PROGRAMMING INTERFACE ARRAY CALLABLE ENTRY POINT CLIENT September 1997 A code that along with the verify code allows the computer to identify you as a user authorized to gain access to the
28. or maintaining the document called SAC The purpose of Security Keys is to set a layer of protection on the range of computing capabilities available with a particular software package The availability of options is based on the level of system access granted to each user The computer where the data and the Business Rules reside It makes resources available to client workstations on the network VISTA it is an entry in the OPTION file 19 An automated mail protocol that is activated by sending a message to a server at another location with the S server syntax A server s activity is specified in the OPTION file 19 and can bethe running of a routine or the placement of data into a file The Kernel module that regulates access to the menu system It performs a number of checks to determine whether access can be permitted at a particular time A log of signons is maintained RPC Broker V 1 1 Technical Manual 37 Glossary SUBSCRIPT UCI VA FILEMAN FILE MANAGER VERIFY CODE VISTA 38 A symbol that is associated with the name of a set to identify a particular subset or element In M a numeric or string value that is enclosed in parentheses is appended to the name of a local or global variable and identifies a specific node within an array User Class Identification a computing area The MGR UCI is typically the Manager s account while VAH or ROU may be Production accounts A set of programs used
29. portunity for users to select it thereby invoking the associated computing activity VISTA an entry in the OPTION file 19 Options may also be scheduled to run in the background non interactively by TaskMan RPC Broker V 1 1 Technical Manual September 1997 PROPERTIES REMOTE PROCEDURE CALL ROUTINE SAC SACC SECURITY KEY SERVER SIGN ON SECURITY September 17 Glossary An object oriented term used to describe the attributes associated with components on a GUI form These attributes collectively indicate how a component is to be displayed to the user in the application interface Properties are activated at design time A remote procedure call RPC is essentially M code that may take optional parameters to do some work and then return either a single value or an array back tothe dient application A program or a sequence of instructions called by a program that may have some general or frequent use M routines are groups of program lines that are saved loaded and called as a single unit via a specific name Standards and Conventions Through a process of verification VISTA packages are reviewed with respect to SAC guidelines as set forth by the Standards and Conventions Committee SACC Package documentation is similarly reviewed in terms of standards set by the Documentation Standards and Conventions Committee DSCC VISTA Standards and Conventions Committee This Committee is responsible f
30. rporated at the following web address http www adobe com For moreinformation on the use of the Adobe Acrobat Reader pleaserefer to the Adobe Acrobat Quick Guide at thefollowing web address http www vista med va gov softserv infrastr uct acrobat index html RPC Broker V 1 1 Technical Manual September 1997 Implementation and Maintenance The RPC Broker V 1 1 Installation Guide provides detailed information regarding the installation of the RPC Broker It also contains many requirements and recommendation regarding how the Broker should be configured Be sure to read the Installation Guide before attempting to install the RPC Broker SITE PARAMETERS This topic lists the site parameters that can be set to customize the operation of the RPC Broker The following two areas of the Broker require site parameter review and configuration e Broker Listeners e Single Signon Functionality Broker Listeners The RPC BROKER SITE PARAMETERS file 8994 1 includes a LISTENER field and various subfields The LISTENER field is a multiple and should contain all Listeners that you plan to run A simple change of the STATUS subfield from STOPPED toSTART will start that particular Listener Conversely you can STOP a RUNNING Listener the same way e For moreinformation about configuring Broker Listeners pleaserefer to the RPC Broker V 1 1 Systems Manual Single Signon Single signon means that when a user has entered their
31. s However other programming interfaces are provided e g Delphi component DLL Pascal functions and RPCs e For information on these other programmi ng interfaces please refer to the External Interfaces chapter in this manual September 1997 RPC Broker V 1 1 Technical Manual 19 Callable Routines 20 RPC Broker V 1 1 Technical Manual September 1997 External Interfaces The following external interfaces to RPC Broker functionality are provided TRPCBROKER COMPONENT The TRPCBroker component provides all functionality needed for client applications to communicate with VISTA M servers via the RPC Broker The TRPCBroker component is compatible with Borland Delphi 2 0 and greater o For moreinformation on the TRPCBroker component pleaserefer to theRPC Broker V 1 1 Getting Started with the Broker Deve opment Kit and Online RPC Broker Developer s Guide manuals TRPCBROKER DYNAMIC LINK LIBRARY DLL The TRPCBroker DLL BAPI32 DLL provides access to RPC Broker functionality for development environments other than Delphi For moreinformation on the TRPCBroker DLL please refer to the RPC Broker V 1 1 Getting Started with the Broker Devdopment Kit and Online RPC Broker Developer s Guide manuals PASCAL FUNCTIONS The following Pascal functions are provided by the TRPCBroker component e GetServerlnfo function e Splash Screen functions SplashOpen and SplashClose e Piece function e Translate function e Encryption
32. to enter maintain access and manipulate a database management system consisting of files A package of online computer routines written in the M language which can be used as a stand alone database system or as a set of application utilities either form such routines can be used to define enter edit and retrieve information from a set of computer stored files The Kernel s Sign on Security system uses the verify code to validate the user s identity This is an additional security precaution used in conjunction with the Access Code Like the Access Code it is also 6 to 20 characters in length If entered incorrectly it does not allow the user to access the computer To protect the user both codes are invisible on the terminal screen Veterans Health Information Systems and Technology Architecture VISTA includes the VA s application software i e Windows based and locally developed applications roll and scroll and interfaces such as software links to commercial packages addition it encompasses the VA s uses of new automated technology including the dinical workstations VISTA encompasses the rich automated environment already present at local VA medical facilities RPC Broker V 1 1 Technical Manual September 1997 Index A Archiving 17 B Build File vi Callable Routines 19 Client Files 6 Component TRPCBroker 21 D DBA Approvals and DBIAs 24 DECRYP XU SRB1 function 21 Diagnostic program
33. ver handled data transmissions The Kernel module that controls the presentation of user activities such as menu choices or options nformation about each user s menu choices is stored in the Compiled Menu System the XUTL global for easy and efficient access An object oriented term used to describe procedures and functions also referred to as routines associated with a particular component M ethods are called at run time They are never activated at design time A multiple valued field a subfile many respects a multiple is structured like a file A programming language recognized by the American National Standards Institute ANSI The acronym MUMPS stands for Massachusetts General Hospital Utility Multi programming System and is abbreviated as M A convention for naming VISTA package elements The Database Administrator DBA assigns unique character strings for package developers to use in naming routines options and other package elements so that packages may coexist The DBA also assigns a separate range of file numbers to each package In a tree structure a point at which subordinate items of data originate An M array element is characterized by a name and a unique subscript Thus the terms node array element and subscripted variable are synonymous In a global array each node might have specific fields or pieces reserved for data attributes such as name As an item on a menu an option provides an op
Download Pdf Manuals
Related Search