OpenInsight for D3/mvBase Quick Start Guide Release 9.3

Transcription

1 OpenInsight for D3/mvBase Quick Start Guide Release 9.3

2 OpenInsight for D3/mvBase Quick Start Guide Page 2 of 87 INTRODUCTION... 3 STARTING OPENINSIGHT... 4 I. Starting OpenInsight... 4 II. Opening an Existing Application... 5 III. Creating a New Application... 8 CONNECTING TO YOUR D3/MVBASE DATABASE I. Requirements II. Making the connection III. Displaying and editing your data dictionaries IV. Editing a Calculated Column WORKING WITH FORMS I. Creating a Data Entry Form II. Adding/Displaying Data to/from the Table III. Creating an MDI Frame IV. Creating an MDI Child WORKING WITH POPUPS I. Creating a Popup II. Adding Popup Functionality to a Window WORKING WITH REPORTS I. Report Builder II Creating a Report SETTING AN APPLICATION ENTRY POINT OPENINSIGHT TOOLS FOR D3 INTEGRATION... 84

3 OpenInsight for D3/mvBase Quick Start Guide Page 3 of 87 Introduction Congratulations on using one of the most flexible and powerful database development tool kit in the world, OpenInsight from Revelation Software. This Quick Start guide is designed to let you jump right into application development with your D3/mvBase data. By following this document, you should be able to: 1. Attach your D3/mvBase data to OpenInsight 2. Convert data dictionaries from a D3/mvBase file 3. Create a data entry form for that data file 4. Create a Multiple Document Interface (MDI) frame with menu 5. Hook your data entry form up to the MDI frame 6. Create a popup for searching 7. Hook that popup up to your data entry form 8. Create a report against your data file 9. Hook up your report to the MDI Frame So, in less than ten steps, you will have created an entire application. The Programmer s Reference Manual found in the Help menu on the Application Manager screen will give more details and background about concepts and terms that you should become familiar with as you develop more with OpenInsight. You can also check out our website, where we have a free, online threaded discussion where you can ask questions, or search on existing issues. Thanks again for trying out such a great product! TigerLogic, D3 and mvbase are trademarks of TigerLogic Corporation.

4 OpenInsight for D3/mvBase Quick Start Guide Page 4 of 87 Starting OpenInsight I. Starting OpenInsight 1. Launch OpenInsight. 2. Start, Programs, OpenInsight Development Suite, OpenInsight Sysprog. 3. The Application Manager window for the SYSPROG application will be displayed as shown below.

5 OpenInsight for D3/mvBase Quick Start Guide Page 5 of 87 II. Opening an Existing Application 4. Choose Open Application from the File menu. The Open Application dialog box will be displayed. 5. Choose the SYSPROG application from the Name list box. 6. Click in the User Name edit line and type SYSPROG.

6 OpenInsight for D3/mvBase Quick Start Guide Page 6 of Click the OK button the open the SYSPROG application. Note: To open any application provided with OpenInsight, enter the Application Name in the User Name edit line. Passwords are not required for sample applications. The Application Manager window for the SYSPROG application will be displayed, as shown below.

7 OpenInsight for D3/mvBase Quick Start Guide Page 7 of 87

8 OpenInsight for D3/mvBase Quick Start Guide Page 8 of 87 III. Creating a New Application 8. Choose Application,New Application from the File menu to create a new application. The New Application dialog box is displayed. The Application Name and Author User Name are the only required items in this dialog box. 9. Click in the Name edit line and type MVDEMO. (Spaces are not allowed in an Application Name or User Name.)

9 OpenInsight for D3/mvBase Quick Start Guide Page 9 of Click in the User Name edit line and type MVDEMO. Note: The Inheritance drop down indicates <Default Inheritance>. This means that this newly created application inherits the components of the base application, SYSPROG, mentioned above.

10 OpenInsight for D3/mvBase Quick Start Guide Page 10 of Click the OK button to create the new MVDEMO application. The Application Manager window for the MVDEMO application will be displayed, as shown below.

11 OpenInsight for D3/mvBase Quick Start Guide Page 11 of 87 Connecting To Your D3/mvBase Database I. Requirements OpenInsight for D3 requires TigerLogic s D3 version 9.0 and above or mvbase 3.0 and above. For the purposes of this example we will be using using the MVDEMO sample database. We will presume that the D3 or mvbase system is installed on the local machine, using the default settings provided by TigerLogic. The TIGR.MVSP.dll supplied by TigerLogic must be copied to your OpenInsight directory. This file can be found in: C:\Program Files (x86)\tigerlogic\d3\d3programs\mvsp\mvspnetapi.zip

