OpenInsight 9.3 Arev32 Quick Start Guide

OpenInsight 9.3 Arev32 Quick Start Guide A Division of Revelation Technologies, Inc.

COPYRIGHT NOTICE 1996-2011 Revelation Technologies, Inc. All rights reserved. No part of this publication may be reproduced by any means, be it transmitted, transcribed, photocopied, stored in a retrieval system, or translated into any language in any form, without the written permission of Revelation Technologies, Inc. SOFTWARE COPYRIGHT NOTICE Your license agreement with Revelation Technologies, Inc. authorizes the conditions under which copies of the software can be made and the restrictions imposed on the computer system(s) on which they may be used. Any unauthorized duplication or use of any software product produced by Revelation Technologies, Inc., in whole or in part, in any manner, in print or an electronic storage-and-retrieval system, is strictly forbidden. TRADEMARK NOTICE OpenInsight is a trademark and Advanced Revelation is a registered trademark of Revelation Technologies, Inc. Windows Explorer is a registered trademark of Microsoft, Inc. Part No. 811-964 Printed in the United States of America.

TABLE OF CONTENTS INTRODUCTION... 4 STARTING OPENINSIGHT... 5 I. STARTING OPENINSIGHT... 5 II. OPENING AN EXISTING APPLICATION... 6 PREPARING FOR YOUR CONVERSION... 7 I. REVIEWING YOU EXISTING AREV APPLICATION... 7 II. CREATING YOUR APPLICATION IN OPENINSIGHT... 11 CONVERTING YOUR APPLICATION TO AREV32... 13 I. STARTING THE AREV32 CONVERSION WIZARD... 13 II. PREPARING YOUR APPLICATION FOR RECOMPILE... 27 III. RECOMPILING PROGRAMS AND PREPARING THE ENVIRONMENT... 35 IV. LAUNCHING YOUR AREV32 APPLICATION... 42 V. INVOKING THE GRAPHICAL OPENINSIGHT DEBUGGER WHEN USING AREV32... 52

Arev32 9.3 Quick Start Guide Page 4 of 54 Introduction Congratulations on using one of the most flexible and powerful databases in the world, OpenInsight from Revelation Software. This Quick Start guide is designed to help you port your existing Advanced Revelation application into OpenInsight using the Arev32 interface. The Arev32 interface allows users and developers to run Advanced Revelation (Arev) character-based MultiValue applications in a VT100-compliant console application powered by OpenInsight. The Arev32 code is built into OpenInsight, but requires some external set up. Arev32 works as its own development and runtime environment, so an application could be created from scratch. However, it is expected that most systems that will be using Arev32 will be installed using the Arev32 Conversion Wizard import process. Before starting the conversion process please take note of the following: If your source application is Arev version 3.1 or below, remove the indexes in Arev and add them back manually in Arev32. If your application uses any custom MFS s, copy them into the OpenInsight application before starting the Arev32_Conversion_Wizard. When Arev source code is compiled in Arev32, as a default the precompiled code is stored in the OI_PRECOMPILED_CODE table. Arev32 runs in an Arev 3.12 type environment. In Arev 3.12 many of the commands were changed. LISTFILES became LISTTABLES, COPY became COPYROW, etc. In the VOC supplied with Arev32 we have both sets of commands. If you have a local VOC that you will be attaching in your application, typing the command OLDSTUFF at Arev32 will create the old commands. Thanks again for trying out such a great product!

Arev32 9.3 Quick Start Guide Page 5 of 54 Starting OpenInsight I. Starting OpenInsight 1. Launch OpenInsight. 2. Start, Programs, OpenInsight Development Suite, OpenInsight Sysprog.

Arev32 9.3 Quick Start Guide Page 6 of 54 II. Opening an Existing Application 3. The Application Manager window for the SYSPROG application will be displayed as shown below.

Arev32 9.3 Quick Start Guide Page 7 of 54 Preparing for your conversion I. Reviewing you existing Arev application 1. Below is a screen image of the Arev application HOMECARE that we are going to convert. 2. From TCL we will list the VOLUME names attached to this application.

Arev32 9.3 Quick Start Guide Page 8 of 54 3. From TCL we will list the files attached to this application and note the application name (HOMECARE).

Arev32 9.3 Quick Start Guide Page 9 of 54 4. From TCL we will list the files that contain RBASIC programs.

Arev32 9.3 Quick Start Guide Page 10 of 54

Arev32 9.3 Quick Start Guide Page 11 of 54 II. Creating your application in OpenInsight 5. From the File menu of the Application Manager we will create a New Application.

Arev32 9.3 Quick Start Guide Page 12 of 54 6. We will name the new OpenInsight application HOMECARE and create a user called HOMECARE. 7. Your HOMECARE application has been created and you are now logged in to that application.

Arev32 9.3 Quick Start Guide Page 13 of 54 Converting your application to Arev32 I. Starting the Arev32 Conversion Wizard 8. Highlight AREV32_CONVERSION_WIZARD from OpenInsight Form Executables and double-click on the item while holding the SHIFT key down.

