

	    Installation Instructions for VersionControl Server
	    ===================================================	

Minimum Requirements:
=====================
1. This software is intended to run on any Windows platform that can run Java2 software. For using this on other platforms refer to UserGuide.doc which tells how to port it to other platforms.
2. JDK 1.3 Standard Edition is required. It may run on other versions of JDK, but it is not tested.
3. IBM4J/Exerces XMl library is required for XML usage. Two jar files of this library are included with the installation ZIP file.
4. This installation ZIP file has both the source and object code. Just by changing RunVCServer.bat and VCServer.properties files the VersionControl server can be runned directly. For making those modifications refer the following sections.
5. If any modifications are made to the source code then source code is to be compled and for that follow all the steps in the order they are presented.


Compiling the Source Code:
==========================
1. Edit the CompileIDL.bat file to replace <JDK_HomeDir> with the actual directory where jdk is installed, ex c:\jbuilder5\jdk1.3 . 
2. Run CompileIDL.bat file to get the JAVA classes for CORBA

3. Edit the CompileVCServer.bat file to replace <JDK_HomeDir> with the actual directory where jdk is installed, ex c:\jbuilder5\jdk1.3 . 
4. Run CompileVCServer.bat file to compile the JAVA classes of VersionControl Server

5. Edit the CompileJNI.bat file to replace <JDK_HomeDir> with the actual directory where jdk is installed, ex c:\jbuilder5\jdk1.3 . 
6. Edit the CompileJNI.bat file to replace <Path_For_Compiling_DLL> with the directories where Microsoft tools/content will be there that are required for compiling DLL out of JNI C files
7. Run CompileJNI.bat file to compile the JAVA classes of VersionControl Server


Running the VersionControl Server:
1. In VCServer.properties file replace <VCServer_IP_Address> with the IP Address of the machine on which VersionControl server has to run.
2. In VCServer.properties file replace <VCServer_Port_Num> with the Port number on which VersionControl server has to run.
3. In VCServer.properties file replace <VCServer_LogFile_With_Path> with the name (with path ) of the file to which the VersionControl server log is to be written.
4. In VCServer.properties file replace <Dir_For_ProjectDB_XML_File> with the directory path where ProjectDB.xml and ProjectDB.dtd files are placed. 
5. In VCServer.properties file replace <Dir_For_VersionDB_XML_File> with the directory path where VersionDB.xml and VersionDB.dtd files are placed. 
6. In VCServer.properties file replace <Dir_For_VersionControl_File> with the directory path where VersionControl.xml and VersionControl.dtd files are placed. 
7. In VCServer.properties file replace <Native_File_Handling_Dll> with the name(with path) of the DLL that will be used by JNI for manipulating the native file system. 
8. In VCServer.properties file replace <Debug_Level_Int> with the integer value from 100 to 105. This is for setting the level of logging to be done by VersionControl server. The values are  off=100, lowest=101, low=102, medium=103, high=104 and highest=105.
9. In VCServer.properties file replace <Log_To_Console> with eigther true or false.  If it is true then the log will be written to the console (in windows it is MS-DOS command prompt). If avalue other than true and false is enetered then it will be taken as false.

10. Edit the StartNameService.bat file to replace <JDK_HomeDir> with the actual directory where jdk is installed, ex c:\jbuilder5\jdk1.3 . 
11. Edit the StartNameService.bat file to replace <VCServer_Port_Num> with the Port Number on which the Naming Service will be published
12. Run StartNameService.bat file to run the Naming Service

13. Edit the RunVCServer.bat file to replace <JDK_HomeDir> with the actual directory where jdk is installed, ex c:\jbuilder5\jdk1.3 . 
14. Run RunVCServer.bat file to run the VersionControl Server
