Complete these tasks to get the driver installed, configured, and running. (If you are upgrading the driver, see Section 3.0, Upgrading.)
Section 2.4.1, Installing the Driver Shim
This procedure refers to the others in this section, to show when they should be completed.
Section 2.4.2, Creating a Driver Object and Importing the Driver Configuration
Section 2.4.3, Configuring Database Replication Using Ndsrep
Most installations require some customization after installation to handle certification. Refer to Section 4.0, Customizing the Driver for more information.
Install the Remote Loader.
To install the driver shim, it is recommended you run the driver using the Remote Loader, even if the driver is running on the same machine as Identity Manager.
In the installation, choose Connected System Server, as described in
Setting Up Remote Loaders
in the
Novell Identity Manager 3.0.1 Administration Guide
.
The necessary files for the driver shim are installed in the \Novell\RemoteLoader and \Novell\RemoteLoader\lib directories.
You can install the driver shim at the same time you install the Metadirectory engine, or after.
To run the driver locally on the same machine as the Metadirectory engine, run the Identity Manager installation program and select the Identity Manager Driver for Lotus Notes.
Instructions are in
Managing Identity Manager Drivers
in the
Novell Identity Manager 3.0.1 Administration Guide
.
To run the driver remotely, install the driver shim and the Remote Loader on the system where you want to run the driver. Instructions are in
Setting Up a Connected System
in the
Novell Identity Manager 3.0.1 Administration Guide
Manually copy the following files to set up the driver.
Make sure that the Domino shared libraries directory (for example, c:\lotus\domino) is in the Windows system path, and reboot the computer to make sure this step becomes effective.
Without this directory in the Windows system path, the JVM* might have difficulty locating the Domino shared libraries required by Notes.jar, such as nlsxbe.dll.
If the Domino server requires databases to be signed, use a Notes client or Domino Administrator to sign dsrepcfg.ntf with your Domino server’s server ID.
After installation, create a driver object as explained in Section 2.4.2, Creating a Driver Object and Importing the Driver Configuration.
Set passwords for the driver and Remote Loader for the initial startup of the Remote Loader.
These passwords must be the same as the Driver Password and Remote Password you specified when importing the driver configuration, as described in Section 2.4.2, Creating a Driver Object and Importing the Driver Configuration.
Start the driver using iManager.
In iManager, select .
Locate the driver in its driver set by searching the entire tree, or specify a container and click .
Click the driver status indicator in the upper-right corner of the driver icon, then click
Enter the password for the Notes user that you are using for the driver, if you are prompted to do so. This prompt appears only the first time you start the driver, and whether it appears depends on your driver configuration.
When the driver starts for the first time, it does the following:
Searches for the Domino Server (specified in the driver parameters at import time)
Opens dsrepcfg.nsf. If that file does not exist, the driver creates dsrepcfg.nsf automatically, using the dsrepcfg.ntf database template that is provided with the driver.
Writes to the Publisher parameters and data specifying an appropriate update database file (usually named ndsrep.nsf), so that ndsrep can read them.
IMPORTANT:If multiple notes.ini files exist on the machine running the driver, ensure the NotesDriverShim uses the correct .ini by placing its directory in the OS search path. If the driver shim initializes with the wrong notes.ini file, the driver shim cannot open dsrepcfg.ntf.
If dsrepcfg.ntf is not found, or the initial dsrepcfg.nsf creation process fails, then the Publisher channel shuts down, and you cannot complete Step 9.
Ensure that the driver shim initializes properly by modifying the Windows system path to find the appropriate notes.ini file.
At the Domino Console, start the ndsrep task:
load ndsrep instance
The instance must be the driver name, or a unique instance name set up for this driver. If the name of your driver includes spaces, then you must put quotes around the name. After ndsrep is loaded, all TELL commands are issued to this instance of ndsrep using the instance name.
A task named DirXML or a similar name is now displayed in the Notes Task Viewer.
After the initial configuration and startup has been validated, update the Domino server's notes.ini file so that ndsrep is loaded automatically.
For example:
ServerTasks=Update,Replica,Router,AMgr,AdminP,ndsrep notesdrv1, CalConn,Sched,HTTP,IMAP,POP3
If the name of your driver includes spaces, then you must put quotes around the name.
After the first successful startup, the Notes driver and ndsrep can be launched in any order that is convenient for your particular configuration.
For more information about ndsrep, see Section 2.4.3, Configuring Database Replication Using Ndsrep.
Activate the driver, as explained in Section 2.4.5, Activating the Driver.
Data synchronized by the driver should not be used outside of a test environment if you have not purchased the driver.
If you want to synchronize all objects at once, you must initiate the process as explained in Section 2.4.4, Migrating and Resynchronizing Data.
Otherwise, synchronization takes place on an object-by-object basis, the next time a change is made to the individual object.
Most installations require some customization after installation to handle certification. Refer to Section 4.0, Customizing the Driver for more information.
After installing Identity Manager, install the driver shim and the Remote Loader on the system where you want to run the driver.
For AIX, Linux, and Solaris, you must run the driver using the Remote Loader, even if the driver is running on the same machine as Identity Manager.
In the installation, choose Connected System Server, as described in
Setting Up Remote Loaders
in the
Novell Identity Manager 3.0.1 Administration Guide
.
The necessary files for the driver shim are installed in /usr/lib/dirxml.
Make sure that /usr/lib/dirxml/classes/Notes.jar is linked to the correct directory for your environment.
For example, enter the following:
ls -l /usr/lib/dirxml/classes/Notes.jar
The link should be something like the following:
/usr/lib/dirxml/classes/Notes.jar linked to /opt/lotus/notes/latest/linux/Notes.jar
Make sure you have created a user to run the Remote Loader and the driver, as described in Creating Lotus Notes Accounts and Groups.
You cannot run Remote Loader for the Notes driver using root.
Create a driver object as explained in Creating a Driver Object and Importing the Driver Configuration. Do not start the driver yet.
Use a Notes client or Domino Administrator to sign dsrepcfg.ntf with your Domino server's server ID.
Copy the following files from where they are installed ( /usr/lib/dirxml/rules/notes by default), to the location where you intend to launch your driver on the Domino server, such as /local/notesdata, /home/notes, or /user/bin. You might want this location to be in your execution search path.
These three sample scripts and the sample configuration file are provided to demonstrate how to launch the driver. You can start the Remote Loader for the driver using rdxml.startnotes, and stop the Remote Loader for the driver using rdxml.stopnotes.
The sample scripts work in a variety of situations. If they do not work in your environment, you might need to edit them appropriately. The sample scripts produce a Remote Loader trace log for the driver that can be used for troubleshooting.
Modify the scripts and configuration file to fit to your environment, as described in the table in Step 6.
Make sure that the three scripts noted in Step 6 have file access for execution (for example, rwxr-xr-x).
Set passwords for the driver and Remote Loader for the initial startup of the Remote Loader.
For example,
cd driver_script_directory ./rdxml.startnotes -sp driver_password remote_loader_password
These passwords must be the same as the Driver Password and Remote Password you specified when importing the driver configuration, as described in Section 2.4.2, Creating a Driver Object and Importing the Driver Configuration.
Use rdxml.startnotes to start Remote Loader for the driver.
For example,
cd driver_script_directory
./rdxml.startnotes
The driver_script_directory should be the directory where you placed the files in Step 6.
Start the driver using iManager.
In iManager, select > .
Locate the driver in its driver set.
Click the driver status indicator in the upper right corner of the driver icon, then click .
When the driver starts the first time, it does the following:
Searches for the Domino Server (specified in the driver parameters at import time)
Opens dsrepcfg.nsf. If that file does not exist, the driver creates dsrepcfg.nsf automatically, using the dsrepcfg.ntf database template that is provided with the driver.
Writes to dsrepcfg.nsf the Publisher parameters and data specifying an appropriate update database file (usually named ndsrep.nsf), so that ndsrep can read them.
NOTE:If dsrepcfg.ntf is not found, or this initial dsrepcfg.nsf creation process fails, then the Publisher channel shuts down, and Step 12 cannot be completed.
At the Domino Console, start the ndsrep task:
load ndsrep instance
The instance must be the driver name, or a unique instance name set up for this driver. If the name of your driver includes spaces, then you must put quotes around the name. After ndsrep is loaded, all TELL commands are issued to this instance of ndsrep using the instance name.
A task named DirXML or a similar name is now displayed in the Notes Task Viewer.
After the initial configuration and startup has been validated, update the Domino notes.ini file so that ndsrep is loaded automatically.
For example:
ServerTasks=Update,Replica,Router,AMgr,AdminP,ndsrep notesdrv1, CalConn,Sched,HTTP,IMAP,POP3
If the name of your driver includes spaces, then you must put quotes around the name.
After the first successful startup, the Notes driver and ndsrep can be launched in any order that is convenient for your particular configuration.
Activate the driver, as explained in Section 2.4.5, Activating the Driver.
Data synchronized by the driver should not be used outside of a test environment if you have not purchased the driver.
If you want to synchronize all objects at once, you must initiate the process as explained in Section 2.4.4, Migrating and Resynchronizing Data.
Otherwise, synchronization takes place on an object-by-object basis, the next time a change is made to the individual object.
Most installations require some customization after installation to handle certification. Refer to Section 4.0, Customizing the Driver for more information.
For troubleshooting tips, see Troubleshooting Installation.
For Windows:
The first time the driver runs, it searches for the Domino Server (specified in the driver parameters at import time), and tries to open dsrepcfg.nsf to write the publisher parameters that ndsrep reads. If dsrepcfg.nsf does not exist, the NotesDriverShim attempts to create dsrepcfg.nsf using the database template dsrepcfg.ntf that ships with the driver.
If dsrepcfg.nsf is successfully created, and contains data specifying an appropriate update database file (usually named ndsrep.nsf), then you can load ndsrep successfully at the Domino Console.
If dsrepcfg.ntf is not found, or this initial dsrepcfg.nsf creation process fails, then the Publisher channel shuts down, and you can’t load the ndsrep task at the Domino console.
You can use a Notes client to create the dsrepcfg.nsf database using the dsrepcfg.ntf template. After doing so, modify the ACL so that the Notes driver user has manager-level access to the database.
For AIX, Linux, and Solaris:
If you upgrade Domino after installing the driver, you need to do one of the following:
Check the following symbolic links, and re-create them manually if necessary.
Table 2-1 Links To Check
The variable your_platform represents the operating system. The following table shows the folder names:
Back up certain files, and then reinstall the driver. Reinstalling the driver shim re-creates the symbolic links, but it overwrites certain files. If you have made changes to them, you need to make a backup.
Back up the following files:
rdxml.startnotes rdxml.stopnotes findDomino rdxml.confignotes (or wherever your configuration is stored)
After reinstalling the driver shim, copy the backups to their original location.
The sample scripts provided ( rdxml.startnotes, rdxml.stopnotes, findDomino) produce a Remote Loader trace log for the driver that can be used for troubleshooting.
Import the driver configuration file to create all necessary eDirectory objects, such as policies, style sheets, and filters, for basic driver configuration. Then you can modify the configuration to fit your specific business needs.
Follow the instructions in
Creating a Driver Object
in the
Novell Identity Manager 3.0.1 Administration Guide
.
Provide the following information and finish the wizard, then start the driver as described in Section 2.4.1, Installing the Driver Shim.
The sample driver configuration uses a new feature, flexible prompting, to reduce complexity when importing the configuration. If you choose to install the driver for use with the Remote Loader, an additional page is displayed in the wizard where you provide information for those features.
Table 2-3 Setting Up Role-Based Entitlements
|
Import Prompt |
Description |
|---|---|
|
Notes User ID |
Enter the Notes User ID this driver will use for Notes Authentication (in fully qualified canonical form, such as cn=Notes Driver/o=Organization). This user ID needs administrative rights to the Input database as well as the Output database. We recommend that this ID be specifically created for the driver and used only by the driver. This prevents the driver from responding to changes made to Notes when this user is used. |
|
Notes User ID File |
Enter the full path (on the Domino Server) for the Notes User ID file associated with the Notes User this driver will use for Notes Authentication. |
|
Notes User Password |
Enter the password for the Notes User ID this driver will use when authenticating to Notes (for the above user ID file). |
|
Domino Server |
Enter the Name of the Domino server this driver will authenticate to (in fully qualified canonical form, such as cn=NotesServer/o=Organization). |
|
Notes Server ID File |
Enter the full path for the Notes Server ID file associated with the Notes Server this driver will authenticate to. |
|
Default Notes Certifier ID File |
Enter the full path (on the Domino server) for the Default Notes Certifier ID file the driver will use at the default certifier. This is usually the root certifier, but can be any certifier with adequate access. |
|
Notes Fully Qualified Default Certifier Name |
Enter the default Fully Qualified (typed) Notes Certifier name as found in the Notes Address Book ( /o=acme) |
|
Notes Default Certifier Name |
Enter the default Notes Certifier name (typeless) as found in the Notes Address Book ( /acme) |
|
Default Notes Certifier Password |
Enter the password for the Default Notes Certifier ID this driver will use when certifying new users. This password is secured using the Named Passwords feature. See Section 4.3, Using Named Passwords. |
|
Notes Organization Name |
Enter the name of the Notes Organization (This is usually the o= at the root of the tree). |
|
Notes Domain |
Enter the name of the Notes Domain. |
|
Target Notes Database |
Enter the relative path and file name (on the Domino server) for the target Notes Database. The path should be relative to the Domino server’s data directory. |
|
Is this database a Notes Address Book? |
This driver has the capability of interfacing with different Notes databases. |
|
Notes Changelog Database |
Enter the relative path and file name (on the Domino server) for the Notes Changelog Database. This file is created by ndsrep. The path should be relative to the Domino server’s data directory. |
|
Certify new Notes Users? |
Whether the driver should certify users added to Notes on the Subscriber channel. |
|
Notes ID Storage Path |
Enter the path (on the Domino server) where the driver should create new user ID files. |
|
Notes Certification Log Database |
Enter the relative path and file name (on the Domino server) for the Notes Certification Log Database. The path should be relative to the Domino server’s data directory. |
|
Update Address Book with user certifications? |
Whether Notes should update the server entry in the Address Book when a new user is certified in Notes on the Subscriber channel. |
|
Store User ID files in Notes Address Book? |
Whether Notes should store new user IDs in the address book when certifying users added to Notes on the Subscriber channel. |
|
Is the Domino Server a North American Server? |
Is the Domino server this driver is binding to when certifying new users a North American Domino server? (This affects encryption levels.) Choose Yes for 128-bit encryption. |
|
ID File Expiration Term |
Enter the expiration term (in years) for ID files created by the driver when certifying users added on the Subscriber channel. |
|
Notes Password Strength Value: |
Enter the minimum password strength for new Notes user IDs (0 - 16). |
|
Default Notes User ID Password: |
Enter the default password for new Notes user IDs. |
|
Default Notes HTTP Password |
Enter the default HTTP password for new Notes users. |
|
Create Mail File? |
Whether the driver should create a mail file for users certified to Notes on the Subscriber channel. |
|
Mail Database Storage Path: |
Enter the relative path where the driver should create new Mail databases. The path should be relative to the Domino Data directory. |
|
Notes Mail Database Template |
Enter the relative path and filename (on the Domino server) for the Notes Mail Database Template this driver will use when creating new mail databases. The path should be relative to the Domino server’s data directory. |
|
Notes Mail Server |
Enter the Name of the Notes Mail Server this driver will create new mail databases on (in fully qualified canonical form, such as cn=NotesServer/o=Organization). |
|
Internet Mail Domain |
Enter the Internet Mail Domain to be used when generating Internet e-mail addresses. |
|
Deny Access Group Universal Note ID |
Enter the Notes Universal ID for the Deny Access Group. This can be found on the Properties sheet for the Group in the Notes Client (32 characters long). |
|
Publisher Channel Poll Rate |
Enter the polling interval (in seconds) for how often the publisher channel will check the change log for updates. |
|
Publisher placement destination path for USERS |
Enter the eDirectory path where eDirectory users will be created. |
|
Publisher placement destination path for GROUPS |
Enter the eDirectory path where eDirectory groups will be created. |
|
Subscriber placement source path for USERS |
Enter the eDirectory path (subtree root) where user changes will be detected. |
|
Subscriber placement source path for GROUPS: |
Enter the eDirectory path (subtree root) where group changes will be detected. |
|
Detect Event Loop Back? |
Select Yes to prevent event loopback from occurring, or No to allow event loopback. |
|
NDSREP Schedule Units |
Enter the schedule units for the ndsrep polling interval. |
|
NDSREP Schedule Value |
Enter the schedule value for the ndsrep polling interval. |
|
DNFormat |
Enter the distinguished name format used by the Publisher channel. |
|
NDSREP Domino Console Trace Setting |
Enter the Domino console trace setting. |
|
Check Attributes |
Whether all attributes shoulc be checked for each object event. |
|
Write Time Stamps |
Whether driver time stamps should be written to each synchronized object. |
|
Password Failure Notification User |
Enter the user’s name who should be notified in case of password failure. |
|
Enable Entitlement features |
Select Yes if you are using the Entitlements Driver and want to include the entitlement features provided by this driver configuration. This is a design decision. Don't select Yes for this option unless you have reviewed the information about Entitlements in the Novell Identity Manager 3.0.1 Administration Guide . |
|
Force Remote Loader Connection |
Configure the driver for use with the Remote Loader service by selecting Remote, or select Local to configure the driver for local use. For information on how to decide, see Section 2.1, Where to Install the Driver. |
|
Remote Host Name and Port |
Remote driver configuration only. Enter the Host Name or IP address and port number where the Remote Loader Service has been installed and is running for this driver. The default port is 8090. |
|
Driver Password |
Remote driver configuration only. The Driver object password is used by the Remote Loader to authenticate itself to the Metadirectory server. It must be the same password that is specified as the Driver object password on the Identity Manager Remote Loader. |
|
Remote Password |
Remote driver configuration only. The Remote Loader password is used to control access to the Remote Loader instance. It must be the same password that is specified as the Remote Loader password on the Identity Manager Remote Loader. |
Complete the following sections to configure replication using ndsrep:
Review the information about ndsrep and starting the driver in the steps in Section 2.4.1, Installing the Driver Shim.
Make sure you have copied the necessary files for your platform, as described in Section 2.4.1, Installing the Driver Shim.
(Windows only) Add c:\lotus\domino (or the appropriate Domino executable folder) to your system path, then reboot the computer.
Before trying to load ndsrep, make sure that the Identity Manager Driver for Lotus Notes has been started at least once.
You always load and run ndsrep at the server console on the Domino server. The ndsrep program creates an output database (by default, ndsrep.nsf), detects changes in the address book in the Domino server (or other Notes database), and copies these changes to the output database.
Loading ndsrep: Load ndsrep in the Domino Server console.
Add ndsrep to the ServerTasks = statement in notes.ini and restart the Domino server,
For example:
ServerTasks=Update,Replica,Router,AMgr,AdminP,ndsrep notesdrv1, CalConn,Sched,HTTP,IMAP,POP3
or
Type the following in the Notes Server Console window:
load ndsrep instance
In either case, if the name of your driver includes spaces, then you must put quotes around the name.
Controlling ndsrep: Use the TELL commands described in the table.
The following ndsrep TELL commands allow for immediate ndsrep actions. These commands are not stored; ndsrep simply executes the action.
You can run multiple instances of ndsrep to support multiple drivers running against a single Domino server. You must specify the appropriate driver instance name as a parameter when loading ndsrep. By default, this instance name is the name of the driver.
If the name of your driver includes spaces, then you must put quotes around the name.
Consider the following important issues with setting up ndsrep and multiple instances:
To load ndsrep, you must use the appropriate instance name:
load ndsrep instance
ndsrep is loaded and referenced using TELL commands by the value of instance.
By default, ndsrep stores configuration data for instances in a common Notes database ( dsrepcfg.nsf).
When modifying notes.ini to auto load multiple instances of ndsrep, simply insert ndsrep instance multiple times on the ServerTask line of notes.ini.
For example:
ServerTasks=Update,Replica,Router,AMgr,AdminP, ndsrep notesdrv1,ndsrep notesdrv2,CalConn,Sched,HTTP,IMAP,POP3
For custom configurations, you can tell ndsrep to utilize a different configuration database. To do so, use the ndsrep configuration parameter and load ndsrep using the -f filename parameter as noted in ndsrep configuration database and ndsrep configuration instance in the parameters table in Section 4.0, Customizing the Driver
Identity Manager synchronizes data as the data changes. If you want to synchronize all data immediately, you can choose from the following options:
Migrate Data from eDirectory: Allows you to select containers or objects you want to migrate from the Identity Vault to an application. When you migrate an object, the Metadirectory engine applies all of the Matching, Placement, and Create rules, as well as the Subscriber filter, to the object.
Migrate Data into eDirectory: Allows you to define the criteria Identity Manager uses to migrate objects from an application into Novell the Identity Vault. When you migrate an object, the Metadirectory engine applies all of the Matching, Placement, and Create rules, as well as the Publisher filter, to the object. Objects are migrated into the Identity Vault using the order you specify in the Class list.
Synchronize: The Metadirectory engine looks in the Subscriber class filter and processes all objects for those classes. Associated objects will be merged. Unassociated objects are processed as Add events.
To use one of the options explained above:
In iManager, select > .
Locate the driver set containing the Notes driver, then double-click the driver icon.
Click the appropriate migration button.
Activation must be completed within 90 days of installation, or the driver will not run.
For activation information, refer to
Activating Novell Identity Manager Products
in the
Identity Manager 3.0.1 Installation Guide
.