The IVerityDomainConfiguration type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
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.

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

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

Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

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.

Public propertyExcludedBrokers
The names of any Verity brokers that the IBM Legacy Content Search Engine will exclude from search requests. By default, the content search engine discovers and uses all available brokers. These brokers are configured using Verity tools and are associated with the Verity domain.
Public propertyId
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 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 propertyLastModifier
Indicates 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 propertyLeaseDuration
Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

The maximum interval, in seconds, allowed for a worker to process a batch before the batch is assigned to another worker. Used for multi-server coordination, this interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.

For IVerityServerConfiguration, this property is deprecated.

Public propertyMaxBatchSize
The maximum number of objects that can be submitted in a single batch for indexing. Normally, the default value should be used. However, for the best performance in your environment, you might need to adjust the value of this parameter based on your hardware configuration, file system versus database storage, and average document size.

For IVerityServerConfiguration, this property is deprecated.

Public propertyMaxObjectsPerCollection
The maximum number of objects that a Verity collection can contain. Do not set this lower than the default unless testing collection overflow.

For IVerityServerConfiguration, this property is deprecated.

Public propertyOptimizationInterval
The number of batches to index prior to performing an optimization on the indexing information. Setting the default value higher increases indexing throughput at the expense of search performance.

For IVerityServerConfiguration, this property is deprecated.

Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyUserDomain
The LDAP domain to which the user account specified by the UserName property belongs. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to authenticate with the IBM Legacy Content Search Engine for indexing and search operations.
Public propertyUserGroup
The group to which the Content Engine user account specified by the UserName property belongs. Only members of this group are allowed to add to, modify, or read the IBM Legacy Content Search Engine collection.
Public propertyUserName
The name of a user account assigned to Content Engine servers for access to IBM Legacy Content Search Engine collections. The user account must be a member of the group specified by the UserGroup property. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to authenticate with the Legacy Content Search Engine for indexing and search operations.
Public propertyUserPassword
The UTF-8 encoded, non-encrypted password assigned to the Content Engine user account that is specified by the UserName property. To maintain password security, you can use this property to set a password, but not to read its value. Instead of returning a password value, this property returns a zero-length byte array if it has been set with a password and returns a null value if it has never been set. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to authenticate with the IBM Legacy Content Search Engine for indexing and search operations.
Public propertyVerityBrokers Obsolete.
The names of all Verity brokers associated with the Verity administration server specified in VerityMasterAdminServerHostname. This is the list of brokers returned from Verity.
Public propertyVerityIndexServers 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.
Public propertyVerityMasterAdminServerHostname Obsolete.
The name of the Verity administration server used to create Verity collections. This master administration server will be contacted by Content Engine servers for all requests to create a Verity collection.
Public propertyVerityMasterAdminServerPort Obsolete.
The port assigned to the master Verity administration server specified in VerityMasterAdminServerHostname.
Public propertyVeritySearchServers 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.

ToggleSee Also