CmTextSearchIndexArea 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.

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

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

The priority for changing this index area from a standby index area to an open index area. The higher the value of this property, the lower the priority. The highest priority is 0, which is the default value.

When an open index areas becomes full, the Content Engine server chooses the standby index area with the highest priority and sets it to open. If two or more index areas exist with the same priority, one of these standby index areas is chosen randomly by the server.

You can control this feature by setting the JVM parameter com.filenet.engine.cbr.LegacyStandbyActivationPolicy on your application server. By default, this JVM parameter is false, which instructs the Content Engine server to open a standby index area when an index area becomes full. Set this JVM parameter to true to instruct the Content Engine server to open a standby index area only when all the index areas are either full or closed. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters.

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.

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).

The maximum number of IBM® Content Search Services indexes that can be created in this IBM Content Search Services index area before it is considered to be at full capacity. If this index area exceeds this maximum, and all its indexes are also full or closed, its resource status (ResourceStatus property) is automatically set to FULL. Setting this property is optional. A value of -1 indicates no limit.

The maximum number of objects that an IBM® Content Search Services index in this IBM Content Search Services index area can contain before it is considered to be at full capacity. If an index exceeds this maximum, its resource status (ResourceStatus property) is automatically set to FULL. Setting this property is optional. A value of -1 indicates no limit.

The maximum size, in KB, that an IBM® Content Search Services index in this IBM Content Search Services index area is allowed to have before it is considered to be at full capacity. If an index exceeds this maximum, its resource status (ResourceStatus property) is automatically set to FULL. Setting this property is required.

The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Manages the discretionary permissions assigned to the object.

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.

The fully qualified path to the root directory for this index area or file storage area. The path can be a local mount point, a local path, or a UNC path.

For CmTextSearchIndexArea objects, the root directory is used by IBM® Content Search Services servers to store IBM Content Search Services indexes within a given index area. All the IBM Content Search Services servers that belong to the same object store site that contains the index area must be given read and write permissions to this directory. If the root directory that you specify does not exist on your machine, the server will create one.

If you assign an affinity group to an index area, only the IBM Content Search Services servers assigned to that affinity group need to have read and write permissions to the root directory of the index area; it is not necessary to assign permissions to the other servers in the site. When an index area is assigned to an affinity group, it is recommended that you use a root directory that is local for all the IBM Content Search Services servers in the affinity group. Doing so can improve performance because input/output operations are faster for local disks.

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 CmTextSearchIndexList collection specifying a list of CmTextSearchIndex objects, each of which represents an IBM® Content Search Services index that has been created in this index area.

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.