12 OpenInsight for D3/mvBase Quick Start Guide Page 12 of 87 II. Making the connection 1. The easiest way to define a new D3/mvBase connection for the D3 Connector is to use the D3/mvBase Connection Wizard. It can be found in OpenInsight versions 9.3 and greater, in the Database Manager.

13 OpenInsight for D3/mvBase Quick Start Guide Page 13 of From the Database Manager choose Utilities, Other MV Tables, D3/mvBase Connection Wizard.

14 OpenInsight for D3/mvBase Quick Start Guide Page 14 of When the Wizard is first started, the user is presented with a Welcome screen. Clicking on the Next button brings up the next panel which prompts the user for the Connection Name.

15 OpenInsight for D3/mvBase Quick Start Guide Page 15 of The name of the connection is used by OpenInsight to attach to the data. Below you can see that we have named this connection MVDEMO.

16 OpenInsight for D3/mvBase Quick Start Guide Page 16 of Clicking on the Next button brings up a panel that prompts for the location of the Shadow Dictionary location. Shadow Dictionaries are OpenInsight versions of the column definitions that define the D3/mvBase table. OpenInsight does not want to affect the column definitions on the D3/mvBase data source, so a local copy is made. There are a number of advantages to this, including formatting for OpenInsight reports. The Wizard offers a default folder location where the shadow dictionaries will be created. If a full path is not specified a directory will be created within your OpenInsight folder. We will accept this default, and then click on the Next button.

17 OpenInsight for D3/mvBase Quick Start Guide Page 17 of The next panel displayed is where the IP address of the D3/mvBase server is entered. The IP Address lets OpenInsight know the address of the server, either on the local machine, the local network, or the world wide web. The wizard defaults the IP Address to , which is the local host machine. You should either change it to the address given to you by the System Administrator.

18 OpenInsight for D3/mvBase Quick Start Guide Page 18 of Clicking on the Next button brings up the Server Port panel. The Server Port number is port number on the server that OpenInsight will connect through. D3 version 9.0 and mvbase version 3.0 supports port number 9000, so that is what OpenInsight defaults to. You can either accept the default, or change it to the Port Number given to you by the System Administrator.

19 OpenInsight for D3/mvBase Quick Start Guide Page 19 of Clicking on the Next button brings up the Account/Directory panel. The Account/Directory Panel is where the user enters the name of the account where the D3/mvBase files are stored, or the directory that holds the D3 files the user wants to work with. For the purposes of this exercise we will use the MVDEMO account. Enter that name and click on the Next button.

20 OpenInsight for D3/mvBase Quick Start Guide Page 20 of This will bring up the Logon Credentials form. The Logon Credentials screen is where the user enters the information needed for OpenInsight to connect to the D3/mvBase Server. The Logon ID is a username accepted on the server The Password is the password required by the Logon ID. The Logon Procedure is the name of a procedure that will run on the D3 server when OpenInsight connects using the Logon ID specified. None of these fields are required.

21 OpenInsight for D3/mvBase Quick Start Guide Page 21 of For the purposes of this exercise, enter a Login ID of DM and click on the Next button. Neither a Password nor Logon Procedure is needed. 11. Clicking on the Next button brings up the Completion panel. Click on the Finish button to complete the Wizard. The D3/mvBase Connection is now ready for use.

22 OpenInsight for D3/mvBase Quick Start Guide Page 22 of The Database Manager will now display the D3/mvBase Volume that we named MVDEMO. All the tables (files) within that volume are displayed.

23 OpenInsight for D3/mvBase Quick Start Guide Page 23 of Clicking on a table will create the shadow dictionaries for use with OpenInsight. 14. If you right click on the table name you can bring up the table option menu. Select Table Browser to browse the data on the D3/mvBase server.

24 OpenInsight for D3/mvBase Quick Start Guide Page 24 of 87

25 OpenInsight for D3/mvBase Quick Start Guide Page 25 of 87

26 OpenInsight for D3/mvBase Quick Start Guide Page 26 of You can modify your D3/mvBase Connection Information from Database Manager, Utilities, Other MV Tables, D3/mvBase Connection Setup.

