CmTextSearchIndex Properties

The IDs of the base classes associated with this CmTextSearchIndex object.

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

The ID of the IBM® Content Search Services server that is assigned to use this IBM Content Search Services index. If the assigned IBM Content Search Services server becomes unavailable, the Content Engine server automatically chooses another server to assign to this index.

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.

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.

The name assigned to this IBM® Content Search Services index.

A list of CmIndexParitionConstraint objects, each of which represents an index partition constraint associated with this IBM® Content Search Services index. This list is read-only and is maintained by the Content Engine server. Only Content Engine objects that satisfy these constraints are indexed into a partitioned IBM Content Search Services index. An IBM Content Search Services index can have a maximum of one date index partition constraint and one string index partition constraint. A date index partition constraint specifies a date range to use to partition this index and a string index partition constraint specifies a name and value to use to partition this index.

The size, in KB, of this IBM® Content Search Services index.

The number of Content Engine objects indexed in this IBM® Content Search Services index.

An IndexingStatus object that specifies the load-balancing status of this IBM® Content Search Services index. The Content Engine server automatically reassigns an index to another IBM Content Search Services server, if necessary, to balance the indexing workload of the server. The IndexingStatus property can have one of the following values:

• NORMAL: The index is assigned to an IBM Content Search Services server and does not need to be reassigned.
• REBALANCING: The index is in the process of being reassigned to a new IBM Content Search Services server. When the index is in this state, you cannot change the value of its ResourceStatus property via the API. After the reassignment is complete, the following properties of the index are changed by the Content Engine server:
  • The CurrentIndexServer property is set to the ID of the new server.
  • The LeaseExpiryTime property is set to a new expiration time.
  • The IndexingStatus property is set to NORMAL.
• REPLACING: The index is unavailable and an index job has set the ResourceStatus property of the index to CLOSED. When the index is in this state, you cannot change the value of its ResourceStatus property via the API.

The expiration time after which the IBM® Content Search Services server assigned to this IBM Content Search Services index no longer has exclusive write access to it. The expiration time is automatically extended as long as documents are still being indexed. After this time expires, the IBM Content Search Services index can be reassigned to another IBM Content Search Services server for load-balancing purposes.

Specifies a ResourceStatus constant, which indicates the availability status of an index area, index, or storage area.

For CmTextSearchIndexArea objects, this property specifies the availability status of an IBM® Content Search Services index area. This property can hold one of the following values:

• OPEN: The index area is active and new indexes can be created in it. New indexes can only be created in an index area when this property is set to OPEN. Existing indexes can also be updated, deleted, or queried.
• CLOSED: The index area is closed to new indexes. However, existing indexes can be updated, deleted, or queried.
• FULL: The index area has reached its full capacity because the number of its indexes is equal to the value of its MaxIndexes property and all its indexes are either full or closed. This setting indicates that no more objects can be indexed in the index area. However, existing indexes can be deleted or queried. Only the Content Engine server can set the ResourceStatus property to FULL.
• STANDBY: The index area is inactive. New indexes cannot be created, but existing entries can be updated, deleted, or queried. If there are no open index areas available, the Content Engine server can set the status of an index area that is set to STANDBY to OPEN.

For these CmTextSearchIndexArea objects, the Content Engine server supports only the following manual transitions between status values:

• OPEN to CLOSED: This transition is always allowed.
• OPEN to STANDBY: This transition is always allowed.
• CLOSED to OPEN: This transition is only allowed if the value of the MaxIndexes property is greater than the number of indexes in the index area or there are open indexes in the index area.
• CLOSED to STANDBY: This transition is only allowed if the value of the MaxIndex property is greater than the number of indexes in the index area or there are open indexes in the index area.
• FULL to OPEN: This transition is only allowed if the value of the MaxIndex property is greater than the number of indexes in the index area or there are open indexes in the index area.
• FULL to CLOSED: This transition is always allowed.
• FULL to STANDBY: This transition is only allowed if the value of the MaxIndex property is greater than the number of indexes in the index area or there are open indexes in the index area.
• STANDBY to OPEN: This transition is always allowed, but it should occur automatically when one index becomes full and a standby index is opened.
• STANDBY to CLOSED: This transition is always allowed.

