Overriding Driver Parameters

You can override many of the driver configuration parameters using policies.

An example of two overrides is shown in Automatically Determining Which Certifier to Use. In the Cert.xsl sample style sheet, the certifier ID and certifier password are passed as attributes of the <add> XML element. The driver finds those parameters and uses the passed values instead of the default values from the driver parameters. The parameters apply as indicated in the Valid Use column of the following table.

If an attribute overriding a default configuration parameter is present, it will be applied to the note regardless of event type. Because these parameters map to items on a note in Lotus Notes, these overrides are passed as attribute tags of the event element, or <add-value> children of the event element in the XML document.

Another example is in the sample driver configuration, in the style sheet named AddAccountNotesOptions.xml. It utilizes global configuration values (GCVs) specified in NotesConfig2GCV.xml to determine which setting to apply.

Parameter XML Tag Valid Use Description

Certify User Flag

certify-user

As an attribute to an <add> event element

Applying this tag determines the behavior for the driver regarding Notes user account creation. Its value can be Yes or No. Yes indicates the driver will register this user in the Notes Address book by certifying the user (meaning creating an ID file for the user).

Overrides the default Certify Users flag <cert-users> in the driver configuration.

Create Mail File Flag

create-mail

As an attribute to an <add> event element

This tag indicates whether the driver needs to create an e-mail account for this user. Its value can be Yes or No. Yes indicates the driver will attempt to create a Notes Mail database when adding (creating) this new user. Overrides the default Create Mail File flag <create-mail> in the driver configuration.

MailFileTemplate

mailfile-template

As an attribute to an <add> event element

This tag specifies the filename of the .ntf database template to use when creating the user's new mail file for an e-mail account. This template must be accessible to the Domino server in the Domino data folder. Overrides the default Mail File Template <mailfile-template> in the driver configuration.

Database Inheritance for Mail File Template

mail-file-inherit-flag

As an attribute to an <add> event element

This tag specifies whether database structures based on a particular template are updated when that template is updated. Its value can be Yes or No.

The default (the absence of this tag) is Yes, meaning true.

You can override the default and set this tag to No or false if you don't want a change to a mail file template to affect existing database design.

Certifier ID File

cert-id

As an attribute to an <add> event element

This tag specifies the Notes Certifier ID file that is used to register this user object in the Notes Address Book. The full path of the file should be represented with respect to the operating system hosting Domino. Overrides the default Notes Certifier ID file parameter <cert-id-file> in the driver configuration.

Certifier ID File Parameter Reference

drv-param-cert-id

As an attribute to an <add> event element

This tag can be used instead of the Certifier ID file <cert-id> tag. This tag specifies a driver parameter that holds the Notes Certifier ID file that is used to register this user object in the Notes Address Book. The driver parameter tag can have any name, but its value needs to indicate the full path of the certifier ID file with respect to the operating system hosting Domino. Overrides the default Notes Certifier ID file parameter <cert-id-file> in the driver configuration.

Certifier Password

cert-pwd

As an attribute to an <add> event element

This tag specifies the Notes Certifier ID password to be used with the certifier ID file. The password value is passed in clear text. The Notes Certifier ID file and password are used to register user objects in the Notes Address Book. Overrides the default Notes Certifier ID file password parameter <cert-id-password> in the driver configuration.

Certifier Password Parameter Reference

drv-param-cert-pwd

As an attribute to an <add> event element

This tag can be used instead of the Certifier Password <cert-pwd> tag. This tag specifies a driver parameter that holds the Notes Certifier ID password to be used with the certifier ID file that is used to register this user object in the Notes Address Book. The driver parameter tag can have any name, but its value indicates the password of the Certifer ID file. The referenced driver parameter can be a clear-text password or an encrypted named-password. The Notes Certifier ID file and password are used to register user objects in the Notes Address Book. Overrides the default Notes Certifier ID file password parameter <cert-id-password> in the driver configuration

Certifier Password Key Name Reference

named-cert-pwd

As an attribute to an <add> event element

This tag can be used instead of the Certifier Password <cert-pwd> tag. This tag specifies a named-password key name that holds the Notes Certifier ID password to be used with the certifier ID file that is used to register this user object in the Notes Address Book. The Notes Certifier ID file and password are used to register user objects in the Notes Address Book. Overrides the default Notes Certifier ID file password parameter <cert-id-password> in the driver configuration.

ID File Name

user-id-file

As an attribute to an <add> event element

This tag specifies the filename to be used for the user's ID file. The filename does not include the file path. When this tag is absent, a default filename is generated by the Notes driver using the first and last name attributes of the user (FirstNameLastName.id).

ID File Path

user-id-path

As an attribute to an <add> event element

This tag specifies the file path to the Notes User ID file storage location to be used when creating the user's ID file. The new ID file will be placed in this location. The full path of the folder should be represented with respect to the operating system hosting Domino. Overrides the default Notes User ID certificate location parameter <cert-path> in the driver configuration.

Notes Minimum Password Length

minimum-pwd-len

As an attribute to an <add> event element

This tag specifies a minimum password length to apply to the User ID file of newly registered users. Value can be 0 - 16. Overrides the default Notes User ID minimum password length parameter <minimum-pwd-len> in the driver configuration.

Notes Password

user-pwd

As an attribute to an <add> event element

