VerityDomainConfiguration Properties

This topic alphabetically lists the properties that apply to the VerityDomainConfiguration class.

ClassDescription Property

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ClassDescription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Creator Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DateCreated Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DateLastModified Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

Id Property

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 User and Group 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, calls to User.get_Id() and Group.get_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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

LastModifier Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

UserDomain Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

UserGroup Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

UserName Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

UserPassword Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BINARY
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

VerityBrokers Property

The names of all Verity brokers associated with the Verity administration server specified in VerityMasterAdminServerHostname. This is the list of brokers returned from Verity.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

VerityIndexServers Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

VerityMasterAdminServerHostname Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

VerityMasterAdminServerPort Property

The port assigned to the master Verity administration server specified in VerityMasterAdminServerHostname.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  65535
PropertyMinimumInteger32:  1
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

VeritySearchServers Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