~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                   This is the readme file for QVCS-Enterprise.
                                 $Label: 2.1.20.2 $
    Copyright  1998-2007 Quma Software, Inc.  ALL RIGHTS RESERVED WORLDWIDE.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

QVCS-Enterprise is published by:

                           Quma Software, Inc.
                          20 Warren Manor Court
                         Cockeysville, MD  21030

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT 
IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT 
--------------------------------------------------------------------------------
If you are updating from an earlier build of QVCS-Enterprise, please make sure
to read the "Updating from Earlier Builds" sections at the end of this file.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Getting Started:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
QVCS-Enterprise is distributed in a single .zip file that contains everything
you need for both your QVCS-Enterprise server, and for QVCS-Enterprise clients.

Before you can use either server or client, you must first download and install
an appropriate Java virtual machine.  We have only tested with Sun's JVM's.
Sun's download site is available at this URL:

http://java.sun.com/j2se/downloads.html

We have tested with the Java 5 JVM.  At the very minimum, QVCS-Enterprise requires
J2SE 1.5 or later.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Step 1: Unzip the archive:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Unzip the QVCS-Enterprise zip file into an empty directory, making sure to 
preserve the directory structure of the files present in the .zip file.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Step 2: Define JAVA_HOME (for Windows users):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Edit the setEnv.cmd so that the JAVA_HOME environment variable points to the 
location of your JVM.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Step 3: Start the server:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For Windows users, open a command window, and execute the server.bat batch file.

For Linux or UNIX users, open a shell window, and execute the server.sh shell
script (you may need to chmod +x to make it executable).

The server should start up, and report the ports that it is listening on.  As
shipped, the server provides secure port on 9889 for client connections, a
secure port on 9890 for administrative connections, and a non-secure HTTP port
on 9080 for browser connections.

After the server starts, start a web browswer and point it to port 9080.  
The URL could look like:

                        http://localhost:9080/


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Step 4: Use the server's web pages to continue.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
With your web browser, click on the 'Getting Started' link on menu bar of
the web page displayed at the URL:  http://localhost:9080/.  Continue by
clicking the 'Next' link on the bottom to get to step 4 in the description 
hosted there.  The instructions there will guide you through the rest of 
getting things started.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updating from 2.0.8 and later builds:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               --------------- Updating the Server: ---------------
You will want to preserve the archives created using the earlier version of 
QVCS-Enterprise.  This is easy to do -- just replace the following existing 
files with the ones from this archive:

server_out.jar
installEnterpriseService.bat
test_enterprise_install.bat
test_enterprise_uninstall.bat

You'll should delete the ServerWebSite directory, as it is no longer needed.

               --------------- Updating clients: ---------------
When a 2.0.8 (or later) client logs in to the new version of the server, the
server will detect that the client is an older version, and the user will have
the option of updating their client 'automatically'.  If the user accepts this
automatic upgrade of the client, then when the update is complete, the user
must re-start their client application.  Note that for this automatic update
to work, it is important that the user have updated their gui.bat, admin.bat,
gui.sh, and admin.sh files to be from the 2.0.8 build (or later).

If you want to use the IDE integration feature, you will need to use the client
installer which you download from the Quma web site:  

			http://www.qumasoft.com/downloads.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updating from 1.2.10, 1.2.11, or 1.2.12 Builds, or 2.0.x builds before 2.0.8:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               --------------- Updating the Server: ---------------
You will want to preserve the archives created using the earlier version of 
QVCS-Enterprise.  This is easy to do -- just replace the following existing 
files with the ones from this archive:

server_out.jar
gui_out.jar
admin_out.jar
server.bat
server.sh
installEnterpriseService.bat
test_enterprise_install.bat
test_enterprise_uninstall.bat

You should delete the ServerWebSite directory, as it is no longer needed.

If you run your server as a Windows service, you will need to:

1. Shut down the server using stop_service.bat.
2. Run the test_enterprise_uninstall.bat batch file to uninstall the service.
3. Run the test_enterprise_install.bat to re-install the service.
4. Restart the service using start_service.bat

(Steps 2 and 3 are required since the command line used to start the service
has changed from earlier releases).

               --------------- Updating the clients: ---------------
All your clients will need to replace their copies of:

gui_out.jar
gui.sh 		(for Linux or UNIX users)
gui.bat 	(for Windows users)

admin_out.jar
admin.sh 	(for Linux or UNIX users)
admin.bat

with the copies contained here.