The user's Notes password used to create the user's ID file (certifier). Overrides the default Notes Password parameter <default-password> in the driver configuration.

Extended OU

extended-ou

As an attribute to an <add> event element

The value of the tag is appended to the generated DN based on the selected certifier when registering a user.

MailFile ACL control

mailfile-acl-level

As an attribute to an <add> event element

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. Values can be specified either as the Java ACL constant or the role name1. This attribute should be added in the same rule where the certification attributes are calculated and set and it should be added using the same XSL constructs. Overrides the default Mail File ACL Level parameter <mailfile-acl-level> in the driver configuration.

Mail File Size Quota

mail-file-quota

As an attribute to an <add> event element

This tag specifies the value of the mail file quota (size in MegaBytes), that is applied to the e-mail database file when it is created.

Extended OU

extended-ou

As an attribute to an <add> event element

The value of the tag is appended to the generated DN based on the selected certifier when registering a user.

MailFile ACL control

mailfile-acl-level

As an attribute to an <add> event element

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. Values can be specified either as the Java ACL constant or the role name1. This attribute should be added in the same rule where the certification attributes are calculated and set and it should be added using the same XSL constructs. Overrides the default Mail File ACL Level parameter <mailfile-acl-level> in the driver configuration.

Mail File Size Quota

mail-file-quota

As an attribute to an <add> event element

This tag specifies the value of the mail file quota (size in KB) that is applied to the e-mail database file when it is created.

Store User ID File In Notes Address Book

store-useridfile-in-ab

As an attribute to an <add> event element

This tag specifies if the driver attaches the user ID file for this user onto its user object in the Notes Address Book at registration time. Setting the tag to Yes causes this registered user object in the Notes Address Book to be created with an attached user ID file. Setting the tag to No causes this registered user object in the Notes Address Book to be created without an attached user ID file. Overrides the default Store UserID in Address Book parameter <store-id-ab-flag> in the driver configuration.

Registered Users in Notes Address Book

update-addressbook

As an attribute to an <add> event element

This tag specifies if the driver puts registered user objects in the Notes Address Book. Setting the tag to Yes causes registered users to be placed in the address book. Setting the tag to No will cause users to be registered (that is, a certifier ID file is created for the user) without the user object being placed into the Notes Address Book.

Overrides the default Update Address Book parameter <update-ab-flag> in the driver configuration.

User ID file Expiration Term

expire-term

As an attribute to an <add> event element

This tag specifies the expiration term (specified in years) for the Notes User ID file of this user. Overrides the default Expiration Term parameter <expiration-term> in the driver configuration.

User ID file certifier type

cert-id-type

As an attribute to an <add> event element

This tag specifies the User ID file certifier type when user ID files are created at user registration time. Valid values are ID_FLAT, ID_HIERARCHICAL, and ID_CERTIFIER. The absence of this tag sets the default certifier type of ID_HIERARCHICAL.

Group Membership Removal

remove-all-group-membership

As an attribute to a <modify> or <delete> event element.

This tag indicates that this user object should be removed from the membership list of all groups in the Notes database, except for groups of type "Deny List" (GroupType=3). Valid values are Yes and No. The absence of this tag defaults to No This tag only applies to person (user) objects in the Notes Address Book.

MailServer

MailServer

As an <add-value> child element of an <add> event.

This element specifies the name of the Notes Server where the mail file should be created when creating an e-mail account (mail database file).

MailFile

MailFile

As an <add-value> child element of an <add> event.

This element specifies the filename to be used when creating the user's e-mail database file. The filename does not include the file path. When this tag is absent, a default filename is generated by the Notes driver using the first and last name attributes of the user (FirstNameLastName.nsf).

MailDomain

MailDomain

As an <add-value> child element of an <add> event.

This element specifies the name of the Notes Mail Domain when creating an e-mail database file.

Alternate Full Name

AltFullName

As an <add-value> child element of an <add> event.

This element specifies the Alternate Full Name, an attribute in Notes, when registering a new user. Like other user attributes, this can be synchronized using an attribute in eDirectory or inserted in a style sheet. See the Lotus Notes documentation for information on setting AltFullName for a user.

Language of Alternate Full Name

AltFullNameLanguage

As an <add-value> child element of an <add> event.

This element specifies the language used for the Alternate Full Name when registering a new user. Like other user attributes, this can be synchronized using an attribute in eDirectory or inserted in a style sheet. See the Lotus Notes documentation for information on setting AltFullNameLanguage for a user.

InternetAddress

InternetAddress

As an <add-value> child element of an <add> event.

This element specifies the user's Internet e-mail address in the Notes Address Book.

Notes HTTP Password

HTTPPassword

As an <add-value> child element of an <add> or <modify> event.

This element specifies the user's Web (HTTP) password for Notes. This setting is ignored if the Allow HTTP Password Set parameter <allow-http-password-set> is set to No (or false)

1 ACL Description

Notes Java ACL Constant

NOACCESS
DEPOSITOR
READER
AUTHOR
EDITOR
DESIGNER
MANAGER

ACL.LEVEL_NOACCESS
ACL.LEVEL_DEPOSITOR
ACL.LEVEL_READER
ACL.LEVEL_AUTHOR
ACL.LEVEL_EDITOR
ACL.LEVEL_DESIGNER
ACL.LEVEL_MANAGER