For CmTextSearchIndex objects, this property specifies the availability status of an IBM® Content Search Services index. This property can hold one of the following values:

• OPEN: The index is open for create index requests. New index entries can only be created in an index when this property is set to OPEN. Existing index entries can also be updated, deleted, or queried.
• CLOSED: The index is closed for create index requests. However, existing index entries can be updated, deleted, or queried. If an index job closes an index for deletion, the server sets the ResourceStatus property to CLOSED and sets the IndexingStatus property to REPLACING. As long as the IndexingStatus property is set to REPLACING, you cannot change the ResourceStatus property from CLOSED to OPEN by using the API. If the index job is canceled, the server sets the IndexingStatus property to NORMAL; the ResourceStatus property remains set to CLOSED unless it is changed by the API.
• FULL: The index has reached its full capacity, as defined by the index area to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes properties of a CmTextSearchIndexArea object). This setting indicates that no more index entries can be created. However, existing index entries can be deleted or queried. Only the Content Engine server can set the ResourceStatus property to FULL.
• UNAVAILABLE: The index is unavailable for indexing. New indexes cannot be created and existing index entries cannot be updated, deleted or queried. A query that includes an unavailable index will not fail, but it will not produce any results. An administrator should inform users when an index has been set to UNAVAILABLE. An administrator typically sets an index to the UNAVAILABLE status to prevent reindexing failures because of a corrupted index. A corrupted index that has been set to UNAVAILABLE allows reindexing to complete without generating an error that can cause the entire reindexing operation to fail. After an index has been set to UNAVAILABLE, it cannot be set to any other state; this state is a final state for the index. It is recommended that an unavailable index be reindexed as soon as possible. The server automatically creates a new index or opens a standby index to handle any pending index requests for the unavailable index. After an unavailable index is reindexed, the server deletes the unavailable index.

For these CmTextSearchIndex objects, the Content Engine server supports only the following manual transitions between status values:

• OPEN to CLOSED: This transition is always allowed.
• OPEN to UNAVAILABLE: This transition is always allowed.
• CLOSED to OPEN: This transition is only allowed if the index is not scheduled to be deleted by an index job (that is, the IndexingStatus property is not set to REPLACING).
• CLOSED to UNAVAILABLE: This transition is always allowed.
• FULL to OPEN: This transition is only allowed if the index is not at full capacity, as defined by the index area to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes properties of a CmTextSearchIndexArea object).
• FULL to CLOSED: This transition is always allowed.
• FULL to UNAVAILABLE: This transition is always allowed.

For StorageArea objects, this property specifies the availability status of a storage area. This property can hold one of the following values:

• OPEN: The storage area is open for new content. Existing content can be updated, deleted, or retrieved.
• CLOSED: The storage area has been disabled or its closure date is set and occurs in the past. In a closed storage area, new content cannot be created and existing content cannot be updated. However, existing content can be deleted or retrieved.
• FULL: The maximum size or maximum number of content elements in the storage area has been exceeded. In a full storage area, new content cannot be created and existing content cannot be updated. However, existing content can be deleted or retrieved.
• STANDBY: The storage area is in standby mode. In a standby storage area, new content cannot be created. However, existing content can be updated, deleted, or retrieved.

For these StorageArea objects, the Content Engine server supports the following automatic transitions between status values:

• OPEN to FULL: Applied when adding a content element to a storage area exceeds the maximum size or maximum number of content elements allowed in the storage area.
• OPEN to CLOSED: Applied when adding a content element to a storage area whose closure date is in the past.
• STANDBY to OPEN: Applied when adding a content element to a storage area and the storage policy contains a standby storage area but no open storage areas.

For these StorageArea objects, the Content Engine server supports only the following manual transitions between status values:

• Transitions to CLOSED, FULL, or STANDBY: These transitions are allowed at any time (size, count, or closure date limits do not restrict the change).
• Transitions to OPEN: These transitions are allowed only when the size and count are below the specified limits, and the closure date is in the future (or null). This restriction includes changes from OPEN to OPEN, which allow you to change limit values for an open area.