2 Deploying the Connector

Deploying the connector involves the following steps:

• Step 1: Verifying Deployment Requirements

• Step 2: Configuring the Target System

• Step 3: Copying the Connector Files and External Code

• Step 4: Configuring the Oracle Identity Manager Server

• Step 5: Importing the Connector XML File

• Step 6: Configuring Reconciliation

• Step 7: Compiling Adapters

• Step 8: Configuring SSL

If you want to configure the connector for multiple installations of IBM Lotus Notes and Domino, then perform the following procedure:

• Configuring the Connector for Multiple Installations of the Target System

Step 1: Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item	Requirement
Oracle Identity Manager	Oracle Identity Manager release 8.5.3 or later
Target systems	IBM Lotus Notes and Domino Server 6.5 or later
External code	NCSO.jar Notes.jar Refer to the "Step 3: Copying the Connector Files and External Code" section for more information about these files.
Target system user account	Domino Server administrator You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.

Step 2: Configuring the Target System

You must ensure that the Domino IIOP (DIIOP) task is running.

To do this, open the IBM Lotus Notes and Domino console and run the Load DIIOP command.

If the DIIOP task were not running, then it is started after you run the command. If it were running, then a message that the task has already been started is displayed.

Step 3: Copying the Connector Files and External Code

The connector files to be copied and the directories to which you must copy them are given in the following table.

Note: The directory paths given in the first column of this table correspond to the location of the connector files in the following ZIP file on the installation media: Collaboration and Messaging Applications\IBM Lotus Notes Domino\IBM Lotus Notes Domino Rev 1.2.0.zip Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.

File in the Installation Media Directory	Destination Directory
xml\xlLotusNotesConnector.xml	OIM_home\xlclient
xml\xlLotusNotes_XellerateUser.xml	OIM_home\xlclient
lib\JavaTask\xlLotusNotesProvision.jar	OIM_home\xellerate\JavaTasks
lib\ScheduleTask\xlLotusNotesRecon.jar	OIM_home\xellerate\ScheduleTask
Files in the resources directory	OIM_home\xellerate\connectorResources
docs\B32156_01.pdf	OIM_home\xellerate\docs\LotusNotes

After you copy the connector files, copy the following files into the java_installation\jre\lib\ext directory:

• NCSO.jar (from the lotus_home\lotus\Domino\Data\domino\java directory)

• Notes.jar (from the lotus_home\lotus\Domino directory)

Here, java_installation is the JDK directory used for Oracle Identity Manager and lotus_home is the directory in which IBM Lotus Notes and Domino is installed.

Note: While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the connectorResources directory and all the JAR files mentioned in this section to the corresponding directories on each node of the cluster.

Step 4: Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note: In a clustered environment, you must perform this step on each node of the cluster.

• Changing to the Required Input Locale

• Clearing Content Related to Connector Resource Bundles from the Server Cache

Changing to the Required Input Locale

Changing to the required input locale involves installing the required fonts and setting the required input locale.

To set the required input locale:

Note: Depending on the operating system used, you may need to perform this procedure differently.

1. Open Control Panel.

2. Double-click Regional Options.

3. On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

Whenever you add a new resource bundle file in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle file, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

1. In a command window, change to the OIM_home\xellerate\bin directory.

2. Enter one of the following commands:

   
   

   Note: You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown: OIM_home\xellerate\bin\batch_file_name

   
   

   • On Microsoft Windows:

     PurgeCache.bat ConnectorResourceBundle
     
     

   • On UNIX:

     PurgeCache.sh ConnectorResourceBundle
     
     

   In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:

   OIM_home\xellerate\config\xlConfig.xml
   
   

Note: You can ignore the exception that is thrown when you perform Step 2.

Step 5: Importing the Connector XML File

To import the connector XML file into Oracle Identity Manager:

1. Open the Oracle Identity Manager Administrative and User Console.

2. Click the Deployment Management link on the left navigation bar.

3. Click the Import link under Deployment Management. A dialog box for locating files is displayed.

4. Locate and open the xlLotusNotesConnector.xml file, which is in the OIM_home\xlclient directory. Details of this XML file are shown on the File Preview page.

5. Click Add File. The Substitutions page is displayed.

6. Click Next. The Confirmation page is displayed.

7. Click Next. The Provide IT Resource Instance Data page for the LotusNotes IT resource is displayed.

8. Specify values for the parameters of the LotusNotes IT resource. Refer to the table in the "Defining IT Resources" section for information about the values to be specified.

9. Click Next. The Provide IT Resource Instance Data page for a new instance of the Lotus Notes IT resource type is displayed.

10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

    
    

    See Also: If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.

    
    

11. Click View Selections.

    The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. Remove these nodes by right-clicking each node and then selecting Remove.

12. Click Import. The connector XML file is imported into Oracle Identity Manager.

After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.

Defining IT Resources

You must specify values for the LotusNotes IT resource parameters listed in the following table.

