CIC LDAP Contacts

You can add configuration information to extend the settings of an LDAP contact. In the Additional Information box, use the following syntax:

<Attribute>=<Value>[;<Attribute>=Value…]

Where:

Syntax	Description
Attribute	Uppercase or lowercase letters are allowed. Case is not preserved.
Value	Uppercase or lowercase letters are allowed. Case is preserved.
=	Blank spaces around equal sign (=) are allowed. When Value contains one or more equal signs (=), then Value must be enclosed by double quotation marks.
;	Blank spaces around semi-colon (;) are allowed. When Value contains one or more semi-colons (;), then Value must be enclosed by double quotation marks.

Additional Information attributes:

Search_DN=

Use to override the search DN specified in the Interaction Administrator CIC Data Source configuration. In LDAP, a search involves three parameters:

Parameter	Description
SEARCH_DN=	A place (node) in the directory tree to start searching from.
SEARCH_FILTER=	A filter/query to be applied to the contact entries.
SEARCH_SCOPE=	A specification for how/if the search is to proceed down the tree.

Tip: When specifying the search DN, enclose the string in double quotation marks (" "), since the standard DN format contains equal signs ( = ).

You can use one or more user substitution variables inside the DN; this is particularly useful when setting up private contacts (see USERNAME_MAPPING_FILE= below).

In addition, you can use one or more built-in substitution variables. They are:

Variables	Description
$ICUID	The CIC user ID. Generally only useful for private contact sources.
$CONTACTSOURCE	The name of the contact list source used by the Data Manager. For example: Our Public Contacts.
$BINDDN	The DN used to bind with, as specified in the Interaction Administrator CIC Data Source configuration.

Note: The above variables must be all uppercase letters.

SEARCH_FILTER=

Contains, in LDAP search syntax, the search filter/query to be used.

For example: (&(objectclass=i3person)(i3owner=$ICUID))

You can use one or more user substitution variables inside the DN; this is useful when setting up private contacts (see the section on USERNAME_MAPPING_FILE= below).

In addition, you can use one or more built-in substitution variables. They are:

Variables	Description
$ICUID	The CIC user ID. Generally only useful for private contact sources.
$CONTACTSOURCE	The name of the contact list source used by Data Manager. For example: Our Public Contacts.
$BINDDN	The DN used to bind with, as specified in the Interaction Administrator CIC Data Source configuration.
$SEARCDN	The search DN as specified in the Interaction Administrator CIC Data Source configuration (SEARCH DN field), or as overridden in the contact list source.
$SEARCHDNPARENT	The parent DN of the configured search DN.

Note: These variables must be all uppercase letters.

SEARCH_SCOPE=

Specifies how/if the search proceeds down the sub-tree rooted by the search DN. This attribute can have one of three values:

Values	Description
ONE	Searches only entries directly below the search DN. This is the default.
SUB	Starts the search at the base DN and then searches everything below, including the base DN.
BASE	Searches only the base DN entry.

ATTRIBUTE_MAPPING_FILE=

By default, CIC uses an object class called i3person (which inherits from inetorgperson) for storing contact information. However, you are free to choose whatever object class you like, including a custom object class. To do this, you must create a file that contains the mappings between the CIC attributes and the attributes of your object class. CIC provides two sample mapping files, I3PERSON_MAP.TXT and INETORPERSON_MAP.TXT, that contain syntax and usage documentation in the files themselves.

Note: I3PERSON_MAP.TXT is provided for informational purposes, and – unless you want to modify any of the defaults – you do not need to have an ATTRUBUTE_MAPPING_FILE= entry, since CIC knows about the mapping for the i3person object class.

USES_FOLDERS=

The default is True. Set to False if the contact entries are not rooted by a folder/container entry that you want CIC to create. CIC has a default folder object class called i3genfolder that you can use.

FOLDER_ATTRIBUTE_FILE=

You can use your own folder type (such as a folder other than i3genfolder) and still have CIC automatically create the folders to contain your contacts. To do this you must create a file that contains information about the attributes of the folder object class you wish to use. An example file I3GENFOLDER_MAP.TXT is provided whose syntax and usage is the same as the attribute mapping file and is documented in comments inside the file itself.

Note: CIC knows about the mappings for i3genfolder, so unless you need to modify the defaults, you don’t need to have a FOLDER_ATTRIBUTE_FILE= entry if you plan on using the default i3genfolder object class.

RDN_ATTRIBUTE=

Each newly created contact must have a globally unique distinguished name (DN). The left-most component of a distinguished name is called a relative distinguished name (RDN), and contains the attribute-value pair that uniquely defines the contact entry within the current directory. By default, Data Manager will use the userid attribute as the attribute for the RDN. However, you can choose whatever attribute you want by setting this attribute.

Note:  Even though you can specify any attribute as an RDN attribute, Data Manager will always set it to a unique timestamp value (for example "200009231456450001000"). Therefore, when choosing an RDN attribute, make sure the semantics of the attribute are such that a unique timestamp value like this will not cause any problems.

USERNAME_MAPPING_FILE=

When accessing private contacts, the only information CIC has when distinguishing one user’s contact data from another user’s contact data is the CIC user ID value. These values might or might not be the same as the LDAP user ID attribute’s values.

If they are not the same, you can set up a file to specify the mapping from the CIC user ID to the LDAP user ID. In fact, you can do this even if they are the same in order to specify other substitution values for a user.

The ICUSER_MAP.TXT example mapping file provides syntax and usage documentation.

Tip: For additional information about how CIC supports LDAP-enabled Netscape directory servers, see Using LDAP for CIC Contact Lists located in the PureConnect Documentation Library.