The ICmDirectoryConfigurationRadiantOne type exposes the following members.
Properties
Type | Name | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) | ||||||||||||||||||||||||
![]() | DirectoryServerHost |
Identifies the LDAP directory server or servers to use. See also the DirectoryServerPort property.
(Inherited from IDirectoryConfiguration.)The value of this property can be any one of the following:
Failover list format
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN Separate the host name and port number pairs with one space character. In the following example, the first pair specifies LaurelTree as the machine name and 389 as the port number: LaurelTree:389 OliveTree:636 FigTree:389 Content Engine makes connection attempts to directory servers based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a directory server or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established directory server connection. For instance, given the example list, Content Engine first attempts to connect to the directory server on the LaurelTree machine on port 389. If that attempt fails, it attempts to connect to the directory server on the OliveTree machine on port 636. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the directory server on OliveTree, the connection attempts start over again with LaurelTree. | ||||||||||||||||||||||||
![]() | DirectoryServerPassword |
The UTF-8 encoded, non-encrypted user password for authenticating to a given directory server.
To maintain password security, you can use this property only to set a password, 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.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | DirectoryServerPort |
The port number of the directory server.
(Inherited from IDirectoryConfiguration.)Content Engine ignores this property when the value of the DirectoryServerHost property is a failover list. For information about failover lists, see the DirectoryServerHost property. | ||||||||||||||||||||||||
![]() | DirectoryServerProviderClass |
Specifies the directory server provider class name.
The value of this property defaults to the following strings for the directory server types
that the FileNet® P8 Content Engine supports:
(Inherited from IDirectoryConfiguration.)
| ||||||||||||||||||||||||
![]() | DirectoryServerType |
The type of directory server for the directory server configuration. The value
for this property is one of the following:
(Inherited from IDirectoryConfiguration.)
| ||||||||||||||||||||||||
![]() | DirectoryServerUserName |
Specifies the user name for authenticating to the directory server. The following are examples of strings
for Active Directory and Oracle Directory Server:
(Inherited from IDirectoryConfiguration.)
| ||||||||||||||||||||||||
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
(Inherited from IDirectoryConfiguration.)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. | ||||||||||||||||||||||||
![]() | GroupBaseDN |
Specifies the base Distinguished Name (DN) for searching for groups in the directory server.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | GroupDisplayNameAttribute |
Specifies the directory server attribute to be used as the display name for a group.
The default property value is dependent on the directory service type and is specified by the
authentication provider's configuration.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | GroupMembershipSearchFilter |
Specifies the search filter or provider-specific attribute for group membership lookups.
When a search filter is specified, Content Platform Engine issues an LDAP query.
For some LDAP providers, you can optionally specify a provider-specific attribute instead of a search filter.
The use of an attribute speeds up initial logins to Content Platform Engine,
especially if the user logging in is a member of many groups.
(Inherited from IDirectoryConfiguration.)The following table shows the default value of this property for each of the supported service providers. Note that you can use a lookup attribute for some providers. If you specify an attribute, make sure to include the angle brackets (<attribute>).
| ||||||||||||||||||||||||
![]() | GroupNameAttribute |
Defines the directory server attribute to be used as the short name for a group.
The default value of this property is samAccountName for the Active Directory service
provider and cn for all other supported directory service providers.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | GroupSearchFilter |
Specifies the search filter for querying a group or groups. The filter must be in the
following format:
"(&(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).
(Inherited from IDirectoryConfiguration.)The default value of this property is unique to the directory service provider, as follows:
| ||||||||||||||||||||||||
![]() | GroupUniqueIDAttribute |
Specifies the directory server attribute to be used as the unique identifier for a group,
that is, for the Content Engine Group.Id property. The default property value
is dependent on the directory server type and is specified by the authentication
provider's configuration. See What are access rights?
for a list of the default SID attributes for the supported authentication providers.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | Id |
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}.
(Inherited from IDirectoryConfiguration.)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:
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. | ||||||||||||||||||||||||
![]() | IsSSLEnabled |
Specifies whether the Secure Sockets Layer (SSL) protocol is enabled (true) or disabled (false) for
communication to the SMTP server.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) | ||||||||||||||||||||||||
![]() | RestrictMembershipToConfiguredRealms |
Restricts a group membership search to within the realms configured in
Administration Console for Content Platform Engine.
(Inherited from IDirectoryConfiguration.)A user can be in a configured realm but belong to a group in an unconfigured realm. By default (that is, when the property value is False), the server automatically searches cross-realm group membership (also called cross-domain group membership in Active Directory). If it reaches a realm that is not configured in Administration Console, the 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 server logs an informational message to the 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). | ||||||||||||||||||||||||
![]() | UserBaseDN |
Specifies the base Distinguished Name (DN) for searching for users in the directory server.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | UserDisplayNameAttribute |
Specifies the directory server attribute to be used as the display name for a user.
The default property value is dependent on the directory server type and is specified by the
authentication provider's configuration.
(Inherited from IDirectoryConfiguration.) | ||||||||||||||||||||||||
![]() | UserNameAttribute |
Defines the directory server attribute to be used as the short name for a user.
The default value of this property is unique to the directory service provider as follows:
(Inherited from IDirectoryConfiguration.)
| ||||||||||||||||||||||||
![]() | UserSearchFilter |
Specifies the search filter for querying a user or users. The filter must be in the
following format:
"(&(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).
(Inherited from IDirectoryConfiguration.)The default value of this property is unique to the directory service provider, as follows:
| ||||||||||||||||||||||||
![]() | UserUniqueIDAttribute |
Specifies the directory server attribute to be used as the unique identifier for a user,
that is, for the Content Engine User.Id property. The default property value
is dependent on the directory server type and is specified by the authentication
provider's configuration. See What are access rights?
for a list of the default SID attributes for the supported authentication providers.
(Inherited from IDirectoryConfiguration.) |