VerityServerConfiguration Properties

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

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.

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:

• Except as noted below, represents a minimum wait interval, with a maximum wait interval defined by the LeaseDuration property.
• For the CFSImportAgentConfiguration interface, represents a maximum wait interval. (The minimum interval is always 1 second and cannot be changed).
• For the AsyncProcessingConfiguration interface, represents a fixed wait interval. (In effect, represents both the minimum and the maximum wait interval).

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.

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:

• PropertyDescription.get_Id() is equal to PropertyTemplate.get_Id(), which is equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDescription.get_Id().

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.

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.

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.

The maximum number of objects that a Verity collection can contain. Do not set this lower than the default unless testing collection overflow.

For VerityServerConfiguration, this property is deprecated.

The number of batches to index prior to performing an optimization on the indexing information. Setting the default value higher increases indexing throughput at the expense of search performance.

For VerityServerConfiguration, this property is deprecated.

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.

Deprecated.
By default, IBM Legacy Content Search Engine discovers and passes search requests to the available Verity brokers (which have been configured using Verity tools). Use the ExcludedBrokers property on the VerityDomainConfiguration object to exclude any broker from Content Engine use.