Parameter	Description
AddBook	Specifies whether or not the server entry in the Domino Directory is updated when the ID file is created The value can be True or False. The default value is True. Domino Directory is the database that contains user personal documents, connection documents, server documents, and cross-certification files. This directory is also known as the public address book or names.nsf.
Admin	User ID of the IBM Lotus Notes and Domino server administrator
AdminPwd	Password of the administrator
CertPath	Complete file specification of the certifier ID to be used when creating IDs
CertPwd	Password of the certifier ID file
CreateMailIDFile	Specifies whether or not a mail database is created with the ID file when calling the Register New User function of IBM Lotus Notes and Domino The value can be True or False. The default value is True.
Host	Host name or IP address of the IBM Lotus Notes and Domino server
Port	TCP/IP port at which the IBM Lotus Notes and Domino server is listening The default value is 63148.
IDFilePath	Path for storing the ID files
IDType	Type of ID files to be created The value can be HIERARCHICAL or CERTIFIER. The default is 172 (HIERARCHICAL). The numeric value for CERTIFIER is 173.
IsDebug	Debug feature The value can be YES or NO. The default value is NO.
MailDBPath	Mail file path
MailOwnerAccess	Mail database ACL setting for the owner The value can be one of the following: DESIGNER (1) EDITOR (2) MANAGER (0) The default value is 0.
MailQuotaLimit	Maximum size of the user's e-mail database, in megabytes The default value is 50.
MailQuotaWarning	Size, in megabytes, at which the user's mail database issues a warning that the size limit may be exceeded The default value is 40.
MailServer	Canonical name of the server containing the user's mail file
MailSystem	User's mail system The value can be any one of the following: INOTES (3) INTERNET (4) NOTES (0) The default value is 0.
MailTemplateName	Name of the template for the design of the mail file
PasswordLength	Minimum number of characters that can be used in the password The value can be any number. The default minimum length is 5 characters.
RegLog	Name of the log file to use when creating IDs
RegServer	Name of the server to use when creating IDs and performing other registration functions
StoreAddBook	Indicates whether or not the ID file is stored in the Domino Directory of the server The value can be True or False. The default value is True.
SyncInternetPassword	Specifies whether or not the user can use the same password for both local client-based access and Web-based access to IBM Lotus Notes and Domino The value can be True or False. The default value is True.
LastReconciliationTimeStamp	For the first reconciliation run, this parameter does not hold any value. From the second time onward, this parameter stores the time at which the last reconciliation run was completed. The default value is None.
IsSecure	Specifies whether or not the SSL feature is enabled The value can be YES or NO. The default value is NO.
DenyAccessGroupName	Name of the group for users whose accounts have been disabled
triggerAdminP	Specifies whether or not the Trigger AdminP feature is enabled The value can be Yes or No. The default value is Yes.

After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

Step 6: Configuring Reconciliation

Configuring reconciliation involves the following steps:

• Configuring Trusted Source Reconciliation

• Creating the Reconciliation Scheduled Tasks

Configuring Trusted Source Reconciliation

Note: Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you import the xlLotusNotes_XellerateUser.xml file while you have another trusted source configured, then both connector reconciliations would stop working. Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.

To configure trusted source reconciliation, you must first import the XML file for trusted source reconciliation as follows:

1. Open the Oracle Identity Manager Administrative and User Console.

2. Click the Deployment Management link on the left navigation bar.

3. Click the Import link under Deployment Management. A dialog box for locating files is displayed.

4. Locate and open the xlLotusNotes_XellerateUser.xml file, which is in the OIM_home\xlclient directory. Details of this XML file are shown on the File Preview page.

5. Click Add File. The Substitutions page is displayed.

6. Click Next. The Confirmation page is displayed.

7. Click Import.

8. In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.

Then, set the value of the IsTrusted reconciliation scheduled task attribute to YES while performing the procedure described in the following section.

Creating the Reconciliation Scheduled Tasks

To create the scheduled tasks for lookup fields and user reconciliations:

1. Open the Oracle Identity Manager Design Console.

2. Expand the Xellerate Administration folder.

3. Select Task Scheduler.

4. Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.

5. For the first scheduled task, enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.

6. Ensure that the Disabled and Stop Execution check boxes are not selected.

7. In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.

8. In the Interval region, set the following schedule parameters:

   • To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.

     If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.

   • To set the task to run only once, select the Once option.

9. Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.

   
   

   See Also: Oracle Identity Manager Design Console Guide for information about adding and removing task attributes

   
   

10. Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.

11. Repeat Steps 5 through 10 to create the second scheduled task.

After you create both scheduled tasks, proceed to the "Step 7: Compiling Adapters" section.

Specifying Values for the Scheduled Task Attributes

This section provides information about the values to be specified for the following scheduled tasks:

• Lookup Fields Reconciliation Scheduled Task

• User Reconciliation Scheduled Task

Lookup Fields Reconciliation Scheduled Task

You must specify values for the following attributes of the lookup fields reconciliation scheduled task.

Note: Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.