Arev32 9.3 Quick Start Guide Page 14 of 54 9. The Arev32 Conversion Wizard will launch. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 15 of 54 10. Enter the name of the OpenInsight/Application to which the Arev application should be converted. The OpenInsight Account/Application must be an existing application. Enter the name of the Arev Account/Application to be converted. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 16 of 54 11. Enter the location of the Arev application s SYSTEM table. Click the Browse button to navigate to the correct path. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 17 of 54 12. In the From Locations column, enter the location(s) of the Arev application s files to be converted. Thses should contain all the locations necessary to run your existing application. In the To Locations column, enter the location(s) of the new Arev32 application s directory to which the existing Arev application files should be copied. The To Locations column data should not contain spaces. Note: If the location does not exist, the system will prompt with a question to create the folder. If a path is not specified the data folders will be created in your OpenInsight directory. Revelation Software suggests that the data folders should be located within the OpenInsight directory for optimum performance. The Double Click event of the edit table will display the Browse For Folder dialog box. The location selected will be placed into the column and row of the edit table in which the cursor is active. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 18 of 54 13. Check the box to rebuild indexes. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 19 of 54 14. Check the box to replace dots with underscores in your dictionary tables. Click Next to continue. Note: Underscores are an OpenInsight convention. Clicking on the box will facilitate in converting your Arev32 applications to OpenInsight, however you will need to then manually retrofit all source code (functions, subroutines and dictionary symbolics) to recognize the underscores.

Arev32 9.3 Quick Start Guide Page 20 of 54 15. Check the box to recompile programs. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 21 of 54 16. Check the box to copy your tables. It is recommended that all tables be copied. Click Next to continue.

Arev32 9.3 Quick Start Guide Page 22 of 54 17. Click Finish to complete the Wizard. Note: At any point during the Wizard the Back button may be clicked to change settings or the Cancel button may be clicked to cancel the process.

Arev32 9.3 Quick Start Guide Page 23 of 54 18. Once the Wizard is complete the Arev32 Conversion window is displayed. The window will be populated using the information you provided to the Wizard. The conversion information must be saved by clicking the Save Info button. A record containing the conversion information will be created within the SYSENV table. The key to the record is AREV32_SCREEN_RECORD_@DBID. The Load Info button will load the saved information into the form.

Arev32 9.3 Quick Start Guide Page 24 of 54 19. Click the Convert App button. The Arev32 conversion process will then begin. A series of messages will be displayed within the status lines at the bottom of the screen. Once the application has been created, the source files will be displayed in the edit table beneath the button row.

Arev32 9.3 Quick Start Guide Page 25 of 54 20. Messages being displayed within the status line.

Arev32 9.3 Quick Start Guide Page 26 of 54 21. Click the Save Info button, then the Close button. Prior to recompiling your programs the volumes must be detached and re-attached. Completely close OpenInsight and then re-open.

Arev32 9.3 Quick Start Guide Page 27 of 54 II. Preparing your application for recompile 22. From the Application Manager select Application Tools, Database Manger. Double-click on OpenInsight Tables to display the volumes currently attached to OpenInsight.

Arev32 9.3 Quick Start Guide Page 28 of 54 23. The DATAVOL2 and HOMECARE volumes that were added by the Arev32 Conversion Wizard must be removed and re-attached. From the Database Manager select File, Remove Table.

Arev32 9.3 Quick Start Guide Page 29 of 54 24. All tables in the DATAVOL2 volume will be removed. 25. All tables in the HOMECARE volume will be removed.

Arev32 9.3 Quick Start Guide Page 30 of 54 26. Once the tables have been removed the Database must be saved. From the Database Manager select Database, Save.

Arev32 9.3 Quick Start Guide Page 31 of 54 27. Selected tables from the DATAVOL2 and HOMECARE volumes will now be added. From the Database Manager select File, Add Table.

Arev32 9.3 Quick Start Guide Page 32 of 54 28. The DATAVOL2 volume does not contain any system tables, therefore all tables will be attached to the database.

Arev32 9.3 Quick Start Guide Page 33 of 54 29. The HOMECARE volume contains system tables. These system tables should not be attached to the database and are not selected. 30. Several tables may be already attached and the new version will need to replace the existing version.

Arev32 9.3 Quick Start Guide Page 34 of 54 31. Once your tables are re-attached to the database the database must be saved. From the Database Manager select Database, Save. The application is now ready to resume the recompilation process.

Arev32 9.3 Quick Start Guide Page 35 of 54 III. Recompiling programs and preparing the environment 32. The AREV_TO_AREV32 form will be utilized to resume the conversion process. From the Application Manager select OpenInsight Form Executables, AREV_TO_AREV32. Holding the Shift key down, doubleclick on AREV_TO_AREV32 to launch the form.

Arev32 9.3 Quick Start Guide Page 36 of 54 33. The conversion information that was saved in step 18 will be loaded into the form by selecting the Load Info button.

Arev32 9.3 Quick Start Guide Page 37 of 54 34. Select only the row(s) with tables containing programs for re-compilation. If tables with programs are not listed add them manually. Click the Recompile button. The recompile process will display messages in the form s status lines.

