CmTextSearchServer Properties

A CmTextSearchAffinityGroup object representing the affinity group with which the IBM® Content Search Services server or IBM Content Search Services index area is associated. An affinity group is a group of one or more servers that is dedicated to one or more index areas. Assigning IBM Content Search Services servers and index areas to affinity groups allow you to override the built-in index load-balancing feature of the Content Engine server.

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

Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

• ClassDescription
• PropertyDescription
• ClassDefinition
• PropertyTemplate
• PropertyDefinition

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For CmAuditProcessingBookmark and AuditDefinition objects, this property is intended to identify client applications that process the audit log. For CmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For AuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For CmAuditProcessingBookmark and AuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple CmAuditProcessingBookmark or AuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

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.

Determines whether the Secure Sockets Layer (SSL) protocol is enabled for instances of this object. The default value is false, indicating that SSL is disabled.

Indicates the name of the user who last modified this object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Defines the maximum number of concurrent indexing batches that can be submitted to a IBM Content Search Services server. The setting represents the configured capacity for a Content Search Services server as a whole. Therefore, the number of concurrent batches that a Content Platform Engine instance can send to the server is given by the following formula:

concurrent batches per CPE instance = (property value / CPE instances with indexing enabled)

In this calculation, CPE instances with indexing enabled includes all Content Platform Engine instances that are configured with indexing enabled. The property value is the value of the MaximumConcurrentIndexingBatches property. For example, suppose that the property value is 12 and the number of instances with indexing enabled is 2: 12 / 2 = 6 maximum concurrent indexing batches per Content Platform Engine instance.

The calculation does not take into account Content Platform Engine instances that are not running. If one of the instances stops running (because the instance is shut down, for example), the IBM Content Search Services server operates at less than the configured capacity. In the previous example, if one of the Content Platform Engines instances stops running, the remaining instance still sends a maximum of six concurrent batches. The result is that the server operates at 50% capacity. To keep IBM Content Search Services server running at full capacity, disable indexing for any Content Platform Engine instance that might not resume running soon.

Note that this property works in tandem with the ThreadCount property on the CmTextSearchConfiguration class to control the indexing work load for a Content Platform Engine instance.

Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain. If you do not specify a site when creating the associated object, the value of that object's Site property defaults to the value of Domain.DefaultSite.

Note that you cannot change the site directly on an ObjectStore object. To move an object store to a different site, you must change this property on the CmDatabaseConnection object that is referenced by the ObjectStore object.

For IsolatedRegion, this property is deprecated.

A string list of language codes, which specify the languages that are supported by the IBM® Content Search Services server for indexing documents.

The language codes in the following table are supported.

Language code	Language
af	Afrikaans
ar	Arabic
ca	Catalan
zh	Chinese
cs	Czech
da	Danish
nl	Dutch
en	English
fi	Finnish
fr	French
de	German
el	Greek
he	Hebrew
it	Italian
ja	Japanese
ko	Korean
nb	Norwegian (Bokmal)
nn	Norwegian (Nynorsk)
pl	Polish
pt	Portuguese
ru	Russian
es	Spanish
sv	Swedish

The connection token required to connect to this IBM® Content Search Services server. The administrator can obtain the connection token by using the IBM Content Search Services server configtool.bat application. The connection token can also be obtained during installation when IBM Content Search Services is installed.

The host name of this IBM® Content Search Services server.

The usage mode of this IBM® Content Search Services server. The usage mode specifies which tasks can be performed by an IBM Content Search Services server so that the work load can be balanced across multiple, task-dedicated servers. The usage mode can have one of the following values:

• INDEX_AND_SEARCH (0): The server performs both indexing and search tasks. IBM does not recommend this usage mode for a general production system.
• INDEX (1): The server performs only indexing tasks.
• SEARCH (2): The server performs only search tasks.

The port number of this IBM® Content Search Services server.

Specifies whether a shutdown request is sent to the IBM® Content Search Services server when the TextSearchServerStatus property is set to DISABLED (true) or not (false). Because the Content Engine server does not attempt to restart the IBM Content Search Services server once it is shut down, use caution if you set the TextSearchServerShutdownOnDisable property to true.

The status of the IBM® Content Search Services server. The server status can have one of the following values:

• ENABLED (0): The IBM Content Search Services server is enabled and can be specified by its usage mode (TextSearchServerMode property). If you set this property to ENABLED, the Content Engine server verifies that there is a connection to the IBM Content Search Services server. If the Content Engine server cannot connect to the IBM Content Search Services server, it automatically sets this property to UNAVAILABLE.
• DISABLED (1): The IBM Content Search Services server is disabled for maintenance purposes.
• UNAVAILABLE (2): The IBM Content Search Services server cannot be reached. The Content Engine server automatically sets this property to UNAVAILABLE if it cannot communicate with the IBM Content Search Services server. If the connection to the IBM Content Search Services server is reestablished, the Content Engine server automatically sets this property to ENABLED. This property can be set to UNAVAILABLE only by the Content Engine server. If you attempt to set this property to UNAVAILABLE by using the API, an error occurs.

When setting this property by using the API, the Content Engine server supports only the following manual transitions between status values:

• ENABLED to DISABLED
• DISABLED to ENABLED
• UNAVAILABLE to ENABLED
• UNAVAILABLE to DISABLED

Specifies whether the host name in the certificate presented by the server when establishing an SSL connection should be validated.

Specifies whether the certificate presented by the server when establishing an SSL connection should be validated.