2 Deploying the Connector

Deploying the connector involves the following steps:

• Step 1: Verifying Deployment Requirements

• Step 2: Copying the Connector Files

• Step 3: Configuring the Oracle Identity Manager Server

• Step 4: Importing the Connector XML Files

• Step 5: Configuring Reconciliation

• Step 6: Compiling Adapters

• Step 7: Configuring SSL

If you want to configure the connector for multiple installations of Sun Java System Directory, 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	Sun ONE Directory Server 5.2 and Siemens HiPath Slcurity DirX 6.0 D10
Target system host platforms	The target system host platform can be any one of the following: Microsoft Windows 2000 Solaris 8 or 9
Target system user account	User account to which the Read, Write, Add, Delete, and Search rights have been assigned You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.

Step 2: Copying the Connector Files

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 directory on the installation media:

Directory Servers\Sun Java System Directory Server

Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.

Files in the Installation Media Directory	Destination Directory
lib\xliIPlanet.jar	OIM_home\xellerate\JavaTasks
Files in the resources directory	OIM_home\xellerate\connectorResources
Files in the troubleshoot directory	OIM_home\xellerate\troubleshoot
Files in the xml directory	OIM_home\xellerate\iPlanet-versionno\xml

Note:

In the destination directory path, you must change the version number specified in the directory name iPlanet-versionno depending on the actual version number of the software.

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 the JAR files to the corresponding directories on each node of the cluster.

Step 3: 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

• Enabling Logging

Changing to the Required Input Locale

Changing to the required input locale (language and country setting) 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 in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle, 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.

Enabling Logging

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

• ALL

  This level enables logging for all events.

• DEBUG

  This level enables logging of information about fine-grained events that are useful for debugging.

• INFO

  This level enables logging of informational messages that highlight the progress of the application at coarse-grained level.

• WARN

  This level enables logging of information about potentially harmful situations.

• ERROR

  This level enables logging of information about error events that may still allow the application to continue running.

• FATAL

  This level enables logging of information about very severe error events that could cause the application to stop functioning.

• OFF

  This level disables logging for all events.

The file in which you set the log level and the log file path depend on the application server that you use:

• For JBoss Application Server

  To enable logging:

  1. In the JBoss_home\server\default\conf\log4j.xml file, locate the following lines:

     <category name="XELLERATE">
        <priority value="log_level"/>
     </category>
     
     

  2. In the second XML code line, replace log_level with the log level that you want to set. For example:

     <category name="XELLERATE">
        <priority value="INFO"/>
     </category>
     
     

  After you enable logging, log information is written to the following file:

  JBoss_home\server\default\log\server.log
  
  

• For IBM WebSphere:

  To enable logging:

  1. Add the following line in the OIM_home\xellerate\config\log.properties file:

     log4j.logger.XELLERATE=log_level
     
     

  2. In this line, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     
     

  After you enable logging, log information is written to the following file:

  WebSphere_home\AppServer\logs\server_name\startServer.log
  
  

• For BEA WebLogic

  To enable logging:

  1. Add the following line in the OIM_home\xellerate\config\log.properties file:

     log4j.logger.XELLERATE=log_level
     
     

  2. In this line, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     
     

  After you enable logging, log information is written to the following file:

  WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
  
  

• For OC4J

  To enable logging:

  1. Add the following line in the OIM_home\xellerate\config\log.properties file:

     log4j.logger.XELLERATE=log_level
     
     

  2. In this line, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     
     

  After you enable logging, log information is written to the following file:

  OC4J_home\opmn\logs\default_group~home~default_group~1.log
  
  

Step 4: Importing the Connector XML Files

To import the connector XML files 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 iPlanetResourceObject.xml file, which is in the OIM_home\xellerate\iPlanet-versionno\xml 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 iPlanet User IT resource is displayed.

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

9. Click Next. The Provide IT Resource Instance Data page for a new instance of the LDAP Server 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 in the Deployment Manager – Import window. 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 file is imported into Oracle Identity Manager.

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

Defining IT Resources

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

Parameter	Description
Admin Id	DN value of the user who has administrator rights on the target Sun Java System Directory server The default value is uid=admin,ou=administrators,ou=topologymanagement,o=netscaperootAdmin
Admin Password	Password of the administrator
Server Address	IP address of the target Sun Java System Directory server
Port	Port number to connect to the target Sun Java System Directory server The default value is 389.
Root DN	Base DN where all the user operations are to be carried out The value can be o=xyz
SSL	Specifies whether or not an SSL connection is used for communication between Oracle Identity Manager and the target Sun Java System Directory server The value can be true or false. Note: It is recommended that you enable SSL to secure communication with the target system.
Last Recon TimeStamp	For the first reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
Prov Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning The default value of this parameter is AttrName.Prov.Map.iPlanet
Recon Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for reconciliation The default value of this parameter is AttrName.Recon.Map.iPlanet
Use XL Org Structure	If set to true, then the Oracle Identity Manager Organization structure is used during provisioning and reconciliation. If set to false, then the value of the Organization field in the process form is used for provisioning and the organization or container in the target Oracle Internet Directory is used for reconciliation.

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

Step 5: Configuring Reconciliation

Configuring reconciliation involves the following steps:

• Configuring Trusted Source Reconciliation

