4.5 Custom Driver Parameters

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

An example of two overrides is shown in Section 4.2, 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 is 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-attr> 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.

For items that use Yes or No values, True or False values can also be used.

The Notes Driver 2.2 can add or modify ACLEntries on the ACL record of a Lotus Notes database ( .nsf) that is being synchronized (Subscriber channel only). Likewise, the ACL of a new mail file that the NotesDriverShim creates for a user can be modified with specific settings at creation time. These parameters are also included in the following table.

The Notes Driver 2.1.2 and above can apply database replication settings and replication entry settings. The driver can create a database replica, as well as request to perform replication, which can also create a mailfile replica when a mailfile is initially created.

This enhancement also allows for modifying replication settings of the existing database that is being synchronized, to perform a replication request on the synchronized database, and to create a new replica on an accessible Domino server.

The following table lists the XML tags that can be added as siblings to the add or modify command element in an XDS document that is submitted to the NotesDriverShim to appropriately configure a database’s replication options. XML tags used for mailfile replication settings (prefixed with mailfile-) can only be used within add command elements. These attributes are divided into Rep and MailFile Rep attributes in this table.

Table 4-4 Custom Parameters That Override Driver, Subscriber, and Publisher Parameters

Parameter

XML Tag

Valid Use and Value

Description

ACL Administration Server

acl-administration-server

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished Notes object name (i.e. “CN=Server1/O=myOrg”)

The name of the Administration Server that can perform maintenance on this database. This value must be a Notes Distinguished Name of a valid Domino Administration Server. Only available on Domino 6.0.3 or higher.

ACL Admin Name Modifier

acl-admin-names

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

The ACL isAdminNames property indicates whether the administration server can modify the names fields in this database. Only available on Domino 6.0.3 or higher.

ACL Admin Reader-Author Modifier

acl-admin-reader-author

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

The ACL isAdminReaderAuthor property indicates whether the administration server can modify the Readers and Authors fields in this database. This is only available on Domino 6.0.3 or higher.

ACL Admin Reader-Author

acl-entry-admin-reader-author

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the admin-reader-author attribute is set.

ACL Admin Server

acl-entry-admin-server

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the admin-server attribute is set. If set to true, this setting overrides the ACL Administration Server property and places this entry's name in the ACLs Administration Server property. See acl-administration-server.

ACL Create Personal Folder

acl-entry-can-create-personal-folder

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-create-personal-folder attribute is set.

ACL Create Shared Folder

acl-entry-can-create-shared-folder

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-create-shared-folder attribute is set.

ACL Create Documents

acl-entry-can-create-documents

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-create-documents attribute is set.

ACL Create LS Or Java Agent

acl-entry-can-create-ls-or-java-agent

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-create-LS-or-Java attribute is set.

ACL Create Personal Agent

acl-entry-can-create-personal-agent

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-create-personal-agent attribute is set.

ACL Replicate Or Copy Documents

acl-entry-can-replicate-or-copy-documents

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-replicate-or-copy-documents attribute is set. Only available on Domino 6.0.3 or higher.

ACL Delete Documents

acl-entry-can-delete-documents

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the can-delete-documents is set.

ACL Entry Level

acl-entry-level

As an attribute to an < add>, < modify>, or < delete> command element.

String or Integer

Indicates the ACLEntry level. Valid strings include:

MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS

ACL Entry Name

acl-entry-name

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished Notes object name (i.e. “CN=John Doe/OU=myOrgUnit/O=myOrg”)

The name of the ACLEntry. If not present, this value defaults to the Notes Distinguished Name (FullName) of the current object being synchronized.

ACL Entry Remove

acl-entry-remove

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the ACLEntry is to be removed from the ACL record of the database.

ACL Extended Access

acl-extended-access

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

The ACL isExtendedAccess property indicates whether extended access is enabled for this database. Only available on Domino 6.0.3 or higher.

ACL Internet Level

acl-internet-level

As an attribute to an < add>, < modify>, or < delete> command element.

String or Integer

The maximum internet access level for this database. Valid strings include:

MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS

ACL Public Reader

acl-entry-public-reader

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the public-reader attribute is set

ACL Public Writer

acl-entry-public-writer

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the public writer attribute is set.

ACL Server

acl-entry-server

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Indicates if the ACLEntry server attribute is set.

ACL Uniform Access

acl-uniform-access

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

The ACL isUniformAccess property indicates whether a consistent ACL is enforced across all replicas of this database.

ACL User Type

acl-entry-user-type

As an attribute to an < add>, < modify>, or < delete> command element.

String or Integer

Indicates the ACLEntry user type. Valid strings include:

MIXED_GROUP PERSON PERSON_GROUP SERVER SERVER_GROUP UNSPECIFIED

ACL Enable Role

acl-entry-enable-role

As an attribute to an < add>, < modify>, or < delete> command element.

String

Specifies the roles to set on the ACL.

ACL Disable Role

acl-entry-disable-role

As an attribute to an < add>, < modify>, or < delete> command element.

String

