Configuring the eloqdb6 service

3 Installing Eloquence on the Windows 32 bit platform

Configuring the eloqdb6 service

The eloqdb6 server is the new Eloquence A.06.00 data base server. Eloquence A.06.00 uses a new data base using the client/server approach.

In order to run the eloqdb6 service it is required to adapt your system configuration. This involves the following steps:

r Registering the eloqdb6 server with the Windows NT operating system

r Configuring your system

r Configuring the eloqdb6 server

r Configuring the eloqdb6 server startup

Registering the eloqsd server with the Windows NT operating system

The Eloquence server software is installed as Windows NT services. During the installation process the eloqdb6.exe executable is installed in the Windows NT system directory (usually \WINNT\SYSTEM32). In addition, it is automatically registered with the Windows NT Service Control Manager.

NOTE: Manual registration of the eloqdb6 service with the Windows NT Service Control Manager is usually not required since the Setup program performs a default registration. Unless you need any of the special installation variants noted below you can skip this section.

In order to manually register the eloqdb6 server with the Windows NT Service Control Manager you must execute eloqdb6.exe with the -install argument:

Log on as Administrator.
Open a Command Prompt window and change to the Windows NT system directory where the eloqdb6.exe executable is located. This is usually \WINNT\SYSTEM32.
Execute the following command: eloqdb6 -install. This makes the eloqdb6 server available to the Windows NT Service Control Manager. The NT service name is "EloqDB6".

As a special installation variant, it is possible to install multiple instances of the eloqdb6 server on a single machine. In such a scenario, a single eloqdb6.exe is made available to the Windows NT Service Control Manager more than once, with each instance using a different NT service name.

Let us assume, for example, that you intend to setup a second eloqdb6 server in order to have another data base environment for testing purposes. The first thing you should consider is that every eloqdb6 instance must have an unique NT service name. Since the first eloqdb6 has been installed with the Setup program, its NT service name is "EloqDB6". The second eloqdb6 needs a different name, so let us choose "Private EloqDB6".

To make this second eloqdb6 available to the Windows NT Service Control Manager, follow the steps shown above. In the last step, you provide the NT service name after the -install argument: eloqdb6 -install "Private EloqDB6"

The Windows NT Service Control Manager now knows about two instances of the eloqdb6 server, each with its own NT service name and treats them as two different services although both refer to the same eloqdb6.exe file. You could now provide them with two different startup options and different command line arguments (please refer to the following section "Service configuration").

If you want to uninstall the eloqdb6 server, it is important that you first remove it from the Windows NT Service Control Manager before you actually delete the eloqdb6.exe file:

Log on as Administrator.
Make sure that the eloqdb6 server is not running:

* From the Start menu, choose Settings - Control Panel. This opens the Control Panel window.

* Double-click the Services icon. This opens the Services dialog.

* Locate the eloqdb6 entry in the service list and verify that its Status column is empty. If not, select it with the mouse, press the Stop button, confirm with "Yes" and wait until the service has been stopped.

NOTE: If you have installed multiple instances of the eloqdb6 server, you must repeat this for each instance (where each instance has a different NT service name) since each of these instances refers to the same eloqdb6.exe file.

Open a Command Prompt window and change to the Windows NT system directory where the eloqdb6.exe is located. This is usually \WINNT\SYSTEM32.
Execute the following command: eloqdb6 -remove. This removes the eloqdb6 server from the Windows NT Service Control Manager.

NOTE: If you have registered multiple instances of the eloqdb6 server, you should repeat this for each instance, providing the NT service name after the -remove argument.

For example:

eloqdb6 -remove "Private EloqDB6"

After you have stopped and unregistered every instance of the eloqdb6 server you can safely delete the eloqdb6.exe file.

Configuring your System

This involves the following steps:

Configuring the TCP eloqdb6 service

Configuring the TCP eloqdb6 service

You may want to define the eloqdb6 service names in your SERVICES file. This is optional, as you can specify the port number directly in the eloqdb6.cfg configuration file.

