Using Driver Parameters

To change driver parameters, edit the Driver Parameters page.

  1. In iManager, click DirXML Management > Overview.

  2. Find the driver in its driver set.

  3. Click the driver icon to display the Driver Overview page.

  4. Click the driver icon again to display the Modify Object page.

  5. Click Driver Configuration.

  6. Use the information in the tables that follow to upgrade driver parameters.

In this section:


Driver Options

The third column of the following table contains XML text that you should paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.

Parameter Description XML to Define Driver Parameters

Certifier ID file

The default Notes Certifier ID file that is used to register user objects in the Notes Address Book. The full path of the file should be represented with respect to the operating system hosting Domino.

<cert-id-file display-name="Certifier ID File">/local/notesdata/cert.id</cert-id-file>

Certifier ID password

The default Notes Certifier ID file password that is used to register user objects in the Notes Address Book.

When using the type="password-ref" attribute of this parameter, the password is encrypted and securely stored with the Driver Configuration. When securely stored in this fashion, the password can then be referenced by the DirXML engine or a driver using the key name specified. (In this example, defaultCertPwd.)

<cert-id-password display-name="Certifier Password" is-sensitive="true" type="password-ref">defaultCertPwd</cert-id-password>

Directory File or Input Database

The file name of the database to be synchronized with eDirectory. Specify this item without full path information.

<directory-file display-name="Directory File">names.nsf</directory-file>

Notes Address Book

Specify Yes if the input database (directory file) is a Notes Address book; otherwise, specify No.

<is-directory display-name="Notes Address Book? (Yes/No)">Yes</is-directory>

Notes Domain Name

The name of the Notes domain the driver is running against. It might be different from the Notes Organization name, and therefore can't be derived from the server name.

<notes-domain display-name="Notes Domain Name">Provo</notes-domain>

Server ID File

The Notes Server ID file associated with the Notes Server this driver authenticates to (This is optional). The full path of the file should be represented with respect to the operating system hosting Domino. This ID file need not be the server ID file. It can actually be an ID file that has no password (and need not have any access anywhere).

<server-id-file display-name="Server ID File">/local/notesdata/server.id</server-id-file>

Update File of Output Database or ndsrep polling cache

The filename of the database used to cache database changes that need to be published to eDirectory. The default is ndsrep.nsf. Specify this item without full path information.

The Driver's Domino add-in process ndsrep creates this database. Within this database, filtered updates are cached before being consumed by the Notes Driver's publisher.

<update-file display-name="Update File">ndsrep.nsf</update-file>

User ID file

The Notes User ID file associated with the Notes User this driver represents (this is required). The full path of the file should be represented with respect to the operating system hosting Domino. The password associated with this user ID file is input in the following user interface section: Driver Configuration > Authentication > Specify the application password

<user-id-file display-name="User ID File">/local/notesdata/notedrv.id</user-id-file>

Subscriber Options

The third column of the following table contains XML text that you should paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.

Parameter Description XML to Define Driver Parameters

Allow Domino AdminP Support

Specifies that AdminP features can be used. AdminP features are supported only for users of Lotus Notes 6.0.3 or later.

If you have Lotus Notes 6.0.3 or later and you want to use the AdminP features, you must add this parameter and set it to Yes.

If the parameter does not exist in the driver parameters, the default setting is No.

This parameter can be overridden on a command-by-command basis using the attribute Allow AdminP Support described in Overriding Driver Parameters.

<allow-adminp-support display-name="Allow Domino AdminP Support">Yes</allow-adminp-support>

Certify/Register Users

This parameter indicates the default behavior for the driver regarding Notes user account creation. Yes indicates the driver by default attempts to register users in the Notes Address book by certifying them and creating an ID file for each user when add events are received.

This default setting can be overridden using the XML <certify-user> attribute tag.

<cert-users display-name="Certify Users? (Yes/No)">Yes</cert-users>

Create Mail DB

This parameter indicates the default behavior for the driver regarding e-mail account creation. Yes indicates the driver by default attempts to create a Notes Mail database when adding a new user.

This default setting can be overridden using the XML attribute tag <create-mail>.

<create-mail display-name="Create Mail DB? (Yes/No)">Yes</create-mail>

Default HTTP Password

The default Notes Web (HTTP) password set for newly created Notes users.

This default setting can be overridden using the XML attribute tag <user-pwd>.

<default-http-password display-name="Default HTTP Password">notesweb</default-http-password>

Default Notes Password

The default Notes User ID password for newly created Notes users.

This default setting can be overridden using the XML attribute tag <user-pwd>.

<default-password display-name="Default Notes Password">notes</default-password>

Expiration Term

The default expiration term (specified in years) for newly created Notes User ID files.

This default setting can be overridden using the XML attribute tag <expire-term>.

<expiration-term display-name="Expiration Term in Years">2</expiration-term>

Failed Command Reply Status

If the parameter does not exist in the driver parameters, the default setting is Retry.

Possible values are Success, Warning, Error, Retry, or Fatal.