Specifies the roles to set on the ACL.

Administration Process Server

adminp-server

As an attribute to an < add>, < modify>, < move>, < delete>, or < domino-console-command> event element.

String

Specifies the Domino server with which to establish an administration process session; or, specifies the Domino server where a console command should be sent. The default is the local server specified in the driver parameters. Example: adminp-server=“myserver1/acme”. Requires Notes 6.0.3 or later.

Allow AdminP Support

allow-adminp-support

As an attribute to an < add>, < modify>, < move>, < rename>, or < delete> event element.

Boolean: true | false

Specifies whether the command received by the Notes driver shim should allow issuing AdminP requests if possible. The attribute can be True or False. The default is False if not set with the <allow-adminp-support> driver parameter in the subscriber-options section. This attribute can be used to override Allow Domino AdminP Support in Section 4.4.2, Subscriber Options, on a command-by-command basis. Example: allow-adminp-support=“True”. Requires Notes 6.0.3 or later.

Alternate Full Name

AltFullName

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

String

This element specifies the Alternate Full Name 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.

Alternate Organization Unit

alt-org-unit

As an attribute to an < add> event element.

String

Specifies the alternate Organization Unit when registering a new user in Notes.

Alternate Organization Unit Language

alt-org-unit-lang

As an attribute to an < add> event element.

String

Specifies the alternate Organization Unit language when registering a new user in Notes.

Certification Expiration Date

cert-expire-date

As an attribute to an < add>, < modify, or < move> event element.

String

Specifies the date when a user certifier expires. This attribute can be applied to override the default expiration term specified in the driver parameters. It is used by the Notes Driver shim when processing events that result in AdminP requests that cause the recertification of the user, such as move, rename, or recertify, or on add event when creating new Notes users. The date format should be specified in text using the appropriate format of the locale of the Domino Server. For example, in English, cert-expire-date=“1 July 2010”. An alternate to this attribute is expire-term.

Certifier ID File

cert-id

As an attribute to an < add> event element

String

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

String

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 Name

certifier-name

As an attribute to a < move> event element.

String

Specifies the certifier name required to move a user in Notes from an old certifier to a new certifier. The value is the name of the new certifier where the user is moving to. This attribute should be used in conjunction with old-cert-id or one of its alternates, old-cert-pwd or one of its alternates, cert-id or one of its alternates, and cert-pwd or one of its alternates. The cert-id specified should belong to the certifier-name. Example: certifier-name=“/mktg/acme”. Requires Notes 6.0.3 or later.

Certifier Password

cert-pwd

As an attribute to an < add> event element.

String

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. Alternates are < named-cert-pwd> and < drv-param-cert-pwd>.

Certifier Password Key Name Reference

named-cert-pwd

As an attribute to an < add> event element.

String

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. Alternates are < cert-pwd> and < drv-param-cert-pwd>.

Certifier Password Parameter Reference

drv-param-cert-pwd

As an attribute to an < add> event element.

String

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. Alternates are < cert-pwd> and < named-cert-pwd>.

Certify User Flag

certify-user

As an attribute to an < add> event element.

String

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 it creates 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.

Boolean: true | false

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.

Database Inheritance for Mail File Template

mail-file-inherit-flag

As an attribute to an < add> event element.

Boolean: true | false

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.

Delete Windows Group

delete-windows-group

As an attribute to a < delete class=“group”> event element.

Boolean: true | false

Specifies whether synchronized Windows groups should be deleted from Windows or not. The value is True or False. Domino has its own capability of synchronizing users and groups with Windows systems. When the Notes Driver shim utilizes AdminP to delete a group, the request can also indicate that this deletion should be synchronized with Windows. By default this attribute is set to False. Example: delete-windows-group=“True”. Requires Notes 6.0.3 or later.

Delete Windows User

delete-windows-user

As an attribute to a < delete class=“user”> event element.

Boolean: true | false

Specifies whether synchronized Windows users should be deleted from Windows or not. The value is True or False. Domino has its own capability of synchronizing users and groups with Windows systems. When the Notes Driver shim utilizes AdminP to delete a user, the request can also indicate that this deletion should be synchronized with Windows. By default this attribute is set to False. Example: delete-windows-user=“True”. Requires Notes 6.0.3 or later.

Deny Access Group ID

deny-access-group-id

As an attribute to a < delete> event element.

String

Specifies the Notes deny access group UNID for a delete event. When the Notes Driver shim utilizes AdminP to delete users from Notes, it has the capability to attach a deny access group name to that AdminP delete user request, so the deleted user's name is inserted as a member of the specified deny access group. An alternate attribute is deny-access-group-name. Example: deny-access-group-id=“ 7EFB951A3574521F87256E540001F140”. Requires Notes 6.0.3 or later.

Deny Access Group Name

deny-access-group-name

As an attribute to a < delete> event element.

String

Specifies the Notes deny access group name for a delete event. When the Notes Driver shim utilizes AdminP to delete users from Notes, it has the capability to attach a deny access group name to that AdminP delete user request, so the deleted user's name is inserted as a member of the specified deny access group. An alternate attribute is deny-access-group-id. Example: deny-access-group-name=“Deny Access”. Requires Notes 6.0.3 or later.