27 OpenInsight for D3/mvBase Quick Start Guide Page 27 of The Volume Tables tab allows you to attach selective tables.

28 OpenInsight for D3/mvBase Quick Start Guide Page 28 of The Dictionary Settings tab allows you to specify how data dictionaries are refreshed.

29 OpenInsight for D3/mvBase Quick Start Guide Page 29 of 87 III. Displaying and editing your data dictionaries 1. Select Table Builder from the Application Tools menu or press the Table Builder button.

30 OpenInsight for D3/mvBase Quick Start Guide Page 30 of Select File, Open from the Table Builder dialog box.

31 OpenInsight for D3/mvBase Quick Start Guide Page 31 of Your D3/mvBase tables will display. Select a table to view the converted dictionaries. OpenInsight for D3 will convert your D3/mvBase dictionaries to the OpenInsight format and store them in the Shadow Dictionaries location you specified in the D3/mvBase Connector Wizard.

32 OpenInsight for D3/mvBase Quick Start Guide Page 32 of Once a table is selected, the converted dictionaries will be displayed in the Table Builder. Double click on any column to view the dictionary details.

33 OpenInsight for D3/mvBase Quick Start Guide Page 33 of 87

34 OpenInsight for D3/mvBase Quick Start Guide Page 34 of Change the Len properties on each dictionary column to match as shown below:

35 OpenInsight for D3/mvBase Quick Start Guide Page 35 of Below are the converted dictionaries of the ORDERS table. Correlatives and conversions have been converted to Calculated Columns. Double click on a calculated column to view its dictionary properties.

36 OpenInsight for D3/mvBase Quick Start Guide Page 36 of 87 IV. Editing a Calculated Column 1. Double-click in the row containing SHIPADDRESS of the Calculated Columns edit table at the bottom of the Table Builder window. This will display the Calculated Column Attributes window. is a system variable used to store the value of a calculated column.

37 OpenInsight for D3/mvBase Quick Start Guide Page 37 of 87 Working with Forms I. Creating a Data Entry Form 1. Open the Form Designer. Click on Form Designer from the Application Tools menu or press the From Designer button.

38 OpenInsight for D3/mvBase Quick Start Guide Page 38 of Choose New Form from the File menu in the Form Designer to display the New Form dialog box. 3. Select OpenInsight Tables from the Data Source drop-down list. A list of native tables is displayed in the left list box.

39 OpenInsight for D3/mvBase Quick Start Guide Page 39 of Select the OpenInsight table from the list in the left list box (by double-clicking the name). Choose CUSTOMERS 5. The columns from the selected table are displayed in the Fields/Columns list box. 6. Select columns from the Fields/Columns list box to use in creating the OpenInsight form. To select a column, double-click on the column name in the Fields/Columns list box or select the column and click the Add button. The selected columns are displayed in the selected columns edit table. The order in which columns are selected sets the tab order for the controls in the OpenInsight form being created. Select all the fields. 7. The default control type for columns is an edit line. The edit table control is the default control type for a multi-value column. If you want to specify another control type, select the appropriate column row in the selected columns edit table and double-click to display a list of control types. Double-click the required control type in the control type list for the specified column. The new control type is indicated in the selected columns edit table. 8. If you want to remove a column from the selected columns edit table, select the column row and click the Remove button. The row is deleted from the edit table and therefore not displayed on the OpenInsight form. 9. When all columns have been selected and the required controls specified, click the OK button to create the default OpenInsight form. The form should resemble the following:

40 OpenInsight for D3/mvBase Quick Start Guide Page 40 of Rearrange and resize your controls from the Tools menu.

41 OpenInsight for D3/mvBase Quick Start Guide Page 41 of Save the form by choosing Save from the Form Designer File menu. The Save As dialog box will be displayed. 12. Type CUSTOMERS in the Form Name field and click the OK button.

42 OpenInsight for D3/mvBase Quick Start Guide Page 42 of 87 II. Adding/Displaying Data to/from the Table 1. Choose Preferences from the Form Designer Tools menu and verify that Actual data tables is selected in the Testrun with: group then click the OK button. This assures that the data you create is saved in the CUSTOMERS table.