Your SERVICES file is located in the directory \WINNT\SYSTEM32\DRIVERS\ETC. Please add a line like below:

eloqdb    8102/tcp    # Eloquence A.06.00 eloqdb6 server

where the first column specifies the service name (eg. eloqdb6) and the second column the associated port number and protocol (eg. 8102/tcp). The selected port numbers may not already be in use by another programs.

Configuring the eloqdb6 server

The eloqdb6 server is configured by editing the eloqdb6.cfg configuration file. It is located in the Eloquence configuration directory. This file provides complete inline documentation and is included at the end of this document for your reference.

The location of the Eloquence configuration directory depends on where the the Eloquence has been installed. All Eloquence configuration files are installed in the etc subdirectory of the Eloquence installation directory. This is usually C:\Program Files\Eloquence.

Configuring the eloqdb6 server startup

After the eloqdb6 server has been registered with the Windows NT Service Control Manager it can be accessed using the Control Panel:

From the Start menu, choose Settings - Control Panel. This opens the Control Panel window.
Double-click the Services icon. This opens the Services dialog.
Locate the EloqDB6 entry in the service list (or the service name you have specified during the service installation) and select it with the mouse.

Now you should specify the Startup Options by selecting the Startup... button:

If you want the eloqdb6 server to be automatically started each time Windows NT is restarted, you should select the Automatic Startup Type. This is the recommended setting.
If you select the Manual Startup Type, you have to manually start the eloqdb6 server each time Windows NT is restarted.
By default, the Log On As option is set to System Account. Alternatively, you can specify a different account using the This Account option.

When you have setup the Startup Options, you can define additional arguments for the eloqdb6 server as an option. This is usually not required (if a single instance of the eloqdb6 server is used) since all settings are normally provided in the eloqdb6.cfg configuration file. However this can be used for tracking down problems (starting the eloqdb6 server temporarily with different log options) and is mandantory if you have multiple eloqdb6 instances.

Possible arguments are:

 -c name    = configuration file
 -d flags   = log flags
 -l name    = log file name
 -s name    = service name (tcp/ip transport)

Option	Description	Equiv.*
-c name	Specifies the configuration file name
-d flags	Specifies the server log flags.	LogFlags
-l name	Specifies the server log file.	LogFile
-s name	The service name (as defined in /etc/services) or the port number where the server should listen for requests. The default value is eloqdb6.	Service

*Equivalent configuration file directive.

For example, if you wish to specify a different TCP/IP service name (the default is "eloqdb6"), you could enter the following into the Startup Parameters field:

  -save -s 8567

This will make the eloqdb6 server listen to the TCP/IP port number 8567. The leading -save argument makes this command line persistent, so that the same arguments are used each time this eloqdb6 server instance is started. If you do not specify the -save argument this options will be used only once.

Any persistent command line is associated with the NT service name, so you can (actually must) provide separate arguments to each instance of the eloqdb6 server.

If you want to make sure that the command line is empty and that any persistent command line is deleted, just specify -save without any additional arguments.

At this point, everything is configured and the eloqdb6 server can be started. Select the Start button and wait until the startup has completed.

If you did not specify a log file, the eloqdb6 server will write log messages to the Windows NT Event Log. You should periodically check this in order to get aware of possible configuration problems:

Start the Event Viewer. It is located in the Start menu (Programs - Administrative Tools).
From the Log menu, select Application. This shows the contents of the Application Log Queue.

At this time, there should be two entries concerning the EloqDB6 noting that the server has been installed and sucessfuly started.

The eloqdb6 HTTP status display

When the ServiceHttp is defined in the eloqdb6.cfg configuration file, you can use a WEB browser such as Netscape to view the configuration and state of the eloqdb6 server in your network.

To access the eloqdb6 server, you need to provide a URL like below:

http://server:port/

where server is the host name or IP number of ther system running the eloqsd server and port is the port number used for serviceHttp in the eloqdb6.cfg file.

Eloquence Installation and Configuration - 19 DEC 2002