The IVerityIndexArea type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IIndexArea.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IIndexArea.)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. |
![]() | DateCreated |
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.
(Inherited from IIndexArea.)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. |
![]() | DateLastModified |
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.
(Inherited from IIndexArea.)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). |
![]() | DescriptiveText |
User-readable text that describes an object.
(Inherited from IIndexArea.)The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
(Inherited from IIndexArea.)For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality. For ICmAuditProcessingBookmark and IAuditDefinition 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 ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness. |
![]() | Id |
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}.
(Inherited from IIndexArea.)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:
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. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IIndexArea.)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). |
![]() | MaxCollections |
The maximum number of collections that can be created in this index area. If this number is exceeded, the server sets the
IndexArea.ResourceStatus property to "closed", and for this same site and object store,
changes to "open" the ResourceStatus value of the first index area found having a ResourceStatus value of "standby".
|
![]() | Name |
The name for this object.
(Inherited from IIndexArea.)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. |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from IIndexArea.) |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ResourceStatus |
Specifies a ResourceStatus constant, which indicates the availability status
of an index area, index, or storage area.
(Inherited from IIndexArea.)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:
For these CmTextSearchIndexArea objects, the Content Engine server supports only the following manual changess between status values:
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:
For these CmTextSearchIndex objects, the Content Engine server supports only the following manual changes between status values:
For StorageArea objects, this property specifies the availability status of a storage area. This property can hold one of the following values:
For these StorageArea objects, the Content Engine server supports the following automatic changes between status values:
For these StorageArea objects, the Content Engine server supports only the following manual changes between status values:
|
![]() | RootDirectoryPath |
The fully qualified path to the root directory for this index area, file storage area, or advanced storage file system device.
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. |
![]() | SearchServersToAttach |
The number of servers from the listing in the VerityIndexArea.VeritySearchServers property
that will be attached to a newly created collection. The servers chosen will be those with the fewest collections already attached to them.
|
![]() | Site |
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 IDomain.DefaultSite.
(Inherited from IIndexArea.)Note that you cannot change the site directly on an IObjectStore object. To move an object store to a different site, you must change this property on the ICmDatabaseConnection object that is referenced by the IObjectStore object. For IIsolatedRegion, this property is deprecated. |
![]() | TempDirectoryPath |
For CmTextSearchConfiguration and VerityIndexArea objects, this property assigns the directory to be used for
storing temporary indexing files. The directory must be available to the Content Engine. The Content Engine server account
must have the permissions necessary to create this directory if it does not exist, and to create files in the directory. For performance
reasons, it is recommended to set this value to a path that is local to both the Content Engine and IBM Content Search Services.
For a CmContentConversionConfiguration object, this property is not supported. |
![]() | TemplateType |
Contains the Verity style file alias name that identifies the Verity style files used for indexing data. The style files control the
format of indexed data (using exception word lists, for example).
|
![]() | VerityCollections | Obsolete.
The set of VerityCollection objects associated with this index area. Each Verity collection is a
member of only one index area.
|
![]() | VerityIndexServers | Obsolete.
The names of all Verity index servers associated with the Verity administration server specified in the
VerityMasterAdminServerHostname property. This list of index servers is returned by Verity.
|
![]() | VeritySearchServers | Obsolete.
The names of all Verity (search) servers associated with the Verity administration server specified in the
VerityMasterAdminServerHostname property. This list of index servers is returned by Verity.
|