This parameter can be used when troubleshooting critical situations.

<retry-status-return display-name="Failed Command Reply Status">Retry</retry-status-return>

ID File Storage Location

This parameter specifies the default Notes User ID file (certifier) storage location that is used when user objects are registered and ID files are created. New ID files are placed in this location. The full path of the folder should be represented in relationship to the operating system hosting Domino.

This default setting can be overridden using the XML attribute tag <user-id-path>.

<cert-path display-name="ID File Storage Location" >c:\lotus\domino\data\ids\people</cert-path>

Internet Mail Domain Name

Obsolete in version 2.0.

<internet-mail-domain display-name="Internet Mail Domain Name">mycompany.com</internet-mail-domain>

Mail File ACL Level

The default ACL setting for the newly created mail file of newly created user objects. Valid values are NOACCESS, DEPOSITOR, READER, AUTHOR, EDITOR, DESIGNER, and MANAGER. When no ACL setting is specified, the setting defaults to MANAGER.

This default setting can be overridden using the XML attribute tag <mailfile-acl-level>.

<mailfile-acl-level display-name="Mail File ACL Level">MANAGER</mailfile-acl-level>

Mail File Storage Location

A mail storage path relative to the Domino data storage location where mail files are stored if created by the driver. For example, if the parameter is set to "mail," then new mail files created by the driver on the Domino server (running on Linux) are stored in the /local/notesdata/mail folder.

<mailfile-path display-name="Mail File Storage Location">mail</mailfile-path>

Minimum Notes Password Length

The default minimum password length (0-16 characters) for newly created Notes User ID files.

This default setting can be overridden using the XML attribute tag <minimum-pwd-len>.

<minimum-pwd-len display-name="Minimum Notes Password Length (0 - 16)">5</minimum-pwd-len>

North American Server

North American Server User ID file (certifier) property. Set to Yes only if the Domino Server is in North America. According to Domino registration requirements, this attribute is required for user ID file creation.

<north-american-flag display-name="Is North American Server?">Yes</north-american-flag>

Notes Mail Server Name

The DN of the Notes Server that holds the mail files.

This default setting can be overridden using the XML <mailserver> element as a child of the add event element.

<mail-server display-name="Notes Mail Server Name">cn=Server1/o=Org</mail-server>

Notes Save Failed Reply Status

If the parameter does not exist in the driver parameters, the default setting is Retry.

Possible values are Success, Warning, Error, Retry, or Fatal.

This parameter can be used when troubleshooting.

<notes-save-fail-action display-name="Notes Save Failed Reply Status">Retry</notes-save-fail-action>

Notes Web (HTTP) Password Set

Set the parameter to Yes to allow the Notes driver to set or to change the Web (HTTP) password attribute on user objects. Set the parameter to No to disallow the Notes driver from setting or changing the web (HTTP) password attribute on user objects.

The default is Yes.

<allow-http-password-set display-name="Allow Notes Web (HTTP) password to be set">Yes</allow-http-password-set>

Registration Log File

The Notes Certification log file that is used to record the registration of user objects in the Notes Address Book. Specify this item without full path information.

<cert-log display-name="Registration Log File">certlog.nsf</cert-log>

Store ID in Notes Address Book

This flag indicates the default behavior for the driver regarding attaching user ID files on their respective user objects in the Notes Address Book at registration time.

Setting the flag to Yes causes registered user objects in the Notes Address Book to be created with an attached user ID file.

Setting the flag to No causes registered user objects in the Notes Address Book to be created without an attached user ID file.

This default setting can be overridden using the XML attribute tag <store-useridfile-in-ab>.

<store-id-ab-flag display-name="Store ID in Notes Address Book? (Yes/No)">Yes</store-id-ab-flag>

Template for mail file creation

The .ntf database template to be used when creating a new mail database when the driver creates a user e-mail account. This template must be accessible to the Domino server in the Domino data folder.

<mailfile-template display-name="Template for Mail File creation">mail6.ntf</mailfile-template>

Update Address Book

This parameter indicates the default behavior for the driver regarding placing registered user objects in the Notes Address Book. Setting the flag to Yes causes registered users to be placed in the address book. Setting the flag to No causes users to be registered (meaning that a certifier ID file is created for the user) without the user object being placed into the Notes Address Book.

This default setting can be overridden using the XML attribute tag <update-addressbook>.

<update-ab-flag display-name="Update Address Book? (Yes/No)">Yes</update-ab-flag>

Publisher Options

The third column of the following table contains XML text that you should paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.

Parameter Description XML to Define Driver Parameters

Check Attributes

The ndsrep check and publish attributes parameter. Set to Yes if only modified attributes within the Publisher filter should be sent to eDirectory via the Publisher channel when a Notes object is modified. Set to No if all sync attributes specified within the Publisher filter should be sent to eDirectory via the Publisher channel when a Notes object is modified.

The default value is Yes.

<check-attrs-flag display-name="Check Attributes?">Yes</check-attrs-flag>

