Docbase automatic index update parameters

The parameters in the <AutomaticIndexUpdate> element control indexing and deindexing of docbases.

Automatic index updates are automatically started after certain conditions are met (for example, after 100 documents have been added). These automatic update values are configured for:
  • Indexing (see Table 1).
  • Deindexing, whereby entries pointing to deleted documents are removed (see Table 2).
  • Indexing of custom properties (see Table 3). Because custom properties may require specific indexing behavior (for example, they may be indexed more frequently than other properties), their indexing parameters are set up separately.
Note: The automatic index update parameters can be customized for each docbase through the TEXTML Server Administration Console.
Table 1. Automatic index update parameters for indexing (<AutomaticIndexUpdate>/<indexing> element)
Parameter name Default value Description
AutomaticUpdate True If True, TEXTML Server initiates indexing when any of the criteria below is present.
DocumentCount 100 Indicates the number of documents that must be added to trigger automatic indexing.
DocumentTotalSize 0

Indicates the total size, in bytes, of added documents that will trigger indexing. If set to 0, this parameter is ignored.
Period 10 Indicates the number of seconds TEXTML Server will wait after new documents are added before triggering indexing. If set to 0, this parameter is ignored.
Time 0:0:0 Indicates the time at which indexing is triggered. If set to 0:0:0, this parameter is ignored.
IndexChange True Indicates whether a change to the Index Definition document triggers the indexing process.

If <AutomaticUpdate> is set to True, TEXTML Server initiates deindexing when any of the criteria below is present.

Table 2. Automatic index update parameters for deindexing (<AutomaticIndexUpdate>/<deindexing> element)
Parameter name Default value Description
DocumentCount 100 Indicates the number of documents that must be removed to trigger automatic deindexing.
DocumentTotalSize 0

Indicates the total size, in bytes, of removed documents that will trigger deindexing. If set to 0, this parameter is ignored.
Period 100 Indicates the number of seconds TEXTML Server will wait after documents are removed before triggering deindexing. If set to 0, this parameter is ignored.
Time 0:0:0 Indicates the time at which deindexing is triggered. If set to 0:0:0, this parameter is ignored.
IndexChange False Indicates whether a change to the Index Definition document triggers the deindexing process.

Custom properties are customer-specific metadata in addition to regular document properties. Examples of custom properties might include workflow status, dates of revision, and author name.

Table 3. Automatic index update parameters for custom properties (<AutomaticIndexUpdate>/<CustomPropertiesUpdate> element)
Parameter name Default value Description
Period 10 Indicates the interval, in seconds, at which indexing is triggered. If set to 0, this parameter is ignored.
DocumentCount 100 Indicates the number of documents with custom properties that must be added to trigger automatic indexing.
IndexChange False Specifies whether a change to the Index Definition document triggers the indexing of custom properties.
Time 0:0:0 Indicates the time at which indexing of custom properties is triggered. If set to 0:0:0, this parameter is ignored.