This topic alphabetically lists the properties that apply to the CmIndexDefinition class.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
For an ObjectStore
object, this property specifies the location within the database. If this property is
set during creation of the object store, the Content Engine server uses the
value to control where indexes are located. A change to the property value after the object store is created
affects only the location of indexes that are added after the change. You can override the value
of this property by specifying a custom schema script during object store creation.
See Factory.ObjectStore.createInstance(domain, admins, users, schemaScript).
For a CmIndexDefinition
object, this property specifies the tablespace or filegroup in which the index is located. If you
do not provide a value for this property, the server sets the value to the index storage location specified in the corresponding
ObjectStore
property (if set). Otherwise, the location will be set to the default index storage location specified by the underlying database.
If you set the value of this property to true, the server will retain the value only if the underlying database
is capable of handling expression-based indexes and if string-valued columns have been included in the index definition.
Otherwise, the server will set the value of this property to false, and a message indicating this change is posted to the p8_server_error.log
file.
If you do not specify a value for this property, the server sets the value to true if all of the following conditions are met:
ObjectStore
is true.Otherwise, the server sets the value of this property to false.
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:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_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.
For a CmIndexDefinition
, if you set the value of this property, the value must conform
to all of the constraints on index names enforced by the underlying database. If you do not
specify a name, then the server will generate one.
For a CMTextSearchIndex
object, the value of this property is the name assigned to this IBM Content Search Services index.
CmIndexedColumnList
collection object that specifies the list of objects that define
the columns that comprise this index. The order in which the CmIndexedColumn
objects appear in the
list reflect the order in which the columns are defined in the index. At least one element is required in the
list.
The names for any key columns for a given index must be distinct from those for any other index on the same table. Note that the order in which non-key elements appear in the list of the index definition is not important. However, IBM recommends that applications place the non-key elements after the key-defining elements in the list. (A key column is a column that will be present in the ON clause of the CREATE INDEX statement; a non-key column will appear in the INCLUDE clause (or equivalent) of the CREATE INDEX statement.)
For a CmIndexDefinition
object, if the object is system-owned (the value of this property
is true), then the object cannot be modified or deleted.
For a CmIndexDefinition
object, specifies whether an index is unique (true) or not (false).
For all other objects, specifies whether the values of a multi-valued property must be unique (true) or not (false).