VisibleResults Files

VisibleResults 2.0 Installation Instructions
=========================================================================

These instructions are for a single user installation of 
VisibleResults on one PC running Windows 95, 98, ME or 2000.  They assume 
a basic working knowledge of installing Windows software and of 
using WinZip or similar program.

There are four stages to the installation:

  - checking TCP/IP is installed correctly
  - installing Firebird
  - installing InterClient
  - installing VisibleResults

Further information, including updated versions of this document, are 
available at http://visibleresults.sourceforge.net



1.  Checking TCP/IP
-------------------------------------------------------------------------

TCP/IP is the network protocol used by VisibleResults.  It is installed as 
standard on most systems, but this step checks that it is working.

You must ensure that it works before installing Firebird, InterClient or 
VisibleResults.

Open an MS-DOS command prompt.  This is available from the start menu 
either under Programs or Programs/Accessories.  Type the following 
command and press Enter:

ping localhost

If TCP/IP is installed, you should see a message like this:

  Pinging localhost [127.0.0.1] with 32 bytes of data:
  Reply from 127.0.0.1: bytes=32 time<10ms TTL=32
  Reply from 127.0.0.1: bytes=32 time<10ms TTL=32
  Reply from 127.0.0.1: bytes=32 time<10ms TTL=32
  Reply from 127.0.0.1: bytes=32 time<10ms TTL=32

If you do not see this message, please ask your system administrator to 
install TCP/IP.  You should not attempt to install VisibleResults until 
the above test works correctly.

If you have a dial up connection and it attempts to connect to the 
Internet, you will need to ask your system administrator to configure 
TCP/IP to fix this.  You should be able to connect to your own PC without 
a dialing up your ISP.  Do not choose "Work Offline" as this will not 
work.



2.  Installing Firebird
-------------------------------------------------------------------------

If you are installing from CD, run the Firebird-1.0.0.796-Win32.exe 
program in the Firebird folder.

Alternatively, you can download Firebird from 
http://prdownloads.sourceforge.net/firebird/Firebird-1.0.0.796-Win32.exe

We recommend you choose default options during the install.


When prompted to select components that will be installed, choose "Full 
installation of server and development tools".

If you are using Windows 2000, you will be prompted to install Firebird as 
a service.  Choose "Install Firebird server using the guardian service".  
It will then start automatically at boot.


If you are using Windows 95, 98 or ME, by default, Firebird is not started 
automatically when you start Windows. To start it, open Explorer and find 
the directory C:\Program Files\Firebird\bin.  You need to create a 
shortcut to the "ibserver.exe" file and put this in the C:\Windows\Start 
Menu\Programs\Startup folder.  You can get to this folder by right 
clicking on the Start button and choosing explore.  You should see folders 
corresponding to your start menu.  Drag the ibserver.exe file to the 
Startup folder using the RIGHT mouse button, and choose "Create shortcut 
here".  Do not copy or move the file.

Reboot and Firebird should have started up automatically.  You should see 
an icon (a yellow and black circle) in the task tray in the bottom right 
hand corner of the screen.



3.  Installing InterClient
-------------------------------------------------------------------------

If you are installing from CD, run the SETUP.EXE program in the 
InterClient folder.

Alternatively, you can download InterClient 2.01 from
http://prdownloads.sourceforge.net/firebird/interclient_201_Win32.zip

We recommend you choose default options during the install.


You will be prompted to read important information about the services file 
before continuing with the installation.  You will need to edit the 
services file using a text editor such as Notepad (do not use Word or 
WordPad).  This file will be called either "c:\windows\services" 
(95/98/ME) or "c:\winnt\system32\drivers\etc\services" (2000).  Make sure 
you do not edit the services.txt file instead.  The correct file will 
contain a message similar to this near the top:

  # This file contains port numbers for well known services as defined by
  # RFC 1060 (Assigned Numbers).

You should add the following line to this file, in the same way as all the 
existing ones:

  interserver         3060/tcp           # InterBase InterServer

Now save this file, exit Notepad and continue with the installation.


You may see the message "Interserver configuration not found in registry, 
using default values".  This is normal.

When prompted with the "InterServer Configuration Utility" dialog, ensure 
that the following values are chosen:

  Root Directory:  C:\Program Files\Firebird\InterClient\bin
  Server Startup:  Application
  Startup Mode:    Windows Startup


When the installation has finished, reboot and InterServer should start 
automatically.  You should see an icon for this in the task tray in the 
bottom right hand corner of the screen.



4.  Installing VisibleResults
-------------------------------------------------------------------------

If you are installing from CD, run the SETUP.EXE program in the 
VisibleResults folder.

Alternatively, you can download VisibleResults from
http://sourceforge.net/projects/visibleresults.  On the summary page there 
is a section titled "Latest File Releases".  Choose the download link to 
the right of the package "VR-JavaApp-Win", version 2.0.  Download the file 
visibleresults-2.0.0-windows-install.zip.

We recommend you choose default options during the install.


An item will be created on the start menu for VisibleResults.  You can use 
this to start the VisibleResults application.  Log in as "DAVID" with the 
password "test".  The start menu icon may not work under Windows 2000.

Various batch files are also provided for starting VisibleResults.  These 
will be installed in the C:\VisibleResults directory.  They are as 
follows:

run-application-supervisor.bat
  - to start the VisibleResults application (same as the start menu item)
  
run-application-normal.bat
  - to start the VisibleResults application with restricted functionality
  
start-server.bat
  - to start the VisibleResults web server
  
stop-server.bat
  - to stop the VisibleResults web server
  

Some functionality is only available when running the web server.  The 
application will access this by starting your default browser and loading 
a web page.  If this results in a "Page cannot be displayed" or "404 not 
found" or similar error, make sure that the web server is running.



5.  Applying updates to VisibleResults
-------------------------------------------------------------------------

Updates to VisibleResults 2.0 are available on SourceForge.  These take 
the form of a ZIP archive containing the differences since the last 
complete version.

You can download the updates from 
http://sourceforge.net/projects/visibleresults.  On the summary page there
is a section titled "Latest File Releases".  Choose the download link to 
the right of the package "VR-JavaApp-Win", version 2.0.  Download the file 
visibleresults-2.0.x-windows-changes.zip, where x is the highest number.

It is not necessary to apply each update individually.  The updates 
contain enough to upgrade from the latest complete version.

You should make sure VisibleResults is not running before 
upgrading.  Extract the ZIP file to the VisibleResults installation
directory (the default is C:\VisibleResults).  This will overwrite 
existing files in that directory.

It may be necessary for VisibleResults to upgrade the database, in which 
case you will not be able to start the program until this is done.  See 
the Troubleshooting / Frequently Asked Questions section for details on 
how to do this.



Troubleshooting / Frequently Asked Questions
-------------------------------------------------------------------------

Q.  I get the message "Upgrade to version XX must be done by web server" 
    when starting VisibleResults.
    
A.  You have installed an upgrade to VisibleResults that needs to modify 
    the database in some way.  Doing this requires exclusive access to the 
    database, so you need to shutdown VisibleResults, start the web 
    server, and visit the following URL in your browser:
    
      http://localhost:8081/upgrade
      
    After a while you will see a success/failure message.  If the upgrade 
    worked you can use VisibleResults normally.  If it did not work, 
    please email support@sundayta.com and include the output that was 
    produced.
    

Q.  When choosing an option in the application, my browser starts up but I 
    get an error "Page cannot be displayed" or "Could not connect to 
    server".
    
A.  You may be attempting to use functionality that is only available 
    though the web server.  Please make sure that you have started the web 
    server as well as the application if you require this functionality.



19 April 2002