Installation attributes
The following table lists the attributes that are used during the installation of the adapter. If you are using a response file, you must include all of the attributes marked as required.
| Rqd | Attribute | Description | Example |
|---|---|---|---|
| Yes | |
The value of this parameter sets the installation directory path. | USER_INSTALL_DIR="C:\\Program Files\\IBM\\ISIM\\agent\\NotesAgent" Note: The
installation path must be wrapped in quotation marks. And use path
separator as \\
|
| Yes | |
The values of this parameter are \"Full Installation\" and \"Update Installation\" | USER_INPUT_INSTALL_TYPE=Full Installation,\"\" or USER_INPUT_INSTALL_TYPE=\"\",\"Update Installation\" |
| Yes | |
When the value of this parameter is Full Installation the installer performs full installation of the adapter. | USER_INPUT_INSTALL_TYPE_1=\Full Installation\ Set this variable as blank if you want perform an update operation. For example, USER_INPUT_INSTALL_TYPE_1= |
| Yes | |
When the value of this parameter is Update Installation the installer performs full installation of the adapter. | USER_INPUT_INSTALL_TYPE_2=Update
Installation Set this variable as blank if you want perform
a full operation. For example, USER_INPUT_INSTALL_TYPE_2= Note: When
Update Installation is specified, the parameter USER_INPUT_INSTALL_TYPE_1 must
be blank. You must explicitly override the default value of USER_INPUT_INSTALL_TYPE_BOOLEAN_1 to 0.
|
| Yes | |
This parameter is associated with USER_INPUT_INSTALL_TYPE_1. When the value of this parameter is 1 the installer performs a full installation of the adapter. | USER_INPUT_INSTALL_TYPE_BOOLEAN_1=1 Set this variable to 0 if you want to perform an update installation USER_INPUT_INSTALL_TYPE_BOOLEAN_1=0 |
|
When the value of this parameter is Update Installation the installer performs an update installation of the adapter. | USER_INPUT_INSTALL_TYPE_2=Update
Installation Note: When Update Installation is
specified, the parameter USER_INPUT_INSTALL_TYPE_1 must
be blank or not specified at all. You must explicitly override the
default value of USER_INPUT_INSTALL_TYPE_BOOLEAN_1 to 0.
|
|
| Yes | |
This parameter is associated with USER_INPUT_INSTALL_TYPE_2 When the value of this parameter is 1 the installer performs an update installation of the adapter. | USER_INPUT_INSTALL_TYPE_BOOLEAN_2=1 Set this variable to 0 if you want to perform a full installation. |
| Yes | |
Specifies the Lotus Notes Adapter name. You can install multiple instances of the adapter on different ports by providing different names to the adapter. For example, NotesAgent1, NotesAgent2. The default name is NotesAgent. | AgentName=\"NotesAgent\" |
| Yes | |
Specifies the name of Lotus notes adapter. It is the same as that of AgentName but without quotation marks. | AgentName_1=NotesAgent Note: Value
of AgentName_1 must be same as that of AgentName but
without quotation marks.
|
|
Ignore this variable. Keep the value as blank. You can remove it from response file. | AgentName_BOOLEAN_1= | |
|
This attribute is Boolean variable its value is either 0 or 1. If value of this variable is 1 then value of domino version Number is 8.5. | DominoVersionNumber_8.5=1 | |
| Yes | |
Specifies the Lotus Domino Registration Server name that the adapter uses. The name is in format CN=Server Name/O=org. name. | DominoServerName=CN=PS7636/O=psl |
| Yes | |
Specifies the name of the Lotus Notes Address Book when it is other than names.nsf. The Lotus Notes Address Book database file is different from the NoteIdsAddressBook database file. | AddressBookName= Note: Keep
the value as blank if address book name is names.nsf.
|
| Yes | |
Specifies the path to the Lotus Domino Server Workstation ID file. The adapter uses the workstation ID file to connect to the Lotus Domino server. Specify the fully qualified name of the file | WkStnIDFile=C:\\ID\\PS7636\\admin.id Note: The
path separator is \\ (double backslash).
|
| Yes | |
Specifies the password of the Workstation ID file. | WkStnPass=password |
| Yes | |
Specifies the name of the group that the Lotus Notes Adapter uses to keep the CN values of the suspended users. Create this group on the Lotus Domino server before you run the adapter. | SuspendGroupName=SuspendGroup |
| Yes | |
Specifies the name of the group that the Lotus Notes Adapter uses to keep the CN values of the suspended users to restrict Internet access. Create this group on the Lotus Domino server before you run the adapter. | |
| Yes | |
Specifies the name of the group that the Lotus Notes Adapter uses to keep the CN values of the deleted users. Create this group on the Lotus Domino server before you run the adapter. | DeleteGroupName=DelGroup |
| Yes | |
Specifies the name of a Lotus Notes database. It lists the deleted or suspended user documents. The adapter removes the user documents from this database file when a user is added or restored. | LogDBName=Logdb Note: The
value can be blank.
|
| Yes | |
Specifies the list of attribute names to include in the reconciliation process. When more than one name is listed, separate them by a semicolon. When you do not provide any value in the Reconciled Attributes field, all the attributes are returned during the reconciliation operation. Except for those attributes that are specified in the NotReconAttribs list. The default value is blank. | ReconAttribs= |
| Yes | |
Specifies the list of attribute names to exclude from the reconciliation process. When more than one name is listed, separate them by a semicolon. The default values are Certificate;$UpdatedBy;$Revisions. | |
|
This attribute is a Boolean variable. If value of SynchroniseHTTPPwd_YES is 1, the user password is set as Internet password during an Add or Modify request. When you do not specify this option during the installation the default value is TRUE. | SynchroniseHTTPPwd_YES=1 or SynchroniseHTTPPwd_YES=0 Note: The
value of SynchroniseHTTPPwd_YES must be the opposite
of SynchroniseHTTPPwd_NO. For example, if the
value SynchroniseHTTPPwd_YES is 1 the
value of SynchroniseHTTPPwd_NO must be 0.
|
|
|
This Boolean variable is associated with SynchroniseHTTPPwd_YES. If value of SynchroniseHTTPPwd_NO is 1, the user password is not set as Internet password during an Add or Modify request. | SynchroniseHTTPPwd_NO=1 or SynchroniseHTTPPwd_NO=0 Note: The
value of SynchroniseHTTPPwd_NO must be the opposite
of SynchroniseHTTPPwd_YES. For example, if the
value SynchroniseHTTPPwd_NO is 1 the
value of SynchroniseHTTPPwd_YES must be 0.
|
|
|
If the value is 1, the Lotus Notes Adapter is configured to use the short name value as a unique ID on the IBM® Security Identity Manager server. | UseShortName_YES=1 or UseShortName_YES=0 Note: The
value of UseShortName_YES must be the opposite
of UseShortName_NO . For example, if the value UseShortName_YES is 1 the
value of UseShortName_NO must be 0.
|
|
|
If the value is 1, the Lotus Notes Adapter is not configured to use the short name value as a unique ID on the IBM Security Identity Manager server. When you do not specify this option during the installation the default value is FALSE. | UseShortName_NO=1 or UseShortName_NO=0 Note: The
value of UseShortName_NO must be the opposite
of UseShortName_YES . For example, if the value UseShortName_NO is 1 the
value of UseShortName_YES must be 0.
|
|
|
If the value is 1, the Lotus Notes Adapter requires a unique ID as the internet address on the IBM Security Identity Manager server when the short name value is NULL. Set only this key to 1 when the Use ShortName key is also set to 1. | UseInetAddrForShortName_YES=1 or UseInetAddrForShortName_YES=0 Note: The
value of UseInetAddrForShortName_YES must be
the opposite of UseInetAddrForShortName_NO .
For example, if the value UseInetAddrForShortName_YES is 1 the
value of UseInetAddrForShortName_NO must be 0.
|
|
|
If the value is 1, the Lotus Notes Adapter does not require a unique ID as the internet address on the IBM Security Identity Manager server | UseInetAddrForShortName_NO=1 or UseInetAddrForShortName_NO=0 Note: The
value of UseInetAddrForShortName_NO must be the
opposite of UseInetAddrForShortName_YES . For
example, if the value UseInetAddrForShortName_NO is 1 the
value of UseInetAddrForShortName_YES must be 0.
|
|
| Yes | |
Specifies the name of the Lotus Notes database file that the adapter uses to store the user information. For example, the username, password, and ID file. The value can be blank. | IdsAddressBookName= |
|
If the value is 1, the mail database file is deleted, when a user is deleted. | DeleteMailDB_YES=1 or DeleteMailDB_YES=0 Note: The
value of DeleteMailDB_YES must be the opposite
of DeleteMailDB_NO . For example, if the value DeleteMailDB_YES is 1 the
value of DeleteMailDB_NO must be 0.
|
|
|
If the value is 1, the mail database file is not deleted, when a user is deleted | DeleteMailDB_NO=1 or DeleteMailDB_NO=0 Note: The
value of DeleteMailDB_NO must be the opposite
of DeleteMailDB_YES . For example, if the value DeleteMailDB_NO is 1 the
value of DeleteMailDB_YES must be 0.
|
|
|
If the value is 1, only the HTTP password of the user is changed in the Change Password operation from IBM Security Identity Manager. | SetHTTPPswdOnly_YES=1 or SetHTTPPswdOnly_YES=0 Note: The
value of SetHTTPPswdOnly_YES must be the opposite
of SetHTTPPswdOnly_NO . For example, if the value SetHTTPPswdOnly_YES is 1 the
value of SetHTTPPswdOnly_NO must be 0.
|
|
|
If the value is 1, the HTTP password of the user is not changed in the Change Password operation from IBM Security Identity Manager. | SetHTTPPswdOnly_NO=1 or DeleteMailDB_NO=0 Note: The
value of SetHTTPPswdOnly_NO must be the opposite
of SetHTTPPswdOnly_YES . For example, if the
value SetHTTPPswdOnly_NO is 1 the
value of SetHTTPPswdOnly_YES must be 0.
|
|
|
If the value is 1, the HTTP password is changed before the user password is changed. | SetHTTPPswdFirst_YES=1 or SetHTTPPswdFirst_YES=0 Note: The
value of SetHTTPPswdFirst_YES must be the opposite
of SetHTTPPswdFirst_NO . For example, if the
value SetHTTPPswdFirst_YES is 1 the
value of SetHTTPPswdFirst_NO must be 0.
|
|
|
If the value is 1, the HTTP password is not changed before the user password is changed. | SetHTTPPswdFirst_NO=1 or SetHTTPPswdFirst_NO=0 Note: The
value of SetHTTPPswdFirst_NO must be the opposite
of SetHTTPPswdFirsty_YES . For example, if the
value SetHTTPPswdFirst_NO is 1 the
value of SetHTTPPswdFirst_YES must be 0.
|
|
|
If the value is 1, the ERUID or the User ID attribute is stored in the FullName field in the person document. | AddEruidToFullName_YES=1 or AddEruidToFullName_YES=0 Note: The
value of AddEruidToFullName_YES must be the opposite
of AddEruidToFullName_NO . For example, if the
value AddEruidToFullName_YES is 1 the
value of AddEruidToFullName_NO must be 0.
|
|
|
If the value is 1, the ERUID or the User ID attribute is not stored in the FullName field in the person document. | AddEruidToFullName_NO=1 or AddEruidToFullName_NO=0 Note: The
value of AddEruidToFullName_NO must be the opposite
of AddEruidToFullName_YES . For example, if the
value AddEruidToFullName_NO is 1 the
value of AddEruidToFullName_YES must be 0.
|
|
|
If the value is 1, all the suspended groups are included in the Not Access Server field. | UpdateServerDoc_YES=1 or UpdateServerDoc_YES=0 Note: The
value of UpdateServerDoc_YES must be the opposite
of UpdateServerDoc_NO . For example, if the value UpdateServerDoc_YES is 1 the
value of UpdateServerDoc_NO must be 0.
|
|
|
If the value is 1, the suspended groups are not included in the Not Access Server field. | UpdateServerDoc_NO=1 or UpdateServerDoc_NO=0 Note: The
value of UpdateServerDoc_NO must be the opposite
of UpdateServerDoc_YES . For example, if the
value UpdateServerDoc_NO is 1 the
value of UpdateServerDoc_YES must be 0.
|
|
| Yes | |
Specifies the file path for the certifier ID file. The certifier ID file is the default file used for the User Add operations. When you do not specify the file path for the certifier file during the user add operation, the file path from this field is used to add the user. If you specify the path for the certifier file when you add a user, the file path in this field is ignored. | CertIDPath=C:\\ID\\PS7636\\cert.id Note: The
file path separator is \\ (double backslash).
|
| Yes | |
Specifies the password of the certifier ID file. | CertIDPassword=password |
| Yes | |
The server name and the organization name for the mail template files that the adapter uses. When you do not specify a value for this registry key, the adapter uses the mail template files from the Domino Registration Server. The files for the Domino Registration Server are specified for the Domino Server registry key. The format of the name is CN=Server Name/O=org. name | MailTemplateServer=CN=PS7636/O=psl |
|
If the value is 1, the AdminP is used when you deprovision a user from IBM Security Identity Manager. | ExecAdminpOperation_YES=1 or ExecAdminpOperation_YES=0 Note: The
value of ExecAdminpOperation_YES must be the
opposite of ExecAdminpOperation_NO . For example,
if the value ExecAdminpOperation_YES is 1 the
value of ExecAdminpOperation_NO must be 0.
|
|
|
If the value is 1, the AdminP is not used when you deprovision a user from IBM Security Identity Manager. | ExecAdminpOperation_NO=1 or ExecAdminpOperation_NO=0 Note: The
value of ExecAdminpOperation_NO must be the opposite
of ExecAdminpOperation_YES . For example, if
the value ExecAdminpOperation_NO is 1 the
value of ExecAdminpOperation_YES must be 0.
|
|
|
If the value is 1, the
adapter can change the password of a user ID file in ID vault. Note: Lotus
Notes version 8.5 is required to set this value to 1.
|
IsIDVaultConfigured_YES=1 or IsIDVaultConfigured_YES=0 Note: The
value of IsIDVaultConfigured_YES must be the
opposite of IsIDVaultConfigured_NO . For example,
if the value IsIDVaultConfigured_YES is 1 the
value of IsIDVaultConfigured_NO must be 0.
|
|
|
If the value is 1, the adapter cannot change the password of a user ID file in ID vault. | IsIDVaultConfigured_NO=1 or IsIDVaultConfigured_NO=0 Note: The
value of IsIDVaultConfigured_NO must be the opposite
of IsIDVaultConfigured_YES . For example, if
the value IsIDVaultConfigured_NO is 1 the
value of IsIDVaultConfigured_YES must be 0.
|
|
|
If this attribute has value NO, the server doesl not restart after adapter is install in silent mode. This variable is IA installer specific. | USER_REQUESTED_RESTART=NO |