Domino Console Command

tell-adminp-process

As an attribute to an < add>, < modify>, < move>, < delete> event element.

String

Specifies the Domino console command to perform after an AdminP request has been performed by the Notes driver shim. For Domino console commands to succeed, the Notes Driver user must have appropriate Domino Console privileges granted. Example: tell-adminp-process=“tell adminp process new”. Requires Notes 6.0.3 or later.

See the instructions in Section 4.10, Tell AdminP Commands.

Driver Parameter Old Certifier ID

drv-param-old-cert-id

As an attribute to a < move> event element.

String

Specifies the driver parameter holding the old certifier ID file name required to move a user in Notes from an old certifier to a new certifier. The value is the driver parameter tag. An alternate to this attribute is old-cert-id. This attribute should be used in conjunction with certifier-name, old-cert-pwd or one of its alternates, cert-id or its alternate, and cert-pwd or one of its alternates. Example: drv-param-old-cert-id=“mktg-cert-id-file”. Requires Notes 6.0.3 or later.

Driver Parameter Old Certifier Password

drv-param-old-cert-pwd

As an attribute to a < move> event element.

String

Specifies the driver parameter holding the password for the old certifier ID file required to move a user in Notes from an old certifier to a new certifier. The value is the driver parameter tag. An alternate to this attribute is named-old-cert-pwd or old-cert-pwd. This attribute should be used in conjunction with certifier-name, old-cert-id or one of its alternates, cert-id or one of its alternates, and cert-pwd or one of its alternates. Example: drv-param-old-cert-pwd=“mktg-cert-id-password”. Requires Notes 6.0.3 or later.

Enforce Unique Short Name

enforce-unique-short-name

As an attribute to an < add> event element.

String

Specifies whether to enforce uniqueness of short names when registering a new user in Notes. The value is True or False. The default is False. If specified as True, and the Notes user registration process determines that the short name for the new user already exists, then the new user information is overlaid onto the existing Notes user of the same short name, thereby preventing the existence of a duplicate short name. Example: enforce-unique-short-name=“True”. Requires Notes 6.0.3 or later.

Extended OU

extended-ou

As an attribute to an < add> or < modify> event element.

String

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

Group Membership Removal

remove-all-group-membership

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

Boolean: true | false

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.

ID File Name

user-id-file

As an attribute to an < add> event element.

String

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 by 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.

String

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 is 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.

Immediate

immediate

As an attribute to a < delete> event element.

Boolean: true | false

Specifies whether a delete event performed by AdminP immediately deletes a user from the Notes Address Book (NAB), or waits until the AdminP request is processed at its scheduled interval. The specified value should be True or False. The default is False. Example: immediate=“True”. Requires Notes 6.0.3 or later.

InternetAddress

InternetAddress

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

String

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

Language of Alternate Full Name

AltFullNameLanguage

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

String

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.

Mail File Size Quota

mail-file-quota

As an attribute to an < add> event element.

Integer

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.

Mail Server

mail-server

As an attribute to an < add> event element.

String

Specifies the mail server to be used to create a mailfile for a new user. This attribute overrides the value specified in the driver parameters. Example: mail-server=“CN=ms2/O=acme”

Mail System

mail-system

As an attribute to an < add> event element.

String or integer

Specifies the mail system type set for the new user being created. Valid values are NOTES, POP, INTERNET, OTHER, NONE. The default value is NOTES. Requires Notes 6.0.3 or later.

MailDomain

MailDomain

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

String

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

MailFile

MailFile

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

String

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).

MailFile ACL Administration Server

mailfile-acl-administration-server

As an attribute to an < add> command element.

String: distinguished Notes object name (i.e. “CN=Server1/O=myOrg”)

The name of the Administration Server that can perform maintenance on this database. This value must be a Notes Distinguished Name of a valid Domino Administration Server. Only available on Domino 6.0.3 or higher.

MailFile ACL Admin Names

mailfile-acl-admin-names

As an attribute to an < add> command element.

Boolean: true | false

The ACL isAdminNames property indicates whether the administration server can modify the names fields in this database. Only available on Domino 6.0.3 or higher.

MailFile ACL Admin Reader Author

mailfile-acl-admin-reader-author

As an attribute to an < add> command element.

Boolean: true | false

The ACL isAdminReaderAuthor property indicates whether the administration server can modify the Readers and Authors fields in this database. Only available on Domino 6.0.3 or higher.

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 name, as found in Table 4-5. 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.

MailFile ACL Entry Name

mailfile-acl-entry-name

As an attribute to an < add> command element.

String: distinguished Notes object name (i.e. “CN=John Doe/OU=myOrgUnit/O=myOrg”)

The name of the ACLEntry. If not present, this value defaults to the Notes Distinguished Name (FullName) of the current object being synchronized.

MailFile ACL Entry Remove