If you want to use the IDE integration feature, you will need to use the client
installer which you download from the Quma web site:  

			http://www.qumasoft.com/downloads.html

Clients also need to replace the qvcsBehaviorProperties/qvcs.keywords.properties
with the copy of that file contained here.  If you have made edits to that file
(for example to define your own value for expansion of the Copyright keyword),
you will need to make those same edits to the new copy of the 
qvcs.keywords.properties file.  The changes we made to that file were to add 
support for two new keywords:  FilePath and HeaderPath.



~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updating from 1.1.x Builds:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               --------------- Updating the Server: ---------------
If you are updating from a previous 1.1.x build, you will want to preserve the 
archives created using the earlier version of QVCS-Enterprise.  This is easy to 
do -- just replace the following existing files with the ones from this archive:

server_out.jar
gui_out.jar
admin_out.jar
server.bat
server.sh
installEnterpriseService.bat
test_enterprise_install.bat
test_enterprise_uninstall.bat

You should delete the ServerWebSite directory, as it is no longer needed.

If you run your server as a Windows service, you will need to:

1. Shut down the server using stop_service.bat.
2. Run the test_enterprise_uninstall.bat batch file to uninstall the service.
3. Run the test_enterprise_install.bat to re-install the service.
4. Restart the service using start_service.bat

(Steps 2 and 3 are required since the command line used to start the service
has changed from earlier releases).

               --------------- Updating the clients: ---------------
All your clients will need to replace their copies of:

gui_out.jar
gui.sh 		(for Linux or UNIX users)
gui.bat 	(for Windows users)

admin_out.jar
admin.sh 	(for Linux or UNIX users)
admin.bat

with the copy contained here.

Clients also need to replace the qvcsBehaviorProperties/qvcs.keywords.properties
with the copy of that file contained here.  If you have made edits to that file
(for example to define your own value for expansion of the Copyright keyword),
you will need to make those same edits to the new copy of the 
qvcs.keywords.properties file.  The changes we made to that file were to add 
support for two new keywords:  FilePath and HeaderPath.


                            **** Important Warning ****
                            **** Important Warning ****
                            **** Important Warning ****

Note that when updating from 1.1.x builds, you will lose any file filter 
definitions, and any view utility associations that you have defined.  You will
have to re-define these manually, after the upgrade.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updating from 1.0.x Builds:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               --------------- Updating the Server: ---------------
If you are updating from a previous 1.0.x build, you will want to preserve the 
archives created using the earlier version of QVCS-Enterprise.  This is easy to 
do -- just replace the following existing files with the ones from this archive:

server_out.jar
gui_out.jar
admin_out.jar
gui.bat
gui.sh
admin.bat
admin.sh
server.bat
server.sh
installEnterpriseService.bat
test_enterprise_install.bat
test_enterprise_uninstall.bat

You should delete the ServerWebSite directory, as it is no longer needed.

If you run your server as a Windows service, you will need to:

1. Shut down the server using stop_service.bat.
2. Run the test_enterprise_uninstall.bat batch file to uninstall the service.
3. Run the test_enterprise_install.bat to re-install the service.
4. Restart the service using start_service.bat

(Steps 2 and 3 are required since the command line used to start the service
has changed from earlier releases).

               --------------- Updating the clients: ---------------
In addition, all your clients will need to replace their copies of:

gui_out.jar
gui.sh 		(for Linux or UNIX users)
gui.bat 	(for Windows users)

admin_out.jar
admin.sh 	(for Linux or UNIX users)
admin.bat

with those contained here.

Clients also need to replace the qvcsBehaviorProperties/qvcs.keywords.properties
with the copy of that file contained here.  If you have made edits to that file
(for example to define your own value for expansion of the Copyright keyword),
you will need to make those same edits to the new copy of the 
qvcs.keywords.properties file.  The changes we made to that file were to add 
support for two new keywords:  FilePath and HeaderPath.

For both server and client, you should copy the contents of the lib directory
into a lib subdirectory beneath the QVCS-Enterprise install directory so that
looks-1.2.2.jar is contained in that lib directory.

One of the side effects of this new build:  you will have to recreate any of your
existing file filters.


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Questions or Suggestions?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To report problems or suggestions, please send e-mail to:

                                   jimv@qumasoft.com

Make sure to include 'QVCS-Enterprise' in the subject line so that we'll be able
to distinguish your suggestion and/or bug report from the THOUSANDS of daily SPAM 
messages that we receive.
