Configuration and ID conventions

To obtain example configuration files, install the required container.

The install_location\OmniQ\config\Container.1.xml file contains single-server configuration.

Multiple-server configuration requires more than one file. One configuration file is for the hub container, and one configuration file is required for each container.

The files for multiple-server configuration are:

install_location\OmniQ\config\Container.1.xml
install_location\OmniQ\config\Container.2.xml

Containers, hub facades, and modules are not automatically assigned unique IDs (UIDs)—you must configure them manually. The UIDs must be within the range of 1 to the UID generator’s seed value, which is 10,000 by default. See “Setting Unique ID (UID) Generator parameters”.

If a container or module is assigned an ID greater than the seed value, it may conflict with an internally generated ID and cause an unexpected error later.

Because these UIDs are split across several files, Sybase recommends that you employ a numbering convention. For example, you might use these conventions in a two-server configuration:

Container ID – a value from 1– 99. If your installation requires more than 99 servers, a different convention is required.
Container XML – includes the container ID in its name, for example, Container.1.xml.
HTTP listener – the container’s HTTP listener binds to the port number 7701. For example, the port is 7701 for container 1 and 7702 for container 2.
Hub container – always binds the RMI registry on port 7700.
Hub facade ID – on satellite containers the hub facade ID is 100 times the container ID. For example, the hub facade ID for container 2 is 200.

The default Web application always allocates its hub facade ID as 999 as it is not required to follow the other conventions.
Modules – each module has the ID of 100 times the container ID + N. For example, the first module ID on container 1 is 101, the second is 102, the third is 103 and so on.

Table 3-1 shows the attributes for the container tag.

**Table 3-1: Container tag attributes**
Attribute	Default value	Description
id	None	The unique ID of the container. This value identifies the container when it registers itself with the hub.
port	None	The TCP/IP port on which the container’s embedded HTTP server listens.

Table 3-2 shows the attributes for the SystemProperty tag. The system properties include JVM settings and global indexing and querying parameters for modules loaded within the container.

**Table 3-2: SystemProperty tag attributes**
Attribute	Default value	Description
name	None	The name of the Java system property to set. In other words, the name you use within the Java process when using the java.lang.System.getProperty (java.lang.String) method.
value	None	The string value to associate with the property name.

Table 3-3 shows the attributes for the hub tag.

**Table 3-3: Hub tag attributes**
Attribute	Default value	Description
local	false	When set to true, the real hub is loaded into the current container. Otherwise, the container loads a hub facade.
id	None	The unique ID of the hub facade, which is used when the hub facade registers itself with the real hub. If the hub is local, this attribute is not required.
host	127.0.0.1	If the hub is not local, the hub facade uses this value to contact the real hub on the RMI registry.
port	None	The TCP/IP port on which the RMI registry started by the hub container is bound. When the hub is local, the port is used when starting the RMI registry. When the hub is not local, the port is used to connect to the RMI registry to access the real hub.
bindName	Hub	The name by which the hub is bound on the RMI registry. When the hub is local, bindName is used to bind the hub. When the hub is not local, bindName is used to look up the hub.
logEvents	false	Indicates whether the event log should be enabled. The location of the hub is irrelevant.
logDirectory	data.directory\log	The full path of the directory in which events logs should be written. If logEvents is false, this attribute is not required.

Table 3-4 shows the attributes for the deployment tag.

**Table 3-4: Deployment tag attributes**
Attribute	Default value	Description
Deployment passwordHash	None	Indicates a hash of the deployment password chosen during installation. This value must be identical for all containers participating in a Sybase Search deployment, as it is used for intercontainer authentication.

Table 3-5 shows the attributes for the module tag.

**Table 3-5: Module tag attributes**
Attribute	Default value	Description
id	None	The unique ID of the module, used to identify the module when it is registered with the hub.
name	None	The name of the module.
class	None	The name of the Java class that is the module.
enabled	true	If set to false, the module is not loaded.

Table 3-6 shows the attributes for the HttpHandler tag.

**Table 3-6: HttpHandler tag attributes**
Attribute	Default value	Description
class	None	The name of the Java class that is the HTTP handler (the resource).
resourceURI	None	The HTTP URI of the HTTP handler resource. This is used to complete the URL, for example, http://container.host:container.port/resourceURI.
name	None	The name of the parameter to pass to the HTTP handler.
value	None	The string value to associate with the parameter name.