mailfile-acl-entry-remove

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the ACLEntry is to be removed from the ACL record of the mailfile database.

MailFile ACL Entry Public Reader

mailfile-acl-entry-public-reader

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the public-reader attribute is set.

MailFile ACL Entry Public Writer

mailfile-acl-entry-public-writer

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the public-writer attribute is set.

MailFile ACL Entry Server

mailfile-acl-entry-server

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the ACLEntry server attribute is set

MailFile ACL Entry Level

mailfile-acl-entry-level

As an attribute to an < add> command element.

String or Integer

Is the equivalent to mailfile-acl-level. Indicates the ACLEntry level. Valid strings include:

MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS

MailFile ACL Entry User Type

mailfile-acl-entry-user-type

As an attribute to an < add> command element.

String or Integer

Indicates the ACLEntry user type. Valid strings include:

MIXED_GROUP PERSON PERSON_GROUP SERVER SERVER_GROUP UNSPECIFIED

MailFile ACL Entry Enable Role

mailfile-acl-entry-enable-role

As an attribute to an < add> command element.

String

Specifies the roles to set on the ACL (by default, mailfile ACLs do no have any roles defined).

MailFile ACL Entry Disable Role

mailfile-acl-entry-disable-role

As an attribute to an < add> command element.

String

Specifies the roles to set on the ACL (by default, mailfile ACLs do no have any roles defined).

MailFile ACL Entry Admin Reader-Author

mailfile-acl-entry-admin-reader-author

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the admin-reader-author attribute is set.

MailFile ACL Entry Admin Server

mailfile-acl-entry-admin-server

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the admin-server attribute is set. If set to true, this setting overrides the ACL Administration Server property and places this entry's name in the ACLs Administration Server property. See acl-administration-server.

MailFile ACL Entry Create Documents

mailfile-acl-entry-can-create-documents

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-create-documents attribute is set.

MailFile ACL Entry Create LS Or Java Agent

mailfile-acl-entry-can-create-ls-or-java-agent

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-create-LS-or-Java attribute is set.

MailFile ACL Entry Create Personal Agent

mailfile-acl-entry-can-create-personal-agent

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-create-personal-agent attribute is set.

MailFile ACL Entry Create Personal Folder

mailfile-acl-entry-can-create-personal-folder

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-create-personal-folder attribute is set.

MailFile ACL Entry Create Shared Folder

mailfile-acl-entry-can-create-shared-folder

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-create-shared-folder attribute is set.

MailFile ACL Entry Delete Documents

mailfile-acl-entry-can-delete-documents

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-delete-documents is set.

MailFile ACL Entry Replicate Or Copy Documents

mailfile-acl-entry-can-replicate-or-copy-documents

As an attribute to an < add> command element.

Boolean: true | false

Indicates if the can-replicate-or-copy-documents attribute is set. This is only available on Domino 6.0.3 or higher.

MailFile ACL Extended Access

mailfile-acl-extended-access

As an attribute to an < add> command element.

Boolean: true | false

The ACL isExtendedAccess property indicates whether extended access is enabled for this database. This is only available on Domino 6.0.3 or higher.

MailFile ACL Internet Level

mailfile-acl-internet-level

As an attribute to an < add> command element.

String or Integer

The maximum internet access level for this database. Valid strings include:

MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS

Mailfile ACL Manager ID

mail-acl-manager-id

As an attribute to an < add> event element.

Specifies the UNID of a user to be given manager credentials on the ACL of the mailfile of the newly created user. An alternate is mail-acl-manager-name. Example: mail-acl-manager-id=“ BB888BB0C35D13EC87256EA8006296CE”

Mailfile ACL Manager Name

mail-acl-manager-name

As an attribute to an < add> event element.

Specifies the name of a user to be given manager credentials on the ACL of the mailfile of the newly created user. An alternate is mail-acl-manager-id. Example: mail-acl-manager-name=“CN=Notes Admin/O=acme”

MailFile ACL Uniform Access

mailfile-acl-uniform-access

As an attribute to an < add> command element.

Boolean: true | false

The ACL isUniformAccess property indicates whether a consistent ACL is enforced across all replicas of this database.

MailFile Action

mail-file-action

As an attribute to a < delete> event element.

Specifies the AdminP action to perform on the mailbox of a deleted user. This action is included in an AdminP user delete request. Acceptable values are ALL, HOME, and NONE. The default value is NONE. ALL indicates to delete the mailbox on the home mail server and all mailbox replicas. HOME indicates to delete the mailbox on only the home mail server. All AdminP delete mailbox requests must be approved by a Domino Administrator before they are performed. Example: mail-file-action=“ALL”. Requires Notes 6.0.3 or later.

MailFile Quota Warning Threshold

mail-quota-warning-threshold

As an attribute to an < add> event element.

Specifies the value of the mail file quota warning threshold (size in KB) that is applied to the e-mail database file when it is created. Example: mail-quota-warning-threshold=“120000”. Requires Notes 6.0.3 or later.

MailFile Subdirectory

mail-file-subdir

