Sybase Search example configuration files can be obtained upon request, and the quickest way to obtain configuration files is to install the required container.
The files for a single-server configuration are located in <installLocation>\OmniQ\config\Container.1.xml.
Multiple-server configuration requires more than one file. One configuration file is for the hub container and one configuration file is required for each satellite container.
The files for multiple-server configuration are respectively located in:
<installLocation>\OmniQ\config\Container.1.xml
<installLocation>\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 1,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, you must employ a numbering convention. The example two-server configuration files use the following conventions:
Container ID – a value from 1– 99.
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 8000 plus the container’s ID. For example, the port is 8001 for Container 1 and 8002 for Container 2.
Hub container – always binds the RMI Registry on port 7000.
Hub facade ID – on satellite containers this is 10 times the container ID. For example, the hub facade ID for Container 2 is 20.
An exception is that the default Web application always
allocates its hub facade ID as 999 as it does not need 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.
The single server configuration does not strictly follow this convention as all IDs are visible in the same file, making the assigning of duplicate IDs less likely. If the Sybase Search installation requires more than nine servers, a different convention is necessary.
Table 4-1 shows the attributes for the container tag.
Attribute |
Default value |
Description |
|---|---|---|
id |
None |
The unique ID of the container. This value is used to identify 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 4-2 shows the attributes for the SystemProperty tag. The system properties include JVM settings, Stellent SearchML settings, and global indexing and querying parameters for modules loaded within the container.
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 4-3 shows the attributes for the hub tag.
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 |
This is 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 |
This value indicates whether or not the event log should be enabled. The location of the hub is irrelevant. |
logDirectory |
<data.directory>\log |
Table 4-4 shows the attributes for the module tag.
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 4-5 shows the attributes for the HttpHandler tag.
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. |
