This topic alphabetically lists the properties that apply to the DirectoryConfigurationAdam class.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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
set_DirectoryServerPassword
, passing in an
encrypted byte array. (See the Encryption.encrypt
methods for information on
encrypting the input.) Security measures prevent actual passwords from being returned, so
a call to get_DirectoryServerPassword()
returns a zero-length byte array
instead, giving an indication that the property value has been set. If the password has not been set,
the value returned by get_DirectoryServerPassword()
is null
.
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
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 389
PropertyMaximumInteger32: 65535
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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
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_ONLY
TargetAccessRequired: READ
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
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
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
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
The default value of this property is null for Active Directory service provider. The default value for other supported directory service providers is unique to the provider, as follows:
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
samAccountName
for the Active Directory service
provider and cn
for all other supported directory service providers.
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
(&(objectClass=user_defined_class)(an_attribute={0}))
, where
user_defined_class is the object class you want (for example, user) and an_attribute
is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).
The default value of this property is unique to the directory service provider, as follows:
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
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.
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
DirectoryConfiguration
object.
The default value for all directory server types supported by the FileNet P8 Content Engine is
false
, indicating that SSL is disabled.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
By default (that is, when the property value is false
), the Content Engine
Server automatically traces cross-realm group membership (also called cross-domain group
membership in Active Directory). If it reaches a realm that is not configured in FileNet
Enterprise Manager, the Content Engine server returns a "Realm not found" error and
group membership search processing stops. However, if the property value is true
when
this situation occurs, the Content Engine server logs an informational message to the
Content Engine server error log and the group membership search continues.
Note: This property is not supported for the Windows Active Directory Application Mode (ADAM) directory service provider. This is because ADAM does not support cross-realm group memberships (cross-partition memberships, in ADAM terminology).
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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
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
samAccountName
uid
cn
cn
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
(&(objectClass=user_defined_class)(an_attribute={0}))
, where
user_defined_class is the object class you want (for example, user or person) and an_attribute
is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).
The default value of this property is unique to the directory service provider, as follows:
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