As an attribute to an < add> event element.

Specifies the subdirectory below the Domino server's data directory where the mailfile of a new user should be created. Example: mail-file-subdir=“mail-dbs”

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.

MailFile Calendar Profile Create

mailfile-calprofile-create

As an attribute to an < add> command element.

Boolean: true | false

If set to True, new mailfiles are created with a calendar profile document and populated with an owner field.

MailFile Calendar Profile Owner

mailfile-calprofile-owner

As an attribute to an < add> command element.

String: distinguished Notes object name, such as "CN=John Doe/OU=myOrgUnit/O=myOrg" to be the owner of the mailfile.

Set the mailfile owner (within the mailfile’s Tools/Preferences) to a specific user name. By default, when mailfile-calprofile-create equals "true," the mailfile’s owner is automatically set to the name of the newly created Notes person.

MailFile Rep New Server

mailfile-rep-new-server

As an attribute to an < add> command element.

String: distinguished name of Domino server where a new replica will be created, such as CN=server1/O=acme.

The name of the Domino server where a new replica will be created. The Domino server must be accessible on the network. Depending on the size of the database, this might be a time-consuming process for the NotesDriverShim. Can be used in connection with mailfile-rep-new-db-name.

MailFile Rep New DB Name

mailfile-rep-new-db-name

As an attribute to an < add> command element.

String: file name of the new replica, such as mail/JohnDoeRep2.nsf.

The filename of the newly created replica. If mailfile-rep-new-db-name is not present, then the filename of the original database is used. The default location of the new file is in the Domino server's data folder. Can be used in connection with mailfile-rep-new-server.

MailFile Rep Source Server

mailfile-rep-src-server

As an attribute to an < add> command element.

String: distinguished name of a replica Domino source server, such as CN=server2/O=acme.

Specifies the Domino source server (Receives from) of a replication entry within the replication object. If specified, and the source server/destination server pair does not already exist within the replication entry list, then a new replication entry is created. If this parameter is absent, then the source server defaults to “any server” (a hyphen '-' means any server). To be used in connection with mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Destination Server

mailfile-rep-dest-server

As an attribute to an < add> command element.

String: distinguished name of a replica Domino destination server, such as i.e. CN=server1/O=acme.

Specifies the Domino destination server (When computer) of a replication entry (within the replication object). If specified, and the source server/destination server pair does not already exist within the replication entry list, then a new replication entry is created. If this parameter is absent, then the destination server defaults to “any server” (a hyphen “-” means any server). To be used in connection with mailfile-rep-src-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Formula

mailfile-rep-formula

As an attribute to an < add> command element.

String: replication formula

Specifies the replication formula for a replication entry. By default a new replication entry contains the @All formula. The formula must be a valid replication formula. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Include ACL

mailfile-rep-include-acl

As an attribute to an < add> command element.

Boolean: true | false

Specifies the inclusion of the ACL during replication for a replication entry. Set true to include the ACL, and false to exclude the ACL. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Include Agents

mailfile-rep-include-agents

As an attribute to an < add> command element.

Boolean: true | false

Specifies the inclusion of agents during replication for a replication entry. Set to true to include agents, and false to exclude agents. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Include Documents

mailfile-rep-include-documents

As an attribute to an < add> command element.

Boolean: true | false

Specifies the inclusion of documents during replication for a replication entry. Set to true to include documents, and false to exclude documents. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Include Forms

mailfile-rep-include-forms

As an attribute to an < add> command element.

Boolean: true | false

Specifies the inclusion of forms during replication for a replication entry. Set to true to include forms, and false to exclude forms. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Include Formulas

mailfile-rep-include-formulas

As an attribute to an < add> command element.

Boolean: true | false

Specifies the inclusion of formulas during replication for a replication entry. Set to true to include formulas, and false to exclude formulas. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep View List

mailfile-rep-view-list

As an attribute to an < add> command element.

String: ViewList

Specifies a list of view names to be replicated for a replication entry. The string specifies the views as a list, separating view names with semicolons, such as Inbox; Sent; Calendar; Meetings. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. Only available on Domino 6.0.3 or higher.

MailFile Rep Cutoff Interval

mailfile-rep-cutoff-interval

As an attribute to an < add> command element.

Integer: numeric value

Specifies the number of days after which documents are automatically deleted if the CutoffDelete property is set (see mailfile-rep-cutoff-delete).

MailFile Rep Don’t Send Local Security Updates

mailfile-rep-dont-send-local-security-updates

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether local security (encryption) updates are sent. Set to true to not send local security updates, and false to send local security updates. Only available on Domino 6.0.3 or higher.

MailFile Rep Abstract

mailfile-rep-abstract

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether large documents should be truncated and attachments removed during replication. Set to true to truncate large documents and remove attachments, and false to replicate large documents in their entirety.

MailFile Rep Cuttoff Delete

mailfile-rep-cutoff-delete

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether documents that are older than the cutoff date should be automatically deleted. The cutoff date is determined by today's date minus the cutoff interval (mailfile-rep-cutoff-interval). Set to true to automatically delete documents that are older than the cutoff date, and false to not delete old documents.