DNFormat

The Distinguished Name format used by ndsrep. Valid values are SLASH, LDAP, and LDAP_TYPED. The default is SLASH.

<dn-format display-name="DNFormat">SLASH</dn-format>

Enable Loop Back Detection

Loopback detection parameter. Set to Yes to enable loopback detection. Set to No to disable loopback detection.

<loop-detect-flag display-name="Enable Loop Back Detection">Yes</loop-detect-flag>

Loop Back Detection User Name

Loopback detection Notes user name. By default (if this parameter is not present), the Authentication ID contained within Driver Configuration is used as the Loop Back Detection User Name. (This is standard loopback detection functionality). This parameter allows for setting the loopback detection user name to a different value.

<loop-detect-id display-name="Loop Back Detection User Name">CN=Notes Driver/O=ACME</loop-detect-id>

NDSREP Configuration Auto-refresh

The ndsrep Configuration Auto-refresh setting. Valid settings are Yes and No.

Set to Yes to have ndsrep automatically detect changes to the publisher configuration parameters.

Set to No to have ndsrep ignore changes to the publisher configuration until it is restarted or manually prompted to refresh the configuration.

If this parameter is not present, by default auto-refresh is set to Yes.

<auto-refresh-flag display-name="NDSREP Configuration Auto-refresh">No</auto-refresh-flag>

NDSREP Configuration database

The ndsrep configuration database filename created and maintained by the driver. This parameter controls which .nsf database the driver shim uses to write its publication options.

The full path of the filename should be represented with respect to the operating system hosting Domino. When using this parameter, ndsrep needs to be loaded with the "-f filename" parameter.

ndsrep load example:

load ndsrep NotesDriver2 -f /home/notes/mycfg.nsf

If this parameter is not present, by default the Configuration database filename is set to dsrepcfg.nsf and is normally located in the Domino data folder.

If the name of your driver includes spaces, then you must put quotes around the name.

<config-db-name display-name="NDSREP Configuration database">/home/notes/mycfg.nsf</config-db-name>

NDSREP Configuration Instance

The ndsrep configuration instance name created and maintained by the driver within the ndsrep configuration database. This parameter controls which database note the driver shim uses to read and write its publication options within the ndsrep configuration database. When using this parameter, ndsrep utilizes the settings of this configuration instance when loaded with this instance name as a parameter.

If this parameter is not present, by default the configuration instance is set to the name of the driver (the driver RDN in eDir).

ndsrep load example:

load ndsrep NotesDriver2

If the name of your driver includes spaces, then you must put quotes around the name.

<instance-id display-name="NDSREP Configuration Instance">NotesDriver2</instance-id>

NDSREP Console Trace Level

Possible values are Silent, Normal, Verbose, or Debug.

If this parameter is not present, the default setting is Normal.

<ndsrep-console-trace-level display-name="NDSREP Console Trace Level">Normal</ndsrep-console-trace-level>

NDSREP Schedule Units

The ndsrep polling interval unit. Valid values are SECONDS, MINUTES, HOURS, and DAYS. The default value is SECONDS.

<schedule-units display-name="NDSREP Schedule Units">SECONDS</schedule-units>

NDSREP Schedule Value

The ndsrep polling interval unit value. This value is utilized in conjunction with the <schedule-units> configuration parameter.

<schedule-value display-name="NDSREP Schedule Value">30</schedule-value>

Polling Interval

Notes Driver Shim publisher polling interval, specified in seconds.

<polling-interval display-name="Polling Interval (in seconds)">30</polling-interval>

Publication Heartbeat Interval (in seconds)

Publication Heartbeat Interval specified in seconds. This parameter can be used instead of <pub-heartbeat-interval> to provide finer interval size granularity. If no documents are sent on the Publisher channel for this specified interval (duration of time), then a heartbeat document is sent by the driver. A value of 0 indicates that no heartbeat documents are to be sent.

If this parameter is not present, by default the publication heartbeat interval is 0.

<pub-heartbeat-interval-seconds display-name="Publication Heartbeat Interval (in seconds)">30</pub-heartbeat-interval-seconds>

Publication Heartbeat Interval

Publication Heartbeat Interval specified in minutes. If no documents are sent on the Publisher channel for this specified interval (duration of time), then a heartbeat document is sent by the driver. A value of 0 indicates that no heartbeat documents are to be sent.

If this parameter is not present, by default the publication heartbeat interval is 0.

<pub-heartbeat-interval display-name="Publication Heartbeat Interval (in minutes)">10</pub-heartbeat-interval>

Write Time Stamps

Whether ndsrep writes special driver time stamp on synchronized Notes parameter. Set to Yes to have ndsrep write a driver specific time stamp on all Notes objects that are synchronized. This special driver time stamp is used to more accurately determine Notes object attribute updates.Set to No to have ndsrep determine Notes object attribute updates based on existing Notes object time stamps.

The default value is No.

<write-timestamps-flag display-name="Write Time Stamps?">No</write-timestamps-flag>