CmTextSearchConfiguration Properties

This topic alphabetically lists the properties that apply to the CmTextSearchConfiguration class.

ClassDescription Property



Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DispatcherEnabled Property



A boolean value that controls the run enabled status of the dispatcher. When true, the dispatcher runs. When false, the dispatcher does not run.

For the CFSImportAgentConfiguration interface, when the value of this property is true, the dispatcher runs, but the importer as a whole might still not process import requests when the import agent sub-component has not also been enabled. For more information, see the IsImportAgentEnabled property on the CFSSiteSettings interface. For a discussion of the importer sub-components, see the CFSImportAgentConfiguration interface.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DispatcherWaitInterval Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

An interval, in seconds, between processing runs for the dispatcher; during this time, the dispatcher remains idle and waits for incoming work. The value specified by this property can represent differing wait intervals depending on the class on which the property occurs, as follows:

The interaction between the minimum and maximum intervals occurs in this manner: if in the previous processing run the dispatcher had work to perform, the duration of the subsequent wait interval that the dispatcher actually remains idle is the minimum interval; otherwise, if the dispatcher had no work to perform, the duration is the shorter of these two intervals: (a) Double the previous wait interval or (b) the maximum wait interval. As an example, assuming the minimum interval to be 35 seconds and the maximum as 120, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 70 seconds (double the previous wait interval), detects no available work, remains idle for 120 seconds (the maximum interval), detects no available work, remains idle for 120 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on. Note that, when the minimal interval equals the maximum interval (as is always the case for the AsyncProcessingConfiguration interface), this example can be simplified. If both the minimum and maximum interval is 35 seconds, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 35 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on.

For the CFSImportAgentConfiguration interface, this property, despite the name, applies to the importer sub-component known as the import agent and not to the import dispatcher; for information on the importer sub-components, see the CFSImportAgentConfiguration interface.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 3 * 60
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Id Property



A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IndexingJobTimeslots Property



A CmTimeslotList collection specifying a list of CmTimeslot objects, each of which represents a timeslot used to schedule a background IBM® Content Search Engine Services indexing task. Each timeslot specifies a local start time and day (relative to the server running the background task), and a duration. The list of timeslots controls when the indexing jobs background task is allowed to run, enabling administrators to schedule heavy indexing loads so they take place during off-peak hours. If there are no timeslots specified (the default), the indexing job task will run unrestricted and can run continuously (given enough indexing jobs).

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTimeslot
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LeaseDuration Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

The maximum interval, in seconds, allowed for a worker to process a batch before the batch is assigned to another worker. Used for multi-server coordination, this interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.

For VerityServerConfiguration, this property is deprecated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 14400
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 7200
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaxBatchSize Property



The maximum number of objects that can be submitted in a single batch for indexing. Normally, the default value should be used. However, for the best performance in your environment, you might need to adjust the value of this parameter based on your hardware configuration, file system versus database storage, and average document size.

For VerityServerConfiguration, this property is deprecated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 1000
PropertyMaximumInteger32: 65535
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaxTextFiltersPerBatch Property



The maximum number of concurrent text filter processes that are allowed per indexing batch.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 2
PropertyMaximumInteger32: 100
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaximumPreprocessingQueueSize Property



This property is not supported.

Specifies the maximum size to which the internal queue of text indexing preprocessing work items can grow before attempts to insert new items will block.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 8000
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MaximumPreprocessingWorkers Property



This property is not supported.

Specifies the maximum number of workers to be employed for text indexing preprocessing.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 8
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

PreprocessingWorkerIdleTimeout Property



This property is not supported.

Specifies the maximum period in seconds for which a text indexing preprocessing worker can be idle before terminating.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 300
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

TempDirectoryPath Property



For CmTextSearchConfiguration and VerityIndexArea objects, this property assigns the directory to be used for storing temporary indexing files. The directory must be available to the Content Engine. The Content Engine server account must have the permissions necessary to create this directory if it does not exist, and to create files in the directory. For performance reasons, it is recommended to set this value to a path that is local to both the Content Engine and IBM Content Search Services.

For a CmContentConversionConfiguration object, this property is not supported.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 255
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

TextFilterTimeout Property



The timeout value, in seconds, after which a text filter process is terminated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 5400
PropertyMaximumInteger32: 86400
PropertyMinimumInteger32: 15
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

TextSearchThreadCount Property



The maximum number of workers, per user text-search request, that can be generated to perform a search. The value of this property multiplied by the number of concurrent search requests equals the number of workers that are being created for searching tasks.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 4
PropertyMaximumInteger32: 1000
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ThreadCount Property



The maximum number of indexing workers, per Content Platform Engine instance, to use for background processing of index requests.

Content Platform Engine automatically scales the number of worker threads based on index server status to avoid overloading IBM Content Search Services with incoming work. This automatic scaling uses the value of the ThreadCount property as a base value in accordance with the following calculation:

Maximum workers per CPE instance = base value * (running CSS servers / configured CSS servers)

In this calculation, CPE instance refers to a Content Platform Engine instance, and CSS server refers to an IBM Content Search Services index server. Configured CSS servers include all registered index servers that have a status of either UNAVAILABLE OR ENABLED (that is, any status other than DISABLED). Running CSS servers include all configured servers that have a status of ENABLED. For example, suppose that you register four index servers with Content Platform Engine, enable them, and set the base value to 20. In the normal situation, all configured CSS servers are running, and the calculated maximum number of worker threads is the same as the base value: 20 * (4 / 4) = 20. Otherwise, if not all configured CSS servers are running, the calculated maximum is some fraction of the base value. For instance, if only three index servers are running, the calculated maximum is 15: 20 * (3 / 4) = 15.

Note that this property works in tandem with the MaximumConcurrentIndexingBatches property on the CmTextSearchServer class to control the indexing work load for a Content Platform Engine instance. It is not necessary for the number of maximum worker threads for indexing to be equal to the number of concurrent batches. Given sufficient computing resources, having more worker threads across all of the Content Platform Engine instances than the number of concurrent batches is healthy.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 8
PropertyMaximumInteger32: 1000
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

TotalTextFiltersAllowed Property



The total number of text filters allowed for a Content Engine server. The Content Engine server uses text filters to convert binary-formatted files to a text format. This property controls the maximum limit for the number of concurrent text filter conversions that can occur for each Content Engine process. When the value of the ThreadCount property multiplied by the value of the MaxTextFiltersPerBatch property is equal to the value of the TotalTextFiltersAllowed property, no more indexing threads can be started.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 8
PropertyMaximumInteger32: 100
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