MailFile Rep Disabled

mailfile-rep-disabled

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether replication is disabled. Set true to disable replication, and false to enable replication.

MailFile Rep Ignore Deletes

mailfile-rep-ignore-deletes

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether outgoing deletions should not be replicated to other databases. Set to true to not replicate outgoing deletions, and false to replicate outgoing deletions.

MailFile Rep Ignore Destination Deletes

mailfile-rep-ignore-dest-deletes

As an attribute to an < add> command element.

Boolean: true | false

Specifies whether incoming deletions should not be replicated to the current database. Set to true to not replicate incoming deletions, and false to replicate incoming deletions.

MailFile Rep Priority

mailfile-rep-priority

As an attribute to an < add> command element.

String or integer

Specifies the replication priority. The choices are HIGH, MED, and LOW. The default is Medium (MED).

MailFile Rep Clear History

mailfile-rep-clear-history

As an attribute to an < add> command element.

Boolean: true | false

Set true to clear the replication history from the replication object, and set to false affects nothing.

MailFile Rep Entry Remove

mailfile-rep-entry-remove

As an attribute to an < add> command element.

Boolean: true | false

Set true to remove the current replication entry from the replication object, and set to false affects nothing. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server.

MailFile Rep Immediate

mailfile-rep-immediate

As an attribute to an < add> command element.

String: distinguished name of a replica Domino destination server, such as CN=server1/O=acme.

Indicates that database replication must begin immediately to the specified Domino server on which an existing database replica already exists.

MailServer

MailServer

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

String

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).

Name Expiration Date

name-expire-date

As an attribute to a < modify> event element.

String

Specifies the specific date when an old user name will expire after a move user is performed by AdminP. This attribute only has effect when moving non-certified (Web) users. This attribute can be applied to override the default expiration term of 21 days. The date format should be specified in text using the appropriate format of the locale of the Domino Server. For example, in English, name-expire-date=“1 July 2010”. An alternate to this attribute is name-expiration-days. Requires Notes 6.0.3 or later.

Name Expiration Days

name-expiration-days

As an attribute to a < modify> event element.

Integer

Specifies the specific number of days an old user name can be used before expiration after a move user is performed by AdminP. This attribute only has effect when moving non-certified (Web) users. This attribute can be applied to override the default expiration term of 21 days. An alternate to this attribute is name-expiration-date. Example: name-expiration-days=“14”. Requires Notes 6.0.3 or later.

Named Old Certifier Password

named-old-cert-pwd

As an attribute to a < move> event element.

String

Specifies the named password for the old certifier ID file required to move a user in Notes from an old certifier to a new certifier. The value is the named password to be retrieved from the driver configuration. An alternate to this attribute is drv-param-old-cert-pwd or old-cert-pwd. This attribute should be used in conjunction with certifier-name, old-cert-id or one of its alternates, cert-id or one of its alternates, and cert-pwd or one of its alternates. Example: named-old-cert-pwd=“mktgNamedPwd”. Requires Notes 6.0.3 or later.

No ID File

no-id-file

As an attribute to an < add> event element.

Boolean: true | false

Specifies whether the Notes registration process creates an ID file for the new user. The value is True or False. The default is False. Example: no-id-file=“True”. Requires Notes 6.0.3 or later.

Notes Explicit Policy Name

notes-policy-name

As an attribute to an < add> event element.

String

Specifies an explicit policy name to attach to a user when the user is registered. This attribute does not execute Notes registration policies, or any other policies at registration time. Requires Notes 6.0.3 or later.

Notes HTTP Password

HTTPPassword

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

String

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)

Notes Password Strength

minimum-pwd-len

As an attribute to an < add> event element.

Integer: 1-16

This tag specifies a password strength 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.

String

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.

Notes Password Change Interval

notes-password- change-interval

As an attribute to an < add>, or < modify> event element.

Integer

Specifies a Notes user's password change interval. The value of this attribute is a number. The change interval specifies the number of days at which the user must supply a new password. The value defaults to zero. When this attribute is attached to a user add or modify event, an AdminP Set Password Information request is generated. Example: notes-password-change-interval=“120.” Requires Notes 6.0.3 or later.

Notes Password Check Setting

notes-password-check-setting

As an attribute to an < add>, or < modify> event element.

String or integer

Specifies a Notes user's password check setting. When this attribute is attached to a user add or modify event, an AdminP Set Password Information request is generated. Acceptable values are PWD_CHK_CHECKPASSWORD, PWD_CHK_DONTCHECKPASSWORD, and PWD_CHK_LOCKOUT. Example = notes-password-check-setting=“ PWD_CHK_CHECKPASSWORD.” Requires Notes 6.0.3 or later.

Internet Password Force Change

internet-password-force-change

As an attribute to an < add>, or < modify> event element.

Boolean: true | false

