Personal EFG 2.0.0 README

Installation

1. Once you have downloaded PersonalEFG_2.0.0.zip, if you would to dedicate your USB drive to EFG then unzip the contents of the file to the root directory of the drive. The advantage of installing to the root directory is that you will be able to use the autoplay menu to stop and start EFG (read more about this below). If you wish to unzip to a different folder on the drive, or if you are installing locally rather than on an external USB device, you may do so as well. Keep in mind that if you do specify a location other than the root directory you must manually start EFG from the specified directory later.

2. After unziping you have the option of either starting the EFG with default port configuration or you can run the config.bat file to manually specify ports. Once you run this file you do not have to run it again, the configuration will stick. This feature is useful if you already have Tomcat and/or MySQL installed and running on the default ports and wish to use the Personal EFG as well.

Starting EFG2 via the Autoplay menu

1. If you are planning on using the autoplay menu immediately after installation, remove and re-insert your portable device before proceeding. If you installed the EFG in a directory other than the root of the drive follow the separate set of instructions found below for manual startup.

2. Once Windows detects the drive you should be presented with a list of autoplay options. Select “Start The Electronic Field Guide (EFG2) and click ok to launch the EFG.

Autoplay Action Screen

3. While the EFG is initializing you should see a series of messages displayed in a command window. The last message you should see will look similar to “INFO: Server startup in 32797 ms”. Do not close this window! If you would like to terminate the application, start the shutdown procedure from the menu as described below.

4. The autoplay menu allows you to stop and start the EFG easily as well as view and import data. To view the menu options open “My Computer” from your desktop or start menu. You should now see EFG2 listed as a removable device.

EFG2 Icon

5. Right clicking the EFG2 icon will allow you to select a menu option from the following list.

6. To view the EFG type http://localhost:8080/efg2 (if you are using a different Tomcat port, replace 8080 with the port you entered when running config.bat) in the address bar of your browser. You may also launch this page in a browser window by selecting the “EFG2 View In Browser” option from the menu.

7. If you would like to run the data importer application, select the “EFG2 Data Importer” option from the menu. After a few moments you will be presented will a login dialog. Enter root as the username, leave the password blank and click “Login” to continue.

Data Importer Login Dialog

8. Once you have finished using the EFG software, before removing the stick you must shutdown the servers. From the autoplay menu, select the “EFG2 Shutdown” option. A second console window will appear briefly and begin shutdown. Once both command windows have closed it is safe to remove your USB device.

Starting EFG2 manually

1. To start the EFG manually, first navigate to the directory that you specified during installation. You should now see several folders, executable batch files and this readme.html file.

USBEFG Directory Contents

2. To start the EFG, double click the icon labeled USBEFG pictured above. While the EFG is initializing you should see a series of messages displayed in a command window. The last message you should see will look similar to “INFO: Server startup in 32797 ms”. Do not close this window! If you would like to terminate the application start the shutdown procedure as described below.

3. To view the EFG type http://localhost:8080/efg2 (if you are using a different Tomcat port, replace 8080 with the port you entered when running config.bat) in the address bar of your browser. You may also launch this page in a browser window by double-clicking the icon labeled view pictured above.

4. If you would like to run the data importer application, double-click the icon labeled EFG2DataImporter pictured above. After a few moments you will be presented will a login dialog. Enter root as the username, leave the password blank and click “Login” to continue.

Data Importer Login Dialog

5. Once you have finished using the EFG, before removing the stick you must shutdown the servers. From the top directory, you must double click the icon labeled shutdown pictured above. A second console window will appear briefly and begin shutdown. Once both command windows have closed it is safe to remove your USB device. If the servers do not shutdown gracefully (if you just exit the window without running EFGSTOP, if shutdown is interupted or if the computer crashes or restarts before you get a chance to shutdown properly, run the forcequit file to clean up and force the efg to stop. This will prevent EFG from encountering errors next time you run it.

$Id: readme.html 44 2011-04-01 02:52:15Z ram $

Personal EFG2.0.0 corresponds to svn release tagged bdei2AsOf20110315 in http://bdei2.cs.umb.edu/svn/efg2/tags.