43 OpenInsight for D3/mvBase Quick Start Guide Page 43 of Click the TEST RUN button or choose Test Run from the Form Designer File menu. 3. Type an initial value (1 50) for the Customerid then tab off the field. The form will display the customer information. 4. You can also enter a new customer record by selecting a Customerid greater than Press control + S or choose Save Row from the File menu to save this record. The record is saved, the form is cleared. After adding or displaying the last record, choose Close from the File menu to exit the form. This will return you to the Form Designer. III. Creating an MDI Frame Multiple Document Interface (MDI) windows are child windows or OpenInsight forms that belong to a parent frame and are displayed in the window client area. The MDI Frame is the main window and normally contains a menu, a client area and a status line. The MDI Frame controls all of the child windows. The MDI children are the OpenInsight forms that appear within the client area of the MDI frame.

44 OpenInsight for D3/mvBase Quick Start Guide Page 44 of Select New MDI frame from the Form designer File menu to display the MDI Client Window.

45 OpenInsight for D3/mvBase Quick Start Guide Page 45 of An MDI frame with an MDI client window is displayed. The MDI client window is part of the frame window and cannot be deleted or copied. MDI child windows are confined to the MDI client area. The text MDI Client Window is visible only during OpenInsight form design so that you can distinguish the MDI client area from other controls. The Client Window should display as follows: The MDI Client Window can be resized.

46 OpenInsight for D3/mvBase Quick Start Guide Page 46 of 87 IV. Creating an MDI Child MDI Child windows are those that reside within the MDI client area. MDI Child windows can be any OpenInsight form created for the current application. MDI Child windows are often created prior to creating the MDI frame. A feature of MDI child windows is that they do not contain menus. Menu functionality is provided by the frame. An MDI child is executed from the MDI frame with the BASIC+ function START_MDICHILD. 1. Choose Design from the Menu menu. The Menu Builder dialog box is displayed. The first menu item is highlighted.

47 OpenInsight for D3/mvBase Quick Start Guide Page 47 of Select Insert item after selection from the Edit menu. 3. Type &Customers in the Popup/item text field. The Popup/Item ID: field is automatically populated. 4. Choose Exit/Update from the File menu.

48 OpenInsight for D3/mvBase Quick Start Guide Page 48 of Choose QuickEvents from the Menu menu. The QuickEvents dialog box is displayed. 6. Choose FILE.CUSTOMERS from the Event drop down list.

49 OpenInsight for D3/mvBase Quick Start Guide Page 49 of Choose Start MDI child window from the QuickEvent Options: list. The QuickEvent dialog box will be populated with default settings for the Start_MDIChild function. 8. On the Parameters: change ChildName to CUSTOMERS and CreateParam to null ( ). Include the single quotes.

50 OpenInsight for D3/mvBase Quick Start Guide Page 50 of Press the Accept button. This will place a <q> next to FILE.CUSTOMERS in the Event field. 10. Press the Close button. This will return you to the MDI Frame.

51 OpenInsight for D3/mvBase Quick Start Guide Page 51 of Select Save from the File menu. Enter MVDEMO_MDI for the name of the form.

52 OpenInsight for D3/mvBase Quick Start Guide Page 52 of Test run the form. Choose Test Run from the File menu in the Form Designer. The following will display:

53 OpenInsight for D3/mvBase Quick Start Guide Page 53 of Choose Customers from the File menu. The following screen will display: Your application now contains MDI capability.

54 OpenInsight for D3/mvBase Quick Start Guide Page 54 of 87 Working with Popups I. Creating a Popup 1. Launch the User Interface Workspace by clicking on User Interface Workspace from the Application Tools menu or press the UI Workspace button.

55 OpenInsight for D3/mvBase Quick Start Guide Page 55 of Choose New from the File menu; choose Popup from the New Entity dialog box to display the Popup Designer below.

56 OpenInsight for D3/mvBase Quick Start Guide Page 56 of Type: Customers in the title edit line on the General tab. This is displayed in the title bar of the popup. Review the other options on this tab and accept the defaults, then click the Source tab.

57 OpenInsight for D3/mvBase Quick Start Guide Page 57 of Click the Source tab where you specify a data source used to populate the Popup. Review all options and choose Select Rows from Table.

58 OpenInsight for D3/mvBase Quick Start Guide Page 58 of Click the Selection tab (which is dependent on the Source you selected). Regardless of the appearance of the Selection page, the process to be performed is that of selecting the specific data to be displayed in the Popup. The definition of a selection formula may be required. Select CUSTOMERS from the Table drop down. Choose the fields you want displayed from the Available list and click the right arrow button. This will place the fields selected in the selected list.

