Identifies the full text indexing information used for a particular base class and all of its subclasses. A VerityCollection is associated with only one IndexArea, and the full text information is stored in a file system directory identified by the VerityIndexArea.RootDirectoryPath property.

For each VerityCollection object in the Content Engine database, there is a corresponding collection maintained by the Verity software that actually holds the full text index data. The name of this collection is identified in the VerityCollection.CollectionName property.

VerityCollection objects are automatically created by the server when needed, and do not need to be created by a client application. When full text indexing is available, and the first instance of a class is created or modified, the server looks for an existing VerityCollection associated with the appropriate base class, and will use this VerityCollection. If a VerityCollection is not found, a new VerityCollection is created, along with the corresponding collection maintained by the Verity software.

An application can set the ResourceStatus property to "closed" if a problem occurs with writing data to a particular VerityCollection, or to "unavailable" if the collection is expected to be made available again eventually.

The ResourceStatus property is set to "full" by the server when the number of rows in the collection is greater than VerityServerConfiguration.MaxRowsPerCollection (no new data will be written to the collection). Whenever a collection is needed for writing full text information, the collection is selected from the list of eligible "open" collections. If no open collection exists, then a collection with a status of "standby" is selected, and that collection’s status is changed to "open".

New indexing information is written only to collections having a status of "open". However, all collections, regardless of their status, are searched when queries are performed. To prevent a collection from being searched, the associated VerityCollection object must be deleted.


The following tables list the members exposed by IVerityCollection.

Public Properties

 NameDescription
Public propertyBaseClassIdsThe IDs of the base classes associated with the VerityCollection instance. There will only be one ID value in this property for release 4.0 (or later) installations. For installations upgraded from a release prior to 4.0, there may be both Annotation and Document class ID values in this property, since these releases stored indexing information for both the Annotation and Document objects in the same Verity collection.
Public propertyCollectionNameThe name assigned to the Verity collection.
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 propertyOriginalOrdinalThe ordinal number of the Verity collection if this collection was created prior to the Content Engine 4.0 release.

For objects indexed in this collection, an arithmetic function is performed on the object's GUID to map it to an ordinal number, indicating this ordinal number (the collection in which the object resides).

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

See Also