Arev32 9.3 Quick Start Guide Page 38 of 54 35. Once complete, a report will display with the results from the compilation. Any programs with errors must be corrected and recompiled within Arev32. Click the Close button on the Conversion form to complete the conversion process.

Arev32 9.3 Quick Start Guide Page 39 of 54 36. In order to emulate the Client/Server environment of Arev, it is suggested to modify the SYSENV CTO record within OpenInsight to not utilize the Engine Server. By default OpenInsight is configured to use the Engine Server. From the Application Manager select Application Tools, System Editor, File, Open, Record.

Arev32 9.3 Quick Start Guide Page 40 of 54 37. Select the SYSENV table and CFG_CTO record.

Arev32 9.3 Quick Start Guide Page 41 of 54 38. Replace attribute 1 of this record with a. and save the record. OpenInsight is now configured for use with Arev32.

Arev32 9.3 Quick Start Guide Page 42 of 54 IV. Launching your Arev32 application 39. To launch your Arev32 application from the Application Manager select Application Tools, Arev32. Make sure all your start up processes are set correctly.

Arev32 9.3 Quick Start Guide Page 43 of 54 40. Your converted Arev application launches to the Main Menu.

Arev32 9.3 Quick Start Guide Page 44 of 54 41. Existing windows run as-is.

Arev32 9.3 Quick Start Guide Page 45 of 54 42. By default Arev32 sets the default printer to the OIPI (OpenInsight Printer Interface) pseudo printer.

Arev32 9.3 Quick Start Guide Page 46 of 54

Arev32 9.3 Quick Start Guide Page 47 of 54 43. Any standard print output directed to the OIPI printer will display to the Print Preview window. The captured output can then be re-directed to any printer on the network, saved as a pdf or emailed.

Arev32 9.3 Quick Start Guide Page 48 of 54 44. To launch your application directly into Arev32 you need to set up your Application Entry Point. From the Application Manager select File, Application Properties.

Arev32 9.3 Quick Start Guide Page 49 of 54 45. Click the Setup Entry Point button.

Arev32 9.3 Quick Start Guide Page 50 of 54 46. Choose AREV32_STANDALONE_FORM as your Application Entry Point. Click OK. You must close OpenInsight for your changes to take effect. When OpenInsight is re-started your application will launch directly into Arev32.

Arev32 9.3 Quick Start Guide Page 51 of 54 47. You can launch your Arev32 application as a child window from your MDI frame. 48. From the Form Designer for your MDI frame choose Start MDI child window and set the Parameters as shown below.

Arev32 9.3 Quick Start Guide Page 52 of 54 V. Invoking the Graphical OpenInsight Debugger when using Arev32 In OpenInsight 9.2.1 and above, when using CTO or AREV32, it is now possible to debug your processes using the graphical OpenInsight debugger (as opposed to the character-based alternate debugger that is used by default in CTO and AREV32). You must be using an EngineServer connection (as opposed to the direct, local connection specified with. in the CTO configuration record (found in SYSENV or the MD table of the application)). Make sure you are running the EngineServer on your desktop, in a DOS command box using the java command (java -jar oesocketserver.jar), and not as a service. Edit your CTO configuration record (named CTO*<username> in the MD table of the application you re running in, or just CTO in the MD table, or CTO in the SYSENV table), verifying that field 1 contains your local machine ID (either 127.0.0.1, or localhost, or the actual IP address or name of the local machine), and field 2 contains the port that the EngineServer will be listening on (8088 by default) in its first value. The third and fourth values contain the startup and shutdown flags, respectively; set them both to 1, and save your configuration record. Your CTO record should now look like this: Once you have saved your modified CTO record, you can start up CTO or AREV32. You should see a visible OpenEngine (OEngine) start on your desktop. By default, when CTO or AREV32 starts up, the alternate debugger is automatically enabled. OpenInsight 9.2.1 and above allows you to change this dynamically with the RTI_SET_DEBUGGER command. From TCL in CTO or AREV32, issue the command: RTI_SET_DEBUGGER 1 Or from within a stored procedure add the following line: CALL RTI_SET_DEBUGGER( 1 ) This will re-enable the normal OpenInsight graphical debugger. Now, when you encounter a run-time error, or a DEBUG statement, the OEngine on your desktop will launch the graphical debugger, allowing you to step through your CTO or AREV32 routine.

Arev32 9.3 Quick Start Guide Page 53 of 54 Congratulations! You ve successfully completed your first Arev32 application using OpenInsight. 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.

Revelation Software, Inc 99 Kinderkamack Road,, First Floor Westwood, NJ 07675 U.S.A Toll Free: 800-262-47477 Phone: 201-594-1422 Fax: 201-722-9815 www.revelation.com Revelation Software Ltd. 45 St Mary s Road Ealing, London, W5 5RG U.K. Phone: +44 0 208 912 10000 Fax: +44 0 208 912 1001 www.revsoft.co.uk Software Australia Pty Ltd. PO Box 300 Brookvale, NSW 2100 Australia Phone: +61 2 8003 4199 Fax: +61 2 9332 6099 www.revelationsoftware.com.au Revelation Software is a division of Revelation Technologies, Inc. Part No 811-964