59 OpenInsight for D3/mvBase Quick Start Guide Page 59 of Click the Layout tab to describe how you want the Popup to look including column headings and alignment, width, etc. This is pre-populated with settings from the data dictionary.

60 OpenInsight for D3/mvBase Quick Start Guide Page 60 of Click the Value tab where you specify what information you want the Popup to return, and specify the number of selections that can be made in the Popup.

61 OpenInsight for D3/mvBase Quick Start Guide Page 61 of Click the Options tab where a number of miscellaneous characteristics of the Popup are specified.

62 OpenInsight for D3/mvBase Quick Start Guide Page 62 of Save the Popup, and then test it by choosing File, Test Run.

63 OpenInsight for D3/mvBase Quick Start Guide Page 63 of 87 II. Adding Popup Functionality to a Window The most common use of a Popup is to provide users with a list of choices during data entry. The following procedure will demonstrate how to add a button to an existing form and the Event Handler necessary to execute the Popup and place the results within a data field. 1. Open the Form Designer. 2. Select Open from the File menu. Choose the CUSTOMERS form. 3. From the Controls tool bar select a button by clicking on the OK button icon, in the upper right corner

64 OpenInsight for D3/mvBase Quick Start Guide Page 64 of Place the control on the form by moving the mouse cursor to a location on the form where you want to place the control. The mouse cursor changes to the control s icon with a + appearing to the left and above the icon as soon as the mouse cursor enters the form. The + is used to help position the control. Click the left mouse button where you want to place the control. The control is displayed in the form in the selected state (with handles visible). 5. Double-click on the button. The Push Button Properties window will appear. Change the Name of the control to BTN_CHOOSE_CUSTOMER and the Text that is displayed on the control to Choose Customer.

65 OpenInsight for D3/mvBase Quick Start Guide Page 65 of Click on the Events button to display the QuickEvent dialog box.

66 OpenInsight for D3/mvBase Quick Start Guide Page 66 of The CLICK event will be chosen by default. 8. Click on the Scripts button. This will launch the Event Editor. In the Editor type the following code: declare subroutine Set_Property, Send_Event declare function Popup retval = Popup(@window,"","CUSTOMERS") Set_Property(@window:".CUSTOMERID", DEFPROP,retval) Send_Event(@window:".CUSTOMERID","LOSTFOCUS") 9. Select Check Syntax from the File menu. Any errors will be displayed at the bottom of the Event Editor window. If the syntax is correct the status line will display The syntax is correct. This will cause a popup to display when the Choose Customers button is clicked. The user may choose a Customer. The value chosen will be placed into the CUSTOMERID control on the Customers form. When the CUSTOMERID field loses focus a read of the CUSTOMERID placed into the field will occur.

67 OpenInsight for D3/mvBase Quick Start Guide Page 67 of Select Exit/Update from the File menu. This will save the code and return to QuickEvent dialog box. 11. Press the Apply button. This will place a <s> next to CLICK in the Event field. 12. Press Close. This will return you to the Push Button Properties window. Select OK on the properties window. This will return you to form. 13. Choose Save from the File menu.

68 OpenInsight for D3/mvBase Quick Start Guide Page 68 of To test run the MDI Frame, access the Customers form from the File menu and click on the Choose Customer button.

69 OpenInsight for D3/mvBase Quick Start Guide Page 69 of 87 Working with Reports I. Report Builder+ The OpenInsight Report Builder is a tool used to create R/List type reports. Using the Report Builder+ the developer or end-user can create columnar reports on any attached table with a minimum of effort. II Creating a Report In this procedure you ll create a columnar report based on the CUSTOMERS table. Exit all tools and return to the Application Manager. 1. Click on Report Builder from the Application Tools menu or press the Report Builder button.

70 OpenInsight for D3/mvBase Quick Start Guide Page 70 of Choose New Report from the File menu. The Select Table dialog box is displayed. Select the CUSTOMERS table.

71 OpenInsight for D3/mvBase Quick Start Guide Page 71 of Enter your report description and choose your output fields from the Available Columns list box.

72 OpenInsight for D3/mvBase Quick Start Guide Page 72 of Once your entries are completed on the Columns tab, click on the Column Patterns tab to set your column properties. 5. From the Available Columns list box, select the following fields by double clicking on the Column Name for each specified field and clicking the > button. CUSTOMERID ORGANIZATIONNAME CONTACTNAME PHONENUMBER STATE