Attribute	Description	Default/Sample Value
TargetRO	Name of the resource object	LOTUSRO
ServerName	Name of the IT resource instance that the connector uses to reconcile data	LotusNotes
LookupFieldName	Name of the group lookup field that is to be reconciled	LookUp.Lotus.Grp

After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

User Reconciliation Scheduled Task

You must specify values for the following attributes of the user reconciliation scheduled task.

Note: Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.

Attribute	Description	Default/Sample Value
TargetRO	Name of the resource object	LOTUSRO
ServerName	Name of the IT resource instance that the connector uses to reconcile data	LotusNotes
IsTrusted	Specifies whether or not reconciliation must be performed in trusted mode	YES or NO The default value is NO.
LoginNameField	Parameter whose value is used as the login name for the Xellerate User Ensure that the value of the parameter that you select is unique for each IBM Lotus Notes and Domino user.	Notes.LastName or Notes.ShortName
Notes.XellerateOrganisation	Default value for the Oracle Identity Manager Organization name This value is used to create the Xellerate User in trusted mode.	Xellerate Users

After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

Step 7: Compiling Adapters

The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

• adpLNCreateuser

• adpLNUpdateUserName

• adpUpdateUserInfo

• adpLNDeleteUser

• adpLNEnableDisable

• adpLNUpdateGrp

• adpLNUpdatePassword

You must compile these adapters before you can use them to provision accounts on the target system.

To compile adapters by using the Adapter Manager form:

1. Open the Adapter Manager form.

2. To compile all the adapters that you import into the current database, select Compile All.

   To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.

   
   

   Note: Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.

   
   

3. Click Start. Oracle Identity Manager compiles the selected adapters.

4. If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_home\xellerate\Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes. Then, restart each node.

To view detailed information about an adapter:

1. Highlight the adapter in the Adapter Manager form.

2. Double-click the row header of the adapter, or right-click the adapter.

3. Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.

Note: To compile one adapter at a time, use the Adapter Factory form. Refer to Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms.

Step 8: Configuring SSL

Note: This is an optional step of the deployment procedure. For more information about this procedure, refer to http://www-128.ibm.com/developerworks/lotus/library/ls-Java_access_2/

To set up SSL connectivity between Oracle Identity Manager and the IBM Lotus Notes and Domino server:

1. Ensure that the DIIOP and HTTP tasks are running on the IBM Lotus Notes and Domino server for SSL communication.

   
   

   Note: If you have already performed the procedure described in the "Step 2: Configuring the Target System" section, then the DIIOP task is already running.

   
   

2. On the IBM Lotus Notes and Domino server, create a key ring using the Server Certificate Admin (certsrv.nsf) database. Move the two key ring files, keyfile.kyr and keyfile.sth, to the data directory of the server.

3. Restart the DIIOP task to generate a file named TrustedCerts.class in the IBM Lotus Notes and Domino data directory. The following is the path of the data directory:

   lotus_home\Lotus\Domino\Data
   
   

   Here, lotus_home is the directory in which IBM Lotus Notes and Domino is installed.

4. Package the TrustedCerts.class file in the TrustedCerts.jar file.

5. Move the TrustedCerts.jar file to the java_installation\jre\lib\ext directory on the Oracle Identity Manager server.

Configuring the Connector for Multiple Installations of the Target System

Note: Perform this procedure only if you want to configure the connector for multiple installations of IBM Lotus Notes and Domino. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.

To configure the connector for multiple installations of the target system:

1. Create and configure one resource object per target system installation.

   The Resource Objects form is in the Resource Management folder. The LOTUSRO resource object is created when you import the connector XML file. You can use this resource object as the template for creating the remaining resource objects.

2. Create and configure one IT resource per resource object.

   The IT Resources form is in the Resource Management folder. The LotusNotes IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.

3. Design one process form for each resource object.

   The Form Designer form is in the Development Tools folder. The following process forms are created when you import the connector XML file:

   • UD_LOTUS (main form)

   • UD_LNGRP (child form)

   You can use these process forms as templates for creating the remaining process forms.

4. Create and configure one process definition for each resource object.

   The Process Definition form is in the Process Management folder. The Lotus Process process definition is created when you import the connector XML file. You can use this process definition as the template for creating the remaining process definitions.

   While creating process definitions for each target system installation, the following steps that you must perform are specific to the creation of each process definition:

   • From the Object Name lookup field, select the resource object that you create in Step 1.

   • From the Table Name lookup field, select the process form that you create in Step 3.

   • While mapping the adapter variables for the IT Resource data type, ensure that you select the IT resource that you create in Step 2 from the Qualifier list.

5. Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:

   • TargetRO

   • ServerName

   • IsTrusted

   Set the IsTrusted attribute to YES for the IBM Lotus Notes and Domino installation that you want to designate as a trusted source. You can designate either a single or multiple installations of IBM Lotus Notes and Domino as the trusted source. For the remaining IBM Lotus Notes and Domino installations, set this attribute to NO.

6. If required, modify the fields to be reconciled for the Xellerate User resource object.

When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the IBM Lotus Notes and Domino installation to which you want to provision the user.