Specifies whether a Notes user is forced to change his or her password on next login. The value of this attribute is True or False. If set to True, the user is forced to change their password on next login. If set to False (default), the user is not forced to change the password on next login. When this attribute is attached to a user add or modify event, an AdminP Set Password Information request is generated. Example: internet-password-force-change=“True.” Requires Notes 6.0.3 or later.

Notes Password Grace Period

notes-password-grace-period

As an attribute to an < add>, or < modify> event element.

Integer

Specifies a Notes user's password grace period. The value of this attribute is a number. The grace period specifies the number of days an old password is valid after it has expired. The value defaults to zero. When this attribute is attached to a user add or modify event, an AdminP Set Password Information request is generated. Example: notes-password-grace-period=“10.” Requires Notes 6.0.3 or later.

Old Certification ID

old-cert-id

As an attribute to a < move> event element.

String

Specifies the old certifier ID file required to move a user in Notes from an old certifier to a new certifier. The value is the full path and filename of the old certifier ID file. An alternate to this attribute is drv-param-old-cert-id.

This attribute should be used in conjunction with certifier-name, old-cert-pwd or one of its alternates, cert-id or one of its alternates, and cert-pwd or one of its alternates. Example: old‑cert‑id=“c:\lotus\domino\data\mktgcert.id.” Requires Notes 6.0.3 or later.

Old Certification Password

old-cert-pwd

As an attribute to a < move> event element.

String

Specifies the password for the old certifier ID file required to move a user in Notes from an old certifier to a new certifier. The value is the password string. An alternate to this attribute is drv-param-old-cert-pwd or named-old-cert-pwd. This attribute should be used in conjunction with certifier-name, old-cert-id or one of its alternates, cert-id or one of its alternates, and cert-pwd or one of its alternates. Example: old-cert-pwd=“mktg-password1.” Requires Notes 6.0.3 or later.

Rep New Server

rep-new-server

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished name of Domino server where a new replica will be created, such as CN=server1/O=acme.

The name of the Domino server where a new replica will be created. The Domino server must be accessible on the network. Depending on the size of the database this may me a time consuming process for the NotesDriverShim. Can be used in connection with rep-new-db-name.

Rep New Database Name

rep-new-db-name

As an attribute to an < add>, < modify>, or < delete> command element.

String: file name of the new replica, such as mail/JohnDoeRep2.nsf.

The filename of the newly created replica. If rep-new-db-name is not present, then the filename of the original database is used. The default location of the new file is in the Domino server's data folder. Used in connection with rep-new-server.

Rep Source Server

rep-src-server

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished name of a replica Domino source server, such as CN=server2/O=acme.

Specifies the Domino source server (Receives from) of a replication entry (within the replication object). If specified, and the source server/destination server pair does not already exist within the replication entry list, then a new replication entry is created. If this parameter is absent, then the source server defaults to “any server” (a hyphen “-” means any server). To be used in connection with rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Destination Server

rep-dest-server

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished name of a replica Domino destination server, such as CN=server1/O=acme.

Specifies the Domino destination server (When computer) of a replication entry (within the replication object). If specified, and the source server/destination server pair does not already exist within the replication entry list, then a new replication entry is created. If this parameter is absent, then the destination server defaults to “any server” (a hyphen “-” means any server). To be used in connection with rep-src-server. Only available on Domino 6.0.3 or higher.

Rep Formula

rep-formula

As an attribute to an < add>, < modify>, or < delete> command element

String: replication formula

Specifies the replication formula for a replication entry. By default a new replication entry contains the @All formula. The formula must be a valid replication formula. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Include ACL

rep-include-acl

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies the inclusion of the ACL during replication for a replication entry. Set to true to include the ACL, false to exclude the ACL. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Include Agents

rep-include-agents

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies the inclusion of agents during replication for a replication entry. Set to true to include agents, false to exclude agents. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Include Documents

rep-include-documents

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies the inclusion of documents during replication for a replication entry. Set to true to include documents, false to exclude documents. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Include Forms

rep-include-forms

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies the inclusion of forms during replication for a replication entry. Set to true to include forms, false to exclude forms. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Include Formulas

rep-include-formulas

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies the inclusion of formulas during replication for a replication entry. Set to true to include formulas, false to exclude formulas. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep View List

rep-view-list

As an attribute to an < add>, < modify>, or < delete> command element.

String: ViewList

Specifies a specific list of view names be replicated for a replication entry. The string specifies the views as a list, separating view names with semicolons, such as Inbox; Sent; Calendar; Meetings. Used in connection with rep-src-server and/or rep-dest-server. Only available on Domino 6.0.3 or higher.

Rep Cutoff Interval

rep-cutoff-interval

As an attribute to an < add>, < modify>, or < delete> command element.

Integer: numeric value

Specifies the number of days after which documents are automatically deleted if the CutoffDelete property is set (see rep-cutoff-delete).

Rep Don’t Sent Local Security Updates

rep-dont-send-local-security-updates

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether local security (encryption) updates are sent. Set to true to not send local security updates, and false to send local security updates. Only available on Domino 6.0.3 or higher.