• Creating the Reconciliation Scheduled Tasks

• Configuring the Lookup Definition for Reconciliation with Siemens HiPath Slcurity DirX

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 iPlanetXLResourceObject.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 iPlanetXLResourceObject.xml file, which is in the OIM_home\xellerate\iPlanet-versionno\xml 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 TrustedSource reconciliation scheduled task attribute to True 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 6: Compiling Adapters" section.

Specifying Values for the Scheduled Task Attributes

This section provides information about the attribute 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
LookupCodeName	Name of the lookup definition to which values are to be reconciled	The value can be any one of the following: For groups: Lookup.IPNT.UserGroup For roles: Lookup.IPNT.Role
ITResourceName	Name of the IT resource for setting up a connection with the Sun Java System Directory server	iPlanet User
SearchContext	Search context to be used for searching for users	DC=mycompany,DC=com
ObjectClass	Name of the group object class	The value can be any one of the following: For groups: groupOfUniqueNames For roles: ldapsubentry
CodeKeyLTrimStr	String value for left-trimming the value obtained from the search If there is nothing to be trimmed, then specify the value [NONE].	cn= or uid=
CodeKeyRTrimStr	String value for right-trimming the value obtained from the search If there is nothing to be trimmed, then specify the value [NONE].	,DC=mycompany,DC=com
ReconMode	Specify REFRESH to completely refresh the existing lookup. Specify UPDATE to update the lookup with the new values.	REFRESH or UPDATE (specified in uppercase)
AttrType	Attribute type of group, role, or organization	The value can be any one of the following: For groups: cn For roles: cn

After you specify values for these scheduled 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
ITResourceName	Name of the IT resource for setting up a connection with the Sun Java System Directory server	iPlanet User
ResourceObjectName	Name of the resource object in which users are reconciled	iPlanet User
XLDeleteUsersAllowed	If this attribute is set to True, then the Delete reconciliation event is started. Users who are deleted from the target system are removed from Oracle Identity Manager. This requires all the users on the target system to be compared with all the users in Oracle Identity Manager. If this attribute is set to False, then users deleted from the target system are not deleted from Oracle Identity Manager. Note: This process affects performance.	True
UserContainer	DN value from where the users are reconciled from the target system to Oracle Identity Manager	ou=user
TrustedSource	Configurable option for trusted reconciliation The value can be True or False.	False
Xellerate Type	Default Xellerate Type for the Xellerate User	End-User Administrator
Password	Default password for the Xellerate User	Dummy123
Organization	Default organization for the Xellerate User	Xellerate Users
Role	Default role for the Xellerate User	Consultant
IsIPlanetTarget	Specifies whether the target system is Sun Java System Directory or Siemens HiPath Slcurity DirX	For Sun Java System Directory, specify true as the value of this attribute. For Siemens HiPath Slcurity DirX, do not specify any value for this attribute. Leave the field blank.

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

Configuring the Lookup Definition for Reconciliation with Siemens HiPath Slcurity DirX

If you are using Siemens HiPath Slcurity DirX as the target system, then you must make the following change in the AttrName.Recon.Map.iPlanet lookup definition:

See Also:

Oracle Identity Manager Design Console Guide for information about modifying lookup definitions

1. In the Design Console, open the AttrName.Recon.Map.iPlanet lookup definition.

2. In this lookup definition, search for the ldapUserDisableAttr code key. The current decode value of this code key is nsaccountlock.

3. Change the decode value to activeEntry.

4. Save the changes.

Step 6: Compiling Adapters

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

• iPlanet Create User

• iPlanet Delete User

• iPlanet Modify User

• iPlanet Move User

• iPlanet Add User to Group

• iPlanet Remove User from Group

• iPlanet Add Role to User

• iPlanet Remove Role from User

• iPlanet PP String

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.

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 7: Configuring SSL

Note:

This is an optional step of the deployment procedure.

To enable SSL connectivity between the connector and the target Sun Java System Directory server:

1. Import the certificate from the target system into the JSDK (the JSDK that is used during installation of Oracle Identity Manager) cacerts keystore as follows:

   keytool -import –alias alias_name -file certificate_file_name_with_complete_path –keystore java_home\jre\lib\security\cacerts
   
   

   Here, java_home is the directory in which JDK is installed.

2. Restart the Oracle Identity Manager server.

3. In the iPlanet User IT Resource:

   • Set the SSL parameter value to true.

   • Set the Port parameter value to the SSL port number. Typically, this number is 636.

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 Sun Java System Directory. 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 for each target system installation.

   The Resource Objects form is in the Resource Management folder. The iPlanet User 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 for each resource object.

   The IT Resources form is in the Resource Management folder. The iPlanet User 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_IPNT_USR (main form)

   • UD_IPNT_ROL (child form for multivalue attributes)

   • UD_IPNT_GRP (child form for multivalue attributes)

   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 iPlanet User 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 5: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:

   • ITResourceName

   • ResourceObjectName

   • TrustedSource

   Set the TrustedSource attribute to True for the Sun Java System Directory installation that you want to designate as a trusted source. You can designate either a single or multiple installations of Sun Java System Directory as the trusted source. For the remaining Sun Java System Directory installations, set this attribute to False.

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 Sun Java System Directory installation to which you want to provision the user.