73 OpenInsight for D3/mvBase Quick Start Guide Page 73 of The selected field names display in the Selected Columns list. Note: If the Selected Columns are not in the order in which you want them to appear on the report, click the Reorder button to display the Reorder Dialog box. 7. Click on the Column Patterns tab to set the properties of each column. Click on each column to set its column properties.

74 OpenInsight for D3/mvBase Quick Start Guide Page 74 of Click on the Selection tab to create your selection criteria. Click the Insert button to add it to the Current Criteria.

75 OpenInsight for D3/mvBase Quick Start Guide Page 75 of Click on the Sort and Display Order tab to set your column order and sorting criteria.

76 OpenInsight for D3/mvBase Quick Start Guide Page 76 of Click on the Options tab to set your Header and Footer options.

77 OpenInsight for D3/mvBase Quick Start Guide Page 77 of To save the report, choose Save from the File menu.

78 OpenInsight for D3/mvBase Quick Start Guide Page 78 of Type CUSTOMERS as the report name and click the OK button.

79 OpenInsight for D3/mvBase Quick Start Guide Page 79 of Choose Print Preview from the File menu. The following report will be displayed. 14. Click the Close button on the Preview window.

80 OpenInsight for D3/mvBase Quick Start Guide Page 80 of 87 Setting an Application Entry Point The application entry point is the first window that is displayed when the application is executed at runtime. For our purposes this will be the MDIFrame MVDEMO_MDI. The following steps will define the application entry point. 1. Choose Application Properties from the Application Manager File menu to display the Application Properties dialog box shown below.

81 OpenInsight for D3/mvBase Quick Start Guide Page 81 of Click the SETUP ENTRY POINT button (in the bottom left hand corner of the dialog box). The Setup Application Main Entry Point dialog box is displayed, as shown below. 3. Clear the No Application Entry Point check box. The window names in the Window Name list box become enabled. 4. Select the form MVDEMO_MDI in the Window Name list box. 5. Click the OK button to update the application Entry Point option and return to the Application Properties dialog box. Click the OK button to close this dialog. 6. You will need to close and reopen OpenInsight to the MVDEMO application. Now, choose Run Application from the File, Application Manager File menu. Your application will now launch.

82 OpenInsight for D3/mvBase Quick Start Guide Page 82 of Select the MVDEMO application and enter MVDEMO in the User Name edit line, then click the OK button to execute the MVDEMO APPLICATION. 8. The MVDEMO_MDI window is displayed in runtime mode.

83 OpenInsight for D3/mvBase Quick Start Guide Page 83 of 87 Congratulations! You ve successfully completed your first application using OpenInsight for D3. And what you ve learned here is just the beginning. You may continue by taking a look at the sample applications that are included with OpenInsight, or begin your own development project. Whatever your choice, we wish you continued success using OpenInsight.

84 OpenInsight for D3/mvBase Quick Start Guide Page 84 of 87 OpenInsight Tools for D3 Integration Subroutine Test_TGBFS_Subcall( connection_name ) /* ** Sample program showing how to interact with the server ** By writing a record ** Issuing a TCL command ** Calling a program ** ** In this example we create the text for a D3 program ** Write the text in the BP file on the server using WRITE_ROW ** Issue commands to compile and catalog it using TGBFS_EXECPROC ** Call the subroutine on the server with parameters using TGBFS_SUBCALL ** rjc Created */ $Insert msg_equates $Insert logical $Insert vol_table_equates $Insert SSPERRORS_600 Declare Function Msg, TGBFS_execproc, GET_STATUS call Set_Status(0) * Edit the volume id and program name to suit your needs * The volume id is the connection name in the TGBFS_CONNECTION_DETAILS window * If not passed in, for an existing connection If Assigned(connection_name) Else connection_name = '' If connection_name # '' Then Call Attach_table(connection_name, '', '') End else Locate 'TGBFS' Setting pos Then connection_name end If connection_name = '' Then Msg(@window, 'Unable to determine the connection to use, terminating') Return '' end end *--- * Create an example program which will have two parameters * The program will accept a value in the first parameter * and return a modified value in the second parameter * In real life you will call an existing catalogued program * You can call any routine with 0 to 30 parameters * You can pass data in and or out of any parameter *--- * the name of the program program_file = 'DEMO_BP' ; * I ASSUME you have a DEMO_BP file. Change this to a different file as needed Open program_file to f_program_file Else err = '' Call Get_Status(err)