Rep Abstract

rep-abstract

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether large documents should be truncated and attachments removed during replication. Set to true to truncate large documents and remove attachments and false to replicate large documents in their entirety.

Rep Cutoff Delete

rep-cutoff-delete

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether documents that are older than the cutoff date should be automatically deleted. The cutoff date is determined by today's date minus the cutoff interval (rep-cutoff-interval). Set to true to automatically delete documents that are older than the cutoff date, and false to not delete old documents.

Rep Disabled

rep-disabled

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether replication is disabled. Set to true to disable replication, and false to enable replication.

Rep Ignore Deletes

rep-ignore-deletes

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether outgoing deletions should not be replicated to other databases. Set to true to not replicate outgoing deletions, and false to replicate outgoing deletions.

Rep Ignore Destination Deletes

rep-ignore-dest-deletes

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Specifies whether incoming deletions should not be replicated to the current database. Set to true to not replicate incoming deletions, and false to replicate incoming deletions.

Rep Priority

rep-priority

As an attribute to an < add>, < modify>, or < delete> command element.

String: HIGH, MED, LOW

Specifies the replication priority. Default is Medium (MED).

Rep Clear History

rep-clear-history

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Set to true to clear the replication history from the replication object, and set to false affects nothing.

Rep Entry Remove

rep-entry-remove

As an attribute to an < add>, < modify>, or < delete> command element.

Boolean: true | false

Set to true to remove the current replication entry from the replication object, and set to false affects nothing. Used in connection with rep-src-server and/or rep-dest-server

Rep Immediate

rep-immediate

As an attribute to an < add>, < modify>, or < delete> command element.

String: distinguished name of a replica Domino destination server. (i.e. CN=server1/Acme)

Indicates that database replication must begin immediately to the specified Domino server on which a existing database replica already exists.

Recertify User

recertify-user

As an attribute to a < modify> event element.

Boolean: true | false

Causes a recertify user request to be sent to AdminP. The attribute value is specified as True or False. Proper certifier ID and password attributes (cert-id, cert-pwd, or equivalents) must be provided or the default certifier is applied to the AdminP recertification request.

This attribute should be used in conjunction with cert-id or its alternate, and cert-pwd or one of its alternates. Can be used in conjunction with expire-term or cert-expire-date elements for specify the new expiration term of the user's certifier. Example: recertify-user=“True.” Requires Notes 6.0.3 or later.

Registered Users in Notes Address Book

update-addressbook

As an attribute to an < add> event element.

Boolean: true | false

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 causes 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.

Roaming Cleanup Period

roaming-cleanup-period

As an attribute to an < add> event element.

Integer

Specifies the Notes client's cleanup interval in days for a roaming user when the roaming user's cleanup setting is set to “CLEANUP_EVERY_NDAYS.” This attribute should be used in conjunction with roaming-user=“True,” and roaming-cleanup-setting=“EVERY_NDAYS.” Example: roaming-cleanup-period=“90.” Requires Notes 6.0.3 or later.

Roaming Cleanup Setting

roaming-cleanup-setting

As an attribute to an < add> event element.

String

Specifies the roaming user cleanup process for Notes client data. Valid values are AT_SHUTDOWN, EVERY_NDAYS, NEVER, and PROMPT. The default value is NEVER. This attribute should be used in conjunction with roaming-user=“True.” Example: roaming-cleanup-setting=“AT_SHUTDOWN.” Requires Notes 6.0.3 or later.

Roaming Server

roaming-server

As an attribute to an < add> event element.

String

Specifies the name of the Domino server to store the roaming user data. This attribute should be used in conjunction with roaming-user=“True.” Example: roaming-server=“CN=myserver2/O=acme.” Requires Notes 6.0.3 or later.

Roaming Subdirectory

roaming-subdir

As an attribute to an < add> event element.

String

Specifies the subdirectory below the Domino server's data directory where user roaming data is stored. The last character of the value should be a file path separator (/ or \). Example: roaming-subdir=“roamdata\”. Requires Notes 6.0.3 or later.

Roaming User

roaming-user

As an attribute to an < add> event element.

Boolean: true | false

Specifies whether the Notes registration process creates this user with roaming capabilities. The value is True or False. The default is False. Example: roaming-user=“True.” Requires Notes 6.0.3 or later.

Store User ID File In Notes Address Book

store-useridfile-in-ab

As an attribute to an < add> event element.

Boolean: true | false

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.

Synchronize Internet Password

sync-internet-password

As an attribute to an < add> event element.

Boolean: true | false

Specifies whether a user's Internet password (HTTPPassword) is synchronized to match the user's Notes Client ID password, by means of the background processes of the Domino server. The value is True or False. The default is False. Example: sync-internet-password=“True.” Requires Notes 6.0.3 or later.

User ID file certifier type

cert-id-type

As an attribute to an < add> event element.

String

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.

User ID file Expiration Term

expire-term

As an attribute to an < add> event element.

Integer

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.

Table 4-5 ACL Description and Its Java ACL Constant

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