Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval.

A single index area holds data for only one object store, using one file system directory. Spreading the indexing information across multiple file systems requires the use of multiple index areas.

The ResourceStatus property is set to "full" by the server when the number of collections is equal to VerityIndexArea.MaxCollections (no more VerityCollections can be created in this IndexArea). A replacement IndexArea (having a status of "standby" will be set to "open". If the status of an IndexArea is not "open", no new Verity collections will be created in the IndexArea. However, Verity collections in the IndexArea will be searched during queries, regardless of status.


The following tables list the members exposed by IIndexArea.

Public Properties

 NameDescription
Public propertyAuditedEventsAn EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public propertyCreatorIndicates 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.

Public propertyDateCreatedIndicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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.

Public propertyDateLastModifiedIndicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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

Public propertyDescriptiveTextUser-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*
Public propertyDisplayNameThe user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public propertyIdA 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 IUser and IGroup 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, IUser.Id and IGroup.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.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

Public propertyLastModifierIndicates the name of the user who last modified 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 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).

Public propertyNameThe 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.

Public propertyPermissionsManages the discretionary permissions assigned to the object.
Public propertyResourceStatusContains a ResourceStatus object, which specifies the availability status of a storage or index area. The status value can be any one of the following:
  • OPEN
  • CLOSED
  • UNAVAILABLE
  • STANDBY

Note: When the ResourceStatus value is UNAVAILABLE, the indexer creates a new collection and completes any pending index requests using the new collection.

The Content Engine supports the following automatic transitions between status values:

  • Open to Full: Applied when adding a content element will exceed an area's maximum size or count.
  • Open to Closed: Applied when adding a content element to an area whose closure date is in the past.
  • Open to Unavailable: Applied when adding a content element to an area whose unavailable date is in the past.
  • Standby to Open: Applied when adding a content element whose storage policy contains no open areas, but does contain a standby area.

An area's status can also be changed manually as allowed by the following rules:

  • Changes to closed, full, unavailable, or standby are allowed (size, count, or closure date limits do not restrict the change).
  • Changes to open are allowed only when the size and count is below the specified limits, and the closure date is in the future (or null). This includes changes from open to open, which allow you to change limit values for an open area.
Public propertySiteIdentifies 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.
Top

See Also