Contains the Verity configuration properties that are common to all servers in a domain. Only one VerityDomainConfiguration object can exist per domain (attempts to create multiple instances of a VerityDomainConfiguration object will throw an exception). The Factory.VerityDomainConfiguration.FetchInstance method does not require an Id to fetch the VerityDomainConfiguration object.

The only two properties that must be set in VerityDomainConfiguration for full text indexing to be operational are the VerityAdminMasterServerPort and VerityAdminMasterServerHostname properties. The UserName, UserPassword, UserDomain, and UserGroup properties must all be set if security is to be enabled.

Note: The VerityServerConfiguration object contains Verity configuration properties that can be different for each server in the domain.


The following tables list the members exposed by IVerityDomainConfiguration.

Public Properties

 NameDescription
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 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 propertyUserDomainThe LDAP domain to which the user specified in UserName belongs. The values of the UserDomain, UserName, and UserPassword properties are used to login to Verity for indexing and search operations.
Public propertyUserGroupThe group to which the Content Engine user account name specified in UserName belongs. Only members of this group are allowed to add to, modify, or read the Verity collection.
Public propertyUserNameThe name of a user account assigned to Content Engine servers for access to Verity collections. The user name must be a member of the group specified in UserGroup. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to log in to Verity for indexing and search operations.
Public propertyUserPasswordThe password assigned to the Content Engine user account name specified in UserName. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to log in to Verity for indexing and search operations.

This value is encrypted (a byte array).

Public propertyVerityBrokersThe names of all Verity brokers associated with the Verity administration server specified in VerityMasterAdminServerHostname. This is the list of brokers returned from Verity.
Public propertyVerityIndexServersThe 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 propertyVerityMasterAdminServerHostnameThe 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 propertyVerityMasterAdminServerPortThe port assigned to the master Verity administration server specified in VerityMasterAdminServerHostname.
Public propertyVeritySearchServersThe 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.
Top

See Also