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 5.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 column of Table 5-4.
If an attribute overriding a default configuration parameter is present, it is applied to the note with respect to the event type. Because these parameters often map to items in Lotus Notes, these overrides are passed as the attributes 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 NotesConfig21.xml to determine which setting to apply.
For items that use or values, or values can also be used.
The Notes Driver 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 Table 5-5.
The Notes Driver 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.
Table 5-4 Custom Parameters That Override Driver, Subscriber, and Publisher Parameters
|
Parameter Name and Common Description |
Description |
Valid Use |
|---|---|---|
|
adminp-server Administration Process Server |
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". |
As an attribute to an add, modify, move, delete, or domino-console-command command element. String |
|
adminp-rename-user AdminP Rename User |
Specifies whether the NotesDriverShim attempts to issue a Notes AdminP request to rename a Notes person. |
As an XML attribute to the modify element (of a person object). Boolean: true | false |
|
adminp-web-user-rename AdminP Web User Rename |
Specifies whether the NotesDriverShim will attempt to issue a Notes AdminP request to rename a Notes Web User. By default, the NotesDriverShim uses its own detection mechanism and logic to determine if the AdminP rename operation request is for a Notes Web User (Initiate Web User Rename in Domino Directory) or a standard Notes person (Initiate Rename in Domino Directory). This custom parameter allows the modify command to specify if the AdminP rename request should be for a Notes Web user or not. |
As an XML attribute to the modify element (of a person object). Boolean: true | false |
|
allow-adminp-support Allow AdminP Support |
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 it is 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 5.4.2, Subscriber Options, on a command-by-command basis. Example: allow-adminp-support="true". |
As an attribute to an add, modify, move, rename, or delete command element. Boolean: true | false |
|
allow-http-password-set Allow HTTP Password Set |
Specifies if the modify-password command should attempt to modify the HTTPPassword for a given user. This parameter overrides the default driver parameter value allow-http-password-set, which you can specify in the driver’s Subscriber Options parameter section. |
As an XML attribute of a modify-password element. Boolean: true | false |
|
allow-userid-password-set Allow user.id Password Set |
Specifies if the modify-password command should attempt to modify the password of a given user.id file. This parameter overrides the default driver parameter value allow-userid-password-set, which you can specify in the driver's Subscriber Options parameter section. |
As an XML attribute of a modify-password element. Boolean: true | false |
|
AltFullNameLanguage Language of Alternate Full Name |
This element specifies the language used for the Alternate Full Name when registering a new user. Like other user attributes, this can be synchronized by using an attribute in eDirectory or inserted in a style sheet. See the Lotus Notes documentation for information on setting AltFullNameLanguage for a user. |
As an add-attr child element of an add event. String |
|
AltFullName Alternate Full Name |
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. |
As an add-attr child element of an add event. String |
|
alt-org-unit Alternate Organization Unit |
Specifies the alternate Organization Unit when registering a new user in Notes. |
As an attribute to an add command element. String |
|
alt-org-unit-lang Alternate Organization Unit Language |
Specifies the alternate Organization Unit language when registering a new user in Notes. |
As an attribute to an add command element. String |
|
cert-expire-date Certification Expiration Date |
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 machine hosting the Notes Driver shim. For example, in English, cert-expire-date="1 July 2010". An alternate to this attribute is expire-term. |
As an attribute to an add, modify, or move command element. String |
|
cert-id Certifier ID File |
This XML attribute 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. |
As an attribute to an add command element String |
|
cert-id-type User ID file certifier type |
This XML attribute 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 XML attribute sets the default certifier type of ID_HIERARCHICAL. |
As an attribute to an add command element. String |
|
cert-pwd Certifier Password |
This XML attribute 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 cert-id-password parameter in the driver configuration. Alternates are named-cert-pwd and drv-param-cert-pwd. |
As an attribute to an add command element. String |
|
certificate-authority-org Certificate Authority Organization |
This custom parameter is deprecated. The value certificate-authority-org specifies a certificate name, and is used in conjunction with custom parameter use-certificate-authority="true". If Domino CA services are functional, this parameter can be used instead of cert-id (or its alternate: drv-param-cert-id) and cert-pwd (or its alternates: drv-param-cert-pwd or named-cert-pwd) XML attributes. Example: certificate-authority-org="/certwest/west". This custom parameter has an alternate of certifier-name. |
As an attribute to an add, modify command element. String: Notes name of the Notes Certifier |
|
certifier-name Certifier Name |
For add or modify, the parameter specifies a certificate name. Use in conjunction with custom parameter use-certificate-authority="true". If Domino CA services are functional, you can use this parameter instead of cert-id (or its alternate: drv-param-cert-id) and cert-pwd (or its alternates: drv-param-cert-pwd or named-cert-pwd) XML attributes. Example: certifier-name="/certwest/west". This custom parameter has a deprecated alternate of certificate-authority-org. For move, this 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. Use this attribute 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". |
As an attribute to an add, modify, or move command element. String: the Notes name of the Notes Certifier |
|
certify-user Certify User Flag |
Applying this XML attribute 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. |
As an attribute to an add command element. String |
|
comparison-operator Comparison Operator |
Specifies the method of comparison for the value during the Notes database search in order to satisfy a query command. |
Within an XDS query document, as an attribute to the value element. String - '=', '<', '>', '<=', '>=', '!='. |
|
compute-with-form Compute With Form |
Specifies whether the NotesDriverShim will attempt to computeWithForm() prior to saving a newly created or modified Notes Document. When passing a compute-with-form="true" XML attribute on a XDS driver command, the NotesDriverShim attempts to execute the Notes document's computeWithForm() method, prior to saving any changes to a modified (or newly created) Notes document. The computeWithForm() method should appropriately execute any database designs that are associated with computing fields defined by that particular form that is defined within the synchronized Notes database. |
As an attribute to an add, or modify command element. Boolean: true | false The default is |
|
create-mail Create Mail File Flag |
This XML attribute 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. |
As an attribute to an add command element. Boolean: true | false |
|
delete-windows-group Delete Windows Group |
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". |
As an attribute to a delete class="group" command element. Boolean: true | false |
|
delete-windows-user Delete Windows User |
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". |
As an attribute to a delete class="user" command element. Boolean: true | false |
|
deny-access-group-id Deny Access Group ID |
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". |
As an attribute to a delete command element. String |
|
deny-access-group-name Deny Access Group Name |
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". |
As an attribute to a delete command element. String |
|
drv-param-cert-id Certifier ID File Parameter Reference |
This XML attribute can be used instead of the Certifier ID file cert-id XML attribute. This attribute 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 XML attribute 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. |
As an attribute to an add command element String |
|
drv-param-cert-pwd Certifier Password Parameter Reference |
This attribute can be used instead of the Certifier Password cert-pwd XML attribute. This attribute 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 XML attribute 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. |
As an attribute to an add command element. String |
|
drv-param-old-cert-id Driver Parameter Old Certifier ID |
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 XML attribute. 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". |
As an attribute to a move command element. String |
|
drv-param-old-cert-pwd Driver Parameter Old Certifier Password |
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 XML attribute. 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". |
As an attribute to a move command element. String |
|
enforce-unique-short-name Enforce Unique Short Name |
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". |
As an attribute to an add command element. String |
|
extended-ou Extended OU |
The value of the XML attribute is appended to the generated DN based on the selected certifier when registering a user. |
As an attribute to an add or modify command element. String |
|
expire-term User ID file Expiration Term |
This XML attribute 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. |
As an attribute to an add command element. Integer |
|
HTTPPassword Notes HTTP Password |
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 False. |
As an add-attr or modify-attr child element of an add or modify event. String |
|
immediate Immediate |
Specifies whether a delete event performed by AdminP immediately deletes a user from the Notes Address Book, 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". |
As an attribute to a delete command element. Boolean: true | false |
|
InternetAddress InternetAddress |
This element specifies the user’s Internet e-mail address in the Notes Address Book. |
As an add-attr child element of an add event. String |
|
internet-password-force-change Internet Password Force Change |
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 it is set to True, the user is forced to change his or her password on next login. If it is 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". |
As an attribute to an add, or modify command element. Boolean: true | false |
|
match-syntax Match Syntax |
Specifies whether the NotesDriverShim's query processor is to interpret the search values using literal Lotus Notes Formula Language Match syntax. If set to True, match syntax special characters (\, {, }, ?, *, &, !, |, +) are not used literally, but are used as wildcards to conform with the Lotus Script Formula Language's Match syntax. |
Within an XDS query document, as an attribute to the search-class element, or as a search-attr element's child value element.Boolean: true | false The default is . |
|
minimum-pwd-len Notes Password Strength |
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 strength parameter minimum-pwd-len in the driver configuration. |
As an attribute to an add command element. Integer: 1-16 |
|
named-cert-pwd Certifier Password Key Name Reference |
This XML attribute can be used instead of the Certifier Password cert-pwd XML attribute. This attribute 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. |
As an attribute to an add command element. String |
|
name-expire-date Name Expiration Date |
Specifies the date when an old user name expires 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. |
As an attribute to a modify command element. String |
|
name-expiration-days Name Expiration Days |
Specifies the 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". |
As an attribute to a modify command element. Integer |
|
named-old-cert-pwd Named Old Certifier Password |
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". |
As an attribute to a move command element. String |
|
no-id-file No ID File |
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”. |
As an attribute to an add command element. Boolean: true | false |
|
notes-doc-lock-fail-action Notes Document Lock Failure Action |
Specifies the status return code for the specific command if the Notes document locking method fails to obtain a lock. |
As an attribute to an add, modify, or modify-pasword command element. String: FATAL, RETRY, ERROR, WARNING, SUCCESS, or UNKNOWN |
|
notes-policy-name Notes Explicit Policy Name |
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. |
As an attribute to an add command element. String |
|
notes-save-fail-action Notes Document Save Failure Action |
Specifies the status return code for the specific command if the Notes document save method fails. |
As an attribute to an add, modify, rename, delete , or modify-pasword command element. String: FATAL, RETRY, ERROR, WARNING, SUCCESS, or UNKNOWN |
|
notes-password- change-interval Notes Password Change Interval |
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". |
As an attribute to an add or modify command element. Integer |
|
notes-password-check-setting Notes Password Check Setting |
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". |
As an attribute to an add or modify command element. String or integer |
|
notes-password-grace-period Notes Password Grace Period |
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". |
As an attribute to an add or modify command element. Integer |
|
old-certifier-name Old Certifier Name |
Specifies a certificate name that designates the origin of a Notes move operation. Use this parameter in conjunction with the parameter use-certificate-authority="true". If Domino CA services are functional, this custom parameter can be used instead of cert-id (or its alternate: drv-param-cert-id) and cert-pwd (or its alternates: drv-param-cert-pwd or named-cert-pwd) XML attributes. Example: old-certifier-name="\certwest\west" This custom parameter has a deprecated alternate of old-certificate-authority-org. |
As an attribute to an add, or modify command element. String: Notes name of the old Notes Certifier |
|
old-cert-use-certificate-authority Old Certifier Use Certificate Authority |
Specifies if the Domino CA process is to be used for the old certifier that is required for a Notes move operation. It is used in conjunction with custom parameter old-certifier-name or its deprecated alternate old-certificate-authority-org. |
As an attribute to an modify command element. Boolean: true | false The default is . |
|
old-certificate-authority-org Old Certificate Authority Organization |
This custom parameter is deprecated. The parameter old-certificat-authority-org specifies a certificate name that designates the origin of a Notes move operation. This is used in conjunction with custom parameter old-cert-use-certificate-authority="true". If Domino CA services are functional, this custom parameter can be used instead of old-cert-id (or its alternate: drv-param-old-cert-id) and old-cert-pwd (or its alternates: drv-param-old-cert-pwd or named-old-cert-pwd) XML attributes. Example: old-certificate-authority-ord="\certwest\west" This custom parameter has an alternate of old-certifier-name. |
As an attribute to an add, or modify command element. String: Notes name of the old Notes Certifier |
|
old-cert-id Old Certification ID |
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". |
As an attribute to a move command element. String |
|
old-cert-pwd Old Certification Password |
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". |
As an attribute to a move command element. String |
|
recertify-user Recertify User |
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". |
As an attribute to a modify command element. Boolean: true | false |
|
registration-dest-dn-check Notes Registration FullName Uniqueness Check |
Specifies whether the NotesDriverShim should check for FullName field uniqueness of a new Notes person prior to the Notes registration process. |
As an attribute to an add command element. Boolean: true | false Default is |
|
remove-all-group-membership Group Membership Removal |
This XML attribute 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 True or False. The absence of this XML attribute defaults to False. This tag only applies to person (user) objects in the Notes Address Book. |
As an attribute to a modify or delete command element. Boolean: true | false |
|
roaming-cleanup-period Roaming Cleanup Period |
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". |
As an attribute to an add command element. Integer |
|
roaming-cleanup-setting Roaming Cleanup Setting |
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" |
As an attribute to an add command element. String |
|
roaming-server Roaming Server |
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". |
As an attribute to an add command element. String |
|
roaming-subdir Roaming Subdirectory |
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\" |
As an attribute to an add command element. String |
|
roaming-user Roaming User |
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". |
As an attribute to an add command element. Boolean: true | false |
|
store-useridfile-in-ab Store User ID File In Notes Address Book |
This XML attribute specifies if the driver attaches the user ID file for this user to its user object in the Notes Address Book at registration time. Setting the attribute to True causes this registered user object in the Notes Address Book to be created with an attached user ID file. Setting the attribute to False 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. |
As an attribute to an add command element. Boolean: true | false |
|
sync-internet-password Synchronize Internet Password |
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". |
As an attribute to an add command element. Boolean: true | false |
|
tell-adminp-process Domino Console Command |
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". See the instructions in Section 5.10, TELL AdminP Commands. |
As an attribute to an add, modify, move, delete command element. String |
|
update-addressbook RegisteUsers in Notes Address Book |
This XML attribute specifies if the driver puts registered user objects in the Notes Address Book. Setting the attribute to True causes registered users to be placed in the address book. Setting the attribute to False 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. |
As an attribute to an add command element. Boolean: true | false |
|
use-certificate-authority Use Certificate Authority |
Specifies if the Domino CA process should be used to register, recertify, rename, or move a user. Requires certify-name to be provided, instead of cert-id (or its alternate: drv-param-cert-id) and cert-pwd (or one of its alternates: drv-param-cert-pwd or named-cert-pwd). |
As an attribute to an add, or modify command element. Boolean: true | false The default is |
|
user-id-file ID File Name |
This XML attribute specifies the filename to be used for the user’s ID file. The filename does not include the file path. When this XML attribute is absent, a default filename is generated by the Notes driver by using the first and last name attributes of the user (FirstNameLastName.id). |
As an attribute to an add command element. String |
|
user-id-path ID File Path |
This XML attribute 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. |
As an attribute to an add command element. String |
|
user-pwd Notes Password |
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. |
As an attribute to an add command element. String |
The following table lists the XML element attributes that can be inserted in the add or modify command element in an XDS document that is submitted to the NotesDriverShim to appropriately configure the synchronized database’s ACL settings. The first column of the table contains the parameter name followed by its common description. The parameters are alphabetized according to the XML parameter name.
The third column of the following table contains XML text that you can paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.
Table 5-5 ACL Custom Parameters
The following table lists the XML element attributes that can be inserted into the add command element in an XDS document that is submitted to the NotesDriverShim to appropriately configure a mailfile database. The first column of the table contains the parameter name followed by its common description. The parameters are alphabetized according to the XML parameter name.
The third column of the following table contains XML text that you can paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.
XML element attributes used for mailfile replication settings (prefixed with mailfile-) can only be used within add command elements. These attributes are divided into mailfile-ACL and MailFile Rep attributes in this table.
Table 5-7 Mailfile Custom Parameters
|
Parameter Name and Common Description |
Description |
XML to Define Driver Parameters |
|---|---|---|
|
mail-acl-manager-id Mailfile ACL Manager ID |
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" As of NotesDriverShim v3.5, mail-acl-manager-id can appropriately handle Notes Person UNID values and Notes Group UNID values. |
As an attribute to an add command element. |
|
mail-acl-manager-name Mailfile ACL Manager Name |
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" |
As an attribute to an add command element. |
|
mail-acl-manager-group Mailfile ACL Manager Group |
Specifies the name of a Notes group or groups to be given manager credentials on the ACL of the mailfile of the newly created user. The ACL entry type created when using this attribute is MIXED_GROUP. More than one group name can be specified by using a semicolon separator. Example: mail-acl-manager-group="LocalDomainAdmins;MailAdmins". |
As an XML attribute to an add command element. String - name of Notes Group (LocalDomainAdmins). |
|
MailDomain MailDomain |
Specifies the name of the Notes Mail Domain when creating an e-mail database file. |
As an add-attr child element of an add event. String |
|
MailFile MailFile |
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 by using the first and last name attributes of the user (FirstNameLastName.nsf). |
As an add-attr child element of an add event. String |
|
mail-file-action MailFile Action |
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 MAILFILE_DELETE_ALL,MAILFILE_DELETE_HOME, and MAILFILE_DELETE_NONE. The default value is MAILFILE_DELETE_NONE. MAILFILE_DELETE_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" |
As an attribute to a delete command element. |
|
mail-file-inherit-flag Database Inheritance for Mail File Template |
This XML attribute specifies whether database structures based on a particular template are updated when that template is updated. Its value can be True or False. The default (the absence of this tag) is True. You can override the default and set this XML attribute to False if you don’t want a change to a mail file template to affect existing database design. |
As an attribute to an add command element. Boolean: true | false |
|
mail-file-subdir MailFile Subdirectory |
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" |
As an attribute to an add command element. |
|
mail-file-quota Mail File Size Quota |
This XML attribute specifies the value of the mail file quota (size in MB) that is applied to the e-mail database file when it is created. |
As an attribute to an add command element. Integer |
|
mailfile-acl-administration-server MailFile ACL Administration Server |
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. |
As an attribute to an add command element. String: distinguished Notes object name (i.e. "CN=Server1/O=myOrg") |
|
mailfile-acl-admin-names MailFile ACL Admin Names |
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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-admin-reader-author MailFile ACL Admin Reader Author |
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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-admin-reader-author MailFile ACL Entry Admin Reader-Author |
Indicates if the admin-reader-author attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-admin-server MailFile ACL Entry Admin Server |
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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-create-documents MailFile ACL Entry Create Documents |
Indicates if the can-create-documents attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-create-ls-or-java-agent MailFile ACL Entry Create LS Or Java Agent |
Indicates if the can-create-LS-or-Java attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-create-personal-agent MailFile ACL Entry Create Personal Agent |
Indicates if the can-create-personal-agent attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-create-personal-folder MailFile ACL Entry Create Personal Folder |
Indicates if the can-create-personal-folder attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-create-shared-folder MailFile ACL Entry Create Shared Folder |
Indicates if the can-create-shared-folder attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-delete-documents MailFile ACL Entry Delete Documents |
Indicates if the can-delete-documents is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-can-replicate-or-copy-documents MailFile ACL Entry Replicate Or Copy Documents |
Indicates if the can-replicate-or-copy-documents attribute is set. This is only available on Domino 6.0.3 or higher. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-disable-role MailFile ACL Entry Disable Role |
Specifies the roles to set on the ACL (by default, mailfile ACLs do not have any roles defined). |
As an attribute to an add command element. String |
|
mailfile-acl-entry-enable-role MailFile ACL Entry Enable Role |
Specifies the roles to set on the ACL (by default, mailfile ACLs do not have any roles defined). |
As an attribute to an add command element. String |
|
mailfile-acl-entry-level MailFile ACL Entry Level |
The equivalent to mailfile-acl-level. Indicates the ACLEntry level. Valid strings include: MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS |
As an attribute to an add command element. String or Integer |
|
mailfile-acl-entry-name MailFile ACL Entry Name |
The name of the ACLEntry. If not present, this value defaults to the Notes Distinguished Name (FullName) of the current object being synchronized. |
As an attribute to an add command element. String: distinguished Notes object name (i.e. “CN=John Doe/OU=myOrgUnit/O=myOrg”) |
|
mailfile-acl-entry-public-reader MailFile ACL Entry Public Reader |
Indicates if the public-reader attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-public-writer MailFile ACL Entry Public Writer |
Indicates if the public-writer attribute is set. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-remove MailFile ACL Entry Remove |
Indicates if the ACLEntry is to be removed from the ACL record of the mailfile database. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-server MailFile ACL Entry Server |
Indicates if the ACLEntry server attribute is set |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-entry-user-type MailFile ACL Entry User Type |
Indicates the ACLEntry user type. Valid strings include: MIXED_GROUP PERSON PERSON_GROUP SERVER SERVER_GROUP UNSPECIFIED |
As an attribute to an add command element. String or Integer |
|
mailfile-acl-extended-access MailFile ACL Extended Access |
The ACL isExtendedAccess property indicates whether extended access is enabled for this database. This is only available on Domino 6.0.3 or higher. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-acl-internet-level MailFile ACL Internet Level |
The maximum Internet access level for this database. Valid strings include: MANAGER DESIGNER EDITOR AUTHOR READER DEPOSITOR NOACCESS |
As an attribute to an add command element. String or Integer |
|
mailfile-acl-level MailFile ACL Control |
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 5-6. 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. |
As an attribute to an add command element. |
|
mailfile-acl-uniform-access MailFile ACL Uniform Access |
The ACL isUniformAccess property indicates whether a consistent ACL is enforced across all replicas of this database. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-adminp-create Administration Process Mailfile Creation |
Specifies if the creation of a mailfile is to be performed via AdminP (in the background). When it is set to , the Notes user's mailfile is created via AdminP. Example: mailfile-adminp-create ="true". |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-calprofile-create Mailfile Owner Attribute Creation |
Specifies if a mailfile calendar profile document is created within a newly created mailfile, indicating the mailfile owner for the mailfile database. |
As an attribute to an add, or modify command element. Boolean: true | false Default is |
|
mailfile-calprofile-owner Mailfile Owner |
Specifies the mailfile owner field that is inserted in the mailfile calendar profile document of the a newly created mailfile database. |
As an attribute to an add, or modify command element. String: The owner’s name of the newly created Notes mailfile. The name should be in Notes canonical format. |
|
mailfile-template MailFileTemplate |
This XML attribute 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 in the driver configuration. |
As an attribute to an add command element |
|
mailfile-rep-abstract MailFile Rep Abstract |
Specifies whether large documents should be truncated and attachments removed during replication. Set it to True to truncate large documents and remove attachments, and to False to replicate large documents in their entirety. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-background Background Mailfile Replica Creation |
Specifies if creating a mailfile replica is performed via AdminP (in the background). When it is set to True, the mailfile replica is created via AdminP on the server(s) specified by the mailfile-rep-new-server custom parameter. Example: mailfile-rep-background="true". |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-clear-history MailFile Rep Clear History |
Set it to True to clear the replication history from the replication object, and set it to False affects nothing. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-cutoff-delete MailFile Rep Cuttoff Delete |
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 it to True to automatically delete documents that are older than the cutoff date, and to False to not delete old documents. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-cutoff-interval MailFile Rep Cutoff Interval |
Specifies the number of days after which documents are automatically deleted if the CutoffDelete property is set (see mailfile-rep-cutoff-delete). |
As an attribute to an add command element. Integer: numeric value |
|
mailfile-rep-disabled MailFile Rep Disabled |
Specifies whether replication is disabled. Set it to True to disable replication, and to False to enable replication. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-dest-server MailFile Rep Destination Server |
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, a new replication entry is created. If this parameter is absent, the destination server defaults to “any server” (a hyphen “-” means any server). Used in connection with mailfile-rep-src-server. Only available on Domino 6.0.3 or higher. |
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. |
|
mailfile-rep-dont-send-local-security-updates MailFile Rep Don’t Send Local Security Updates |
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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-entry-remove MailFile Rep Entry Remove |
Set it to True to remove the current replication entry from the replication object, and set it to False to affect nothing. Used in connection with mailfile-rep-src-server and/or mailfile-rep-dest-server. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-formula MailFile Rep 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. |
As an attribute to an add command element. String: replication formula |
|
mailfile-rep-immediate MailFile Rep Immediate |
Indicates that database replication must begin immediately to the specified Domino server on which an existing database replica already exists. |
As an attribute to an add command element. String: distinguished name of a replica Domino destination server, such as CN=server1/O=acme. |
|
mailfile-rep-include-acl MailFile Rep Include ACL |
Specifies the inclusion of the ACL during replication for a replication entry. Set it toTrue to include the ACL, and to 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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-include-agents MailFile Rep Include Agents |
Specifies the inclusion of agents during replication for a replication entry. Set it 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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-include-documents MailFile Rep Include Documents |
Specifies the inclusion of documents during replication for a replication entry. Set it to True to include documents, and to 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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-include-forms MailFile Rep Include Forms |
Specifies the inclusion of forms during replication for a replication entry. Set it to True to include forms, and to 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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-include-formulas MailFile Rep Include Formulas |
Specifies the inclusion of formulas during replication for a replication entry. Set it to True to include formulas, and to 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. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-ignore-deletes MailFile Rep Ignore Deletes |
Specifies whether outgoing deletions should not be replicated to other databases. Set it to True to not replicate outgoing deletions, and to False to replicate outgoing deletions. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-ignore-dest-deletes MailFile Rep Ignore Destination Deletes |
Specifies whether incoming deletions should not be replicated to the current database. Set it to True to not replicate incoming deletions, and to False to replicate incoming deletions. |
As an attribute to an add command element. Boolean: true | false |
|
mailfile-rep-new-db-name MailFile Rep New DB Name |
The filename of the newly created replica. If mailfile-rep-new-db-name is not present, 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. |
As an attribute to an add command element. String: file name of the new replica, such as mail/JohnDoeRep2.nsf. |
|
mailfile-rep-new-server MailFile Rep New Server |
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. |
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. |
|
mailfile-rep-priority MailFile Rep Priority |
Specifies the replication priority. The choices are HIGH, MED, and LOW. The default is Medium (MED). |
As an attribute to an add command element. String or integer |
|
mailfile-rep-src-server MailFile Rep Source Server |
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, a new replication entry is created. If this parameter is absent, 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. |
As an attribute to an add command element. String: distinguished name of a replica Domino source server, such as CN=server2/O=acme. |
|
mailfile-rep-view-list MailFile Rep View List |
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. |
As an attribute to an add command element. String: ViewList |
|
mail-quota-warning-threshold MailFile Quota Warning Threshold |
Specifies the value of the mailfile 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" |
As an attribute to an add command element. |
|
MailServer MailServer |
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). |
As an add-attr child element of an add event. String |
|
mail-server Mail Server |
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" Alternate: See the MailServer custom parameter. |
As an attribute to an add command element. String |
|
mailsystem Mail System |
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. |
As an attribute to an add command element. String or integer |
|
match-syntax Match Syntax |
Specifies whether the NotesDriverShim's query processor is to interpret the search values by using literal Lotus Notes Formula Language Match syntax. If set to True, Match syntax special characters (\, {, }, ?, *, &, !, |, +) are not used literally, but are used as wildcards to conform with the Lotus Script Formula Language's Match syntax. |
Within an XDS query document, as an attribute to the search-class element, or as a search-attr element's child value element. Boolean: true | false The efault is . |
The following table lists the XML element attributes that can be inserted into the add or modify command element in an XDS document that is submitted to the NotesDriverShim to appropriately configure a synchronized database’s replication options. The first column of the table contains the parameter name followed by its common description. The parameters are alphabetized according to the XML parameter name.
The third column of the following table contains XML text that you can paste into the Driver Parameters XML Editor. The XML text represents exactly what is necessary to display the parameters.
Table 5-8 Rep Custom Parameters