Installing XStreamDB as a Windows Service

How to Configure and Run the Service Utility

First, two important configuration parameters must be correctly set.

JAVA_HOME

The environment variable JAVA_HOME must be set prior to running the install.bat file. JAVA_HOME must point to the installation directory for the Java development kit.

Note: You may skip the step below if JAVA_HOME is already defined.

To set JAVA_HOME for the service intall batch file, follow these steps:

Open a command window and change to the {XStreamDB-install-dir}Server/service directory.
Edit the install.bat and locate the line near the top which looks like:
```
:set JAVA_HOME=C:\j2sdk-1.4.1_01
```
Modify this line, removing the colon at the beginning of the line and changing the path to reflect the install directory on your machine. As an example, if the Java 2 SDK was installed into a directory such as "D:\java\j2sdk-1.4.1_01", then the modified line would look like this:
```
set JAVA_HOME=D:\java\j2sdk-1.4.1_01
```
Save the changed file.

XDB_SERVER_HOME

The environment variable XDB_SERVER_HOME must be set prior to running the install.bat file. XDB_SERVER_HOME must point to the {XStreamDB-install-dir}/Server directory.

To set XDB_SERVER_HOME for the service intall batch file, follow these steps:

Open a command window and change to the {XStreamDB-install-dir}/Server/service directory.
Edit the install.bat and locate the line near the top which looks like:
```
:set XDB_SERVER_HOME=C:\XStreamDB\Server
```
Modify this line, removing the colon at the beginning of the line and changing the path to reflect the XStreamDB install directory on your machine. As an example, if XDB was installed into a directory such as "D:\Programs\XStreamDB", then the modified line would look like this:
```
set XDB_SERVER_HOME=D:\Programs\XStreamDB\Server
```
Save the changed file.

Once the parameters are properly configured as described above, the install.bat file is ready to be used.

Open a command window and change to the {XStreamDB-install-dir}Server/service directory.
Run install.bat .

Setting Service Name

Sometimes you will have more than one XStreamDB server service installed. In this case, you will wish to name each service differently. The default name is XStreamDB. To change the service name modify the XStreamDBService.exe -install XStreamDB ... line in install.bat to be something like XStreamDBService.exe -install XStreamDBService1... where XStreamDBService1 is any name you choose. This line can be found near the bottom of the file.

The XStreamDB Service is not started automatically by the install process. You will need to manually start it the first time.

However, it is configured to be started automatically whenever the operating system is restarted. So, a manual start should only be necessary the first time.

Alternatively, you could restart the operating system to test that the XStreamDB service is correctly configured and will restart automatically.

How to Manually Start and Stop the XStreamDB Service

To manually START the XStreamDB Service:

Using the Windows START menu, select the following choices: Start / Settings / Control Panel / Administrative Tools / Services
In the right-hand panel, page down to the bottom of the list of services and locate the service named " XStreamDB ".
Right-click your mouse on the XStreamDB entry to bring up the pop-up menu and select START

To manually STOP the XStreamDB Service:

Using the Windows START menu, select the following choices: Start / Settings / Control Panel / Administrative Tools / Services
In the right-hand panel, page down to the bottom of the list of services and locate the service named " XStreamDB ".
Right-click your mouse on the XStreamDB entry to bring up the pop-up menu and select STOP .

Note: the above instructions assume a Windows 2000 Operating System. Other Windows systems may have slightly different menu choices.

Additional Information

Service Log

As configured, the XStreamDB service will produce a log file, separate from the normal Server log. This special service related log file, called XDBService.log, resides in the Server/log directory along with the normal Server log. This service log is a redirection of XStreamDB console output, both standard OUT and standard ERR output will be written to this log file.

It should be noted however, that the normal Server log will contain more detailed and relevant information regarding Server activity. Therefore, the normal Server log should always be considered the primary log for the XStreamDB Server.

Event Logging

The XStreamDB Service logs both informational events and errors into the Application section of the Windows Event Viewer. Informational messages such as when a service is started or stopped are logged. Error messages, due to a configuration problem or other system error, may also be logged. Check the Application section of the Event Viewer for errors if problems are encountered. Additionally you can check the redirected output in the XStreamDB.log file, as this is where Java exceptions will logged by the JVM.

Registry Settings

There are a number of registry settings used by the XStreamDB Server when installed as a service. All of these settings are maintained under this one registry entry:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\XStreamDB

These settings are removed during the uninstall process.

File Name	Description
ReadMe.htm	this file
install.bat	batch file to install XStreamDB as a service
uninstall.bat	batch file to remove the XStreamDB service
XStreamDBService.exe	service utility