85 OpenInsight for D3/mvBase Quick Start Guide Page 85 of 87 End err) return * OI name may be differnt from server name. Parse it from the handle Equ handle.delim$ To \F7\ ; * double squiggly server_file_name = Field(f_program_file, handle.delim$, 2) program_name = 'OI_CLIENT' ; * Define it program_body = 'SUBROUTINE ':program_name:'(inparam, OUTPARAM)' program_body<-1> = '* Test program to Demonstrate calling D3 from OI' program_body<-1> = '' program_body<-1> = 'OUTPARAM="TODAY YOU PASSED *" : INPARAM : "*"' program_body<-1> = 'END' * Write it to the server, don't bother to lock the record lock_flag = 0 ssp_response = '' Call Write_Row(program_file, program_name, program_body, lock_flag) Call Get_Status(ssp_response) Call Set_Status(0) If ssp_response<1,1> # SSP_ROW_WRITTEN_OK$ Then In ssp_response Msg(@window, 'Unable to write row : ssp_response) Return '' end *--- * Compile it at the server using Execproc * TGBFS_EXECPROC is very useful in other situations too * Note that you can use TGBFS_EXECPROC to send ANY tcl command and capture the reps * result_code = TGBFS_execProc(connection_name, command, captured, preplies, pinteractive ) * connection_name = connection name from the connection defintion window * captured = the output of the command, i.e. what would appear on the screen in a terminal session * preplies = Similar to a DATA statement, you can supply an FM delimited list of answers to expected prompts * pinteractive = '' ; * True if the you want OI to put up a message box if the server prompts for data *--- debug command = 'BASIC ' :server_file_name : ' ' : program_name : ' (O' captured = '' preplies = '' pinteractive = '' result_code = TGBFS_execProc(connection_name, command, captured, preplies, pinteractive ) If result_code eq -1 Then Msg(@window, 'Unable to execute command ' : Quote(command) ) Return '' End Else In captured Msg(@window, captured) End *--- * Cataloged it now using execproc

86 OpenInsight for D3/mvBase Quick Start Guide Page 86 of 87 * Note thst if you run the program multiple times D3 will prompt "Do you want to Overwrite (Y/N)" * So, pass a "Y" in preplies, D3 will use it as the answer * If you expect multiple prompts, pass delimited string of answers *--- command = 'CATALOG ' : server_file_name : ' ' : program_name preplies = '' ; * Y' ; * provide a reply incase server prompts about overwriting result_code = TGBFS_execProc(connection_name, command, captured, preplies, pinteractive ) If result_code eq -1 Then Msg(@window, 'Unable to execute command ' : Quote(command) ) Return '' End Else In captured Msg(@window, captured) End *---- * Finally... * Call The procedure using the TGBFS_SUBCALL subroutine * Usage: * subroutine TGBFS_SUBCALL(tconnection_name,tSubName,tParamCount,P1,P2,P3,P4,P5,...,P30) * IN sconnection_name = D3 volume name or handle * IN SubName = Name of subroutine to Execute * IN ParamCount = Number of parameters expected by the subroutine ( 0-30 ) * IN/OUT P1... P30 ( Optional) parameter values, default to '' * * The called routine must be a cataloged subroutine on the server * if the called routine changes any parameter the calling routine can retrieve it * In this example we have 2 parameters, passing data in the first, getting response from the second *--- ParamCount = 2 ; * our example uses 2 parameters inparam = timedate() ; * our example expects something in the first param outparam = '' ; * our example expects nothing in the second param Call TGBFS_Subcall(connection_name, program_name, ParamCount, inparam, outparam) * echo the result call msg(@window, inparam : outparam ) Return ''

87 OpenInsight for D3/mvBase Quick Start Guide Page 87 of 87 Revelation Software, Inc 99 Kinderkamack Road Ste 109 Westwood, NJ U.S.A Toll Free: Phone: Fax: Revelation Software Ltd. 45 St Mary s Road Ealing, London, W5 5RG U.K. Phone: Fax: info@revsoft.co.uk Revelation Software Australia Pty Ltd. PO Box 300 Brookvale, NSW 2100 Australia Phone: Fax: Revelation Software is a division of Revelation Technologies, Inc. Part No