The configuration tool has a number of parameters, some of which are supported by Content Platform Engine.
The names of the supported parameters can be substituted for parameter_name in the following commands.
configTool list -system [-details] [-showAdvanced] [-parameter_name] [-configPath path] [-locale setting] configTool set -system parameter_name value [-configPath path] [-locale setting] configTool list -collectionName index [-details] [-parameter_name] [-configPath path] [-locale setting] configTool set -collectionName index parameter_name value [-configPath path] [-locale setting]| Name | Description |
|---|---|
| acceptorThreads† | Advanced: Specifies the number of server threads that handle client requests. Specify an integer 20 - 2000. Lower values can cause delays in handling server requests. Higher values can use too many system resources and cause out-of-memory errors. This parameter can be modified only when the server is not running. |
| backLog† | Advanced: Specifies the maximum queue length for incoming connections to the server socket. If a connection indication arrives when the queue is full, the connection is refused. This parameter cannot be modified. |
| documentRetryNumber† | Specifies the number of attempts to retry document preprocessing. Each time that preprocessing exceeds the documentTimeout limit, the document is returned to the input queue on the indexing server for another attempt until the documentRetryNumber is exceeded. If document preprocessing is not completed within the specified number of attempts (documentRetryNumber + 1), an error is generated for the document. This parameter cannot be modified. |
| documentTimeout† | Specifies the maximum time (in seconds) that is allowed for document preprocessing. If this value is exceeded, the documentRetryNumber parameter determines the number of times that preprocessing is retried. |
| idleSearchableTimeoutMS | Advanced: Specifies the maximum time (in milliseconds) that objects known as searchables are kept in memory since last use. Searchables represent full-text indexes. Search servers create searchables to facilitate the running of queries. |
| indexingChunkSize† | Advanced: Specifies the chunk size that is used when processing large documents. |
| inputQueueMemorySize† | Specifies the memory size (in MBs) of the input queue on the indexing server. The input queue contains documents that are waiting for preprocessing. The default size is 50M (M=megabytes).The documentQueueSize parameter also defines the queue size (number of documents). When the documentQueueSize parameter is specified, the lower of the two parameters defines the queue size. |
| iPV6† | Advanced: Specifies whether IPv6 connectivity is enabled or disabled. |
| keyStoreName† | Specifies the full path to the repository that contains key entries and certificate entries. This parameter can be modified only when the server is not running. |
| keyStorePassword† | Advanced: Specifies the encrypted password of the keystore. This parameter can be modified only when the server is not running. |
| logFolder† | Specifies the full path to the log directory. The default log directory is server-home\log, in which server-home is the root directory for the installed server. To change the log directory, edit the logging properties files in the server-home\config directory. The ecmts_logging.properties file determines trace log properties; the ecmts_config_logging.properties file determines command-line tool log properties. This parameter can be modified only when the server is not running. |
| maxConcurrentIndexingCollections | Advanced: Specifies the maximum number of full-text indexes that can be open for indexing concurrently. Set this value according to your available memory. This parameter can be modified only when the server is not running. |
| maxHeapSize† | Specifies the maximum heap size of the server. This value should be set according to JVM heap size specifications. For example, the maximum possible heap size that can be allocated to a 32-bit Java™ virtual machine is 1.8 GB. The default value is 1500M for 32-bit JVMs and 3G for 64-bit JVMs (M=megabytes, G=gigabytes). The value must be an integer. For example, to specify 1.8 gigabytes, enter 1800M. If an error occurs, an error code of -5 is returned. This parameter can be modified only when the server is not running. |
| maxIdleTimeMs† | Advanced: Specifies the maximum time that a socket will block on a single read operation. |
| maxMergeLoadForPurgingDeletions† | Advanced: Specifies the limit for purging deletions. When the number of concurrently running merges exceeds this value, purging deletions will not be triggered. This parameter can be modified only when the server is not running. |
| maxSortedResultsAllowed† | Advanced: Specifies the maximum number of results that can be returned for sorted queries. An error is generated if a sorted query requests more than this number of results (by default, 10,000). |
| monitorQueuesFrequency† | Advanced: Specifies the frequency in seconds that the queue information is written to the monitoring queues log file. |
| numberOfIndexerThreads† | Advanced: Specifies the number of indexing threads that run on the server. This parameter can be modified only when the server is not running. |
| numberOfPreprocessingThreads† | Advanced: Specifies the number of preprocessing threads that run on IBM® Content Search Services servers. Each preprocessing thread can include the following steps: document constructor, text extraction, language identification, tokenization, and language analysis. The value of this parameter must be equal to or less than the value of the numberOfTokenizers parameter. In addition, the value should be at least 4, and equal to or greater than the number of available processors. This parameter can be modified only when the server is not running. |
| numberOfSearchables† | Advanced: Specifies the maximum number of full-text indexes that can be open concurrently for search. This parameter can be modified only when the server is not running. |
| numberOfTokenizers† | Advanced: Specifies the number of language processors that are used for parsing input into tokens. The value of this parameter must be equal to or greater than the value of the numberOfPreprocessingThreads parameter. In addition, the value should be at least 4, and equal to or greater than the number of available processors. This parameter can be modified only when the server is not running. |
| outputQueueMemorySize† | Specifies the memory size of the output queue on the indexing server. The output queue contains documents that are waiting to be indexed after preprocessing. The default size is 50M (M=megabytes). The documentQueueSize parameter also defines the queue size (number of documents). When the documentQueueSize parameter is specified, the lower of the two parameters defines the queue size. |
| outsideInMaxProcessableDocuments† | Advanced: Specifies the number of documents that will be processed before the textExtractor process is restarted. This parameter can be modified only when the server is not running. |
| port† | Specifies the number of the port on which the IBM Content Search Services server will listen to nonsecure requests. You can disable the port by specifying a value of 0. This parameter can be modified only when the server is not running. |
| queryExpansionLimit† | Advanced: Specifies the maximal number of terms that a wildcard query can expand to. If the query exceeds this limit, an exception is thrown. This parameter can be modified only when the server is not running. |
| rangeQueryExpansionLimit† | Advanced: Specifies the maximal number of values that a range query, for example, [a TO z], can expand to. If the range query exceeds this limit, an exception is thrown. This parameter can be modified only when the server is not running. |
| securePort† | Specifies the number of the port on which the IBM Content Search Services server will listen to secure requests. You can disable the secure port by specifying a value of 0. The default is 0. This parameter can be modified only when the server is not running. |
| storeErrorInIndex† | Advanced: Specifies whether to store errors in the index. |
| supportedLanguages† | Specifies the list of supported languages. This parameter cannot be modified. |
| tempDirectory† | Specifies the full path to the location of temporary files. This parameter can be modified only when the server is not running. |
| termInfosIndexDivisorCollectionSizeGB† | Advanced: Impacts the factor for reducing memory consumption during search for large full-text indexes. This parameter can be modified only when the server is not running. |
| version† | Specifies the version number of the IBM Content Search Services server. This parameter cannot be modified. |
| Name | Description |
|---|---|
| bufferSize† | Advanced: Specifies the RAM buffer size that is used for indexing. |
| defaultConstructorName† | Specifies the name of the constructor that will be used to process all documents unless a different constructor is defined. This parameter can be modified only when the server is not running. |
| enableXMLDateSearch | Enables the indexing and searching of date/time values in XML documents. |
| enableXMLNameSpaceSearch | Enables the indexing and searching of name-space information in XML documents. |
| forceNgramForCJK† | Specifies the language processing mode for documents and queues in CJK languages. The default is true. When true, n-gram processing is used. When false, the morphological dictionaries for these languages are used. |
| indexAllLemmas† | Advanced: Specifies whether all lemmas for a specific term are indexed or only the first lemma is indexed. When true, all lemmas are indexed. |
| maxBinaryTextSize† | Specifies the maximum text size (in bytes) of binary files that are indexed. Binary files that are larger than this value are not indexed. Important: When you increase file
size limits, increase the heap size accordingly by specifying the maxHeapSize parameter.
|
| maxBufferedDocs† | Advanced: Specifies the number of documents that are flushed to the index during indexing. |
| maxMergeCount† | Advanced: Specifies the maximum number of concurrent merges. |
| maxMergeDocs† | Advanced: Specifies the largest segment (measured by the number of documents) that can be merged with other segments in the index. |
| maxMergeMB† | Advanced: Specifies the largest segment (measured in MBs) that can be merged with other segments in the index. |
| maxMergeThreadCount† | Advanced: Specifies the maximum number of threads that can perform merge activity in the index. |
| maxTextSize† | Specifies the maximum size of text files (in characters) that can be indexed. Text files that are larger than this value are truncated to this size before they are indexed. This parameter can be modified only when the server is not running. Important: When you increase file size limits, increase the
heap size accordingly by specifying the maxHeapSize parameter.
|
| maxXmlTextSize† | Specifies the maximum text size of XML files (in bytes) that can be indexed. XML files that are larger than this value are not indexed. This parameter can be modified only when the server is not running. Important: When you increase
file size limits, increase the heap size accordingly by specifying
the maxHeapSize parameter.
|
| mergeFactor† | Advanced: Specifies the number of segments that are merged at one time, and also controls the total number of segments that can accumulate in the index. |
| minDeletePercentageForMergeDeletes | Advanced: Specifies the minimum percentage of deletions in a segment that will trigger deletion purging. |
| minMergeMB† | Advanced: Specifies the minimum number of segments (in MBs) that can be merged with other segments. |
| sweetSpotLength† | Advanced: This parameter controls the calibration of the score based on the size of the document. |
| sweetSpotMaxValue† | Advanced: This parameter controls the calibration of the score based on the size of the document. |
| sweetSpotMinValue† | Advanced: This parameter controls the calibration of the score based on the size of the document. |
| Name | Description |
|---|---|
| configurationPath | Returns the configuration path of the full-text index. |
| creationDate | Returns the date on which the collection was created. |
| description | Returns the description of the full-text index that was provided as a comment when the index was created. |
| languages | Returns a list of the languages of the documents in the full-text index. |
| physicalPath | Returns the full path to the directory that contains the full-text index data. |
| serverCreationVersion | Returns the version of the server that was used to create the full-text index. |
| serverUpdateVersion | Returns the version of the server that was used to perform the most recent update on the full-text index. |
| updateDate | Returns the date of the most recent update to the full-text index. |
† Important: Do not alter the value of this parameter unless instructed to do so by a support representative from IBM Software Support.