Server parameters

The parameters in the <Server> element control the setup and behavior of the TEXTML Server entity.

Table 1. Server parameters
Parameter name Default value Description
InstanceName TextmlServer The name by which the server is known by the internal Object Request Broker. Once configured, this value should never be changed as this will stop the entire API from working.
Endpoint iiop://:2500 Defines the port where the server listens for requests. It uses the CORBA IIOP element syntax:
iiop://hostname-or-ip:portno
MaxThreadCount 10

TEXTML Server uses a pool of threads to service its API calls. Because an API call is quickly serviced, the default value is often enough.

If the maximum is reached, no new threads are created but the extra requests will be queued.

IndexationThreadCount (not specified) Number of indexing threads. TEXTML Server uses a set of worker threads to index all of its docbases and to optimize indexing speed. For each indexing batch, the worker threads index one index each, working in parallel.

If no value is specified, this value will be set internally by TEXTML Server to twice the number of effective CPUs.

ExtractionThreadCount (not specified)

Number of extraction threads. TEXTML Server uses a set of worker threads to extract from the documents the content that needs to be indexed, therefore optimizing extraction speed.

If no value is specified, this value will be set internally by TEXTML Server to the number of effective CPUs.

This parameter must always be less than the value of the IndexationThreadCount parameter.

DefaultDBLocale fr_CA (French Canada)

The default locale for new docbases.

The first two characters represent the language code, and the latter two are the country code. The language code follows the ISO-639 standard, while the country code follows the ISO-3166 standard.

For the complete ISO-639 standard, go to http://www.loc.gov/standards/iso639-2/php/code_list.php.

For the complete ISO-3166 standard, go to http://www.iso.org/iso/english_country_names_and_ code_elements.

UseICUWordParsing (not specified) ICU word parsing is a language-dependent word-separation feature that uses international components for Unicode (ICU) word parsing to identify the words of a language. By default, this feature is not used (no language specified), because TEXTML Server's internal word-separation algorithm works for all Latin-based languages. However, this parameter is recommended for docbases whose documents are in Chinese, Japanese, and Thai.
Enter the code for each of the following languages that you plan to support:
  • Simplified Chinese: zh-cn
  • Traditional Chinese: zh-tw
  • Japanese: ja-jp
  • Thai: th-th
Note: The language codes should match those specified in the xml:lang attribute of the XML documents.
If specifying more than one value, the codes should be separated by spaces; for example:
<UseICUWordParsing>zh-cn zh-tw ja-jp</UseICUWordParsing>
Tip: If your documents require ICU word parsing, set it up as the default setting for the server before creating your docbases. Once a docbase is created, changes to the server's ICU word parsing settings will not affect existing docbases.
DontUseICUWordParsing all Specifies the languages that do not require TEXTML Server's word separation feature. By default all languages are excluded.
Tip: If you plan to use ICU word parsing for some (but not all) of the documents in your docbase, be sure to specify the languages to be excluded before creating your docbases. Once a docbase is created, changes to the server's ICU word parsing settings will not affect existing docbases.
LicensePath . ./licenses The directory, relative to the configuration file path, where TEXTML Server looks for its licenses.
ConnectionTimeOut 1800 (30 minutes) The time, in seconds, that a TEXTML Server client session can remain idle before it is terminated.
RecyclingInterval 600 (10 minutes) The time interval, in seconds, at which TEXTML Server checks inactive sessions and terminates them.
HeartBeatFrequency 0 (disabled) The time interval, in seconds, at which TEXTML Server checks the performance statistics and records them to the log file specified by the File logging parameter.

Enter a value in seconds (minimum interval is 60 seconds). Enter 0 to disable this feature.

SharedMemoryPath n/a Location of the directory used for collaborative memory management. By default, this parameter is not included in the configuration file.

To enable collaborative memory management, add this parameter to the configuration file and specify the directory that will contain the memory information shared by the TEXTML Server instances.

SharedMemoryIdentifier n/a Uniquely identifies the TEXTML Server instance on the machine. This parameter is generated automatically by TEXTML Server.