2 Deploying the Connector

Deploying the connector involves the following steps:

Step 1: Verifying Deployment Requirements
Step 2: Copying the Connector Files and External Code Files
Step 3: Configuring the Oracle Identity Manager Server
Step 4: Importing the Connector XML File
Step 5: Configuring SSL

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
Target system user account	Sun Java System Directory user account to which the Read, Write, Add, Delete, and Search permissions have been assigned You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. If you try to perform an operation for which the required permission has not been assigned to the user account, then the "Insufficient Privileges" message is displayed.

Item

Requirement

Oracle Identity Manager

Oracle Identity Manager release 8.5.3 or later

Target systems

Sun ONE Directory Server 5.2

Target system user account

Sun Java System Directory user account to which the Read, Write, Add, Delete, and Search permissions have been assigned

You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.

If you try to perform an operation for which the required permission has not been assigned to the user account, then the "Insufficient Privileges" message is displayed.

Step 2: Copying the Connector Files and External Code 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 `troubleshooting` directory	OIM_home/xellerate/troubleshooting
Files in the `xml` directory	OIM_home/xellerate/iPlanet/xml

To copy the external code files into the required directories:

Log on the Sun Web site at

http://java.sun.com/products/jndi/downloads/index.html
Click the Download JNDI 1.2.1 & More button.
From the table on the page that is displayed, select the LDAP Service Provider 1.2.4 check box and download the ldap-1_2_4.zip file.
Extract the ldap.jar and ldapbp.jar files from the ldap-1_2_4.zip file.
Copy the ldap.jar and ldapbp.jar files into the OIM_home/xellerate/JavaTasks directory on the Oracle Identity Manager server.

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

Step 3: Configuring the Oracle Identity Manager Server

Note:

In this guide, the term Oracle Identity Manager server refers to the computer on which Oracle Identity Manager is installed.

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.

You may require the assistance of the system administrator to change to the required input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Step 2: Copying the Connector Files and External Code Files" section, you copy files from the resources directory on the installation media into the OIM_home/xellerate/connectorResources directory. Whenever you add a new resource bundle in the 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:

In a command window, change to the OIM_home/xellerate/bin directory.
Note:
You must perform Step 1 before you perform Step 2. If you run the command described in Step 2 as follows, then an exception is thrown:
```
OIM_home/xellerate/bin/batch_file_name
```
Enter one of the following commands:
- On Microsoft Windows:
```
PurgeCache.bat ConnectorResourceBundle
```
- On UNIX:
```
PurgeCache.sh ConnectorResourceBundle
```
Note:
You can ignore the exception that is thrown when you perform Step 2.

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
```

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:

BEA WebLogic

To enable logging:
1. Add the following lines in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SJSDS=log_level
```
2. In these lines, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SJSDS=INFO
```
After you enable logging, the log information is written to the following file:
```
WebLogic_home/user_projects/domains/domain_name/server_name/server_name.log
```
IBM WebSphere

To enable logging:
1. Add the following lines in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SJSDS=log_level
```
2. In these lines, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SJSDS=INFO
```
After you enable logging, the log information is written to the following file:
```
WebSphere_home/AppServer/logs/server_name/startServer.log
```

JBoss Application Server

To enable logging:

In the JBoss_home/server/default/conf/log4j.xml file, locate or add the following lines:

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

<category name="XL_INTG.SJSDS">
   <priority value="log_level"/>
</category>

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

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

<category name="XL_INTG.SJSDS">
   <priority value="INFO"/>
</category>

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

JBoss_home/server/default/log/server.log

OC4J

To enable logging:
1. Add the following lines in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SJSDS=log_level
```
2. In these lines, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SJSDS=INFO
```
After you enable logging, the 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 File

As mentioned in the "Files and Directories That Comprise the Connector" section, the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

To import the connector XML files into Oracle Identity Manager:

Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the iPlanetResourceObject.xml file, which is in the OIM_home/xellerate/iPlanet/xml directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the iPlanet User IT resource is displayed.
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.
Click Next. The Provide IT Resource Instance Data page for a new instance of the LDAP Server IT resource type is displayed.
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.
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. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.
Click Import. The connector file is imported into Oracle Identity Manager.

After you import the connector XML file, proceed to the "Step 5: Configuring SSL" 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 Sun Java System Directory The default value is `uid=admin,ou=administrators,ou=topologymanagement,o=netscaperootAdmin`
`Admin Password`	Password of the user who has administrator rights on Sun Java System Directory
`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.` This parameter is mentioned in the "Step 5: Configuring SSL" section.
`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.` This parameter is mentioned in the "Step 5: Configuring SSL" section. Note: It is recommended that you enable SSL to secure communication with the target system.
`Last Recon TimeStamp`	Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends. Do not change the default value of 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.
`CustomizedReconQuery`	Query condition on which reconciliation must be based If you specify a query condition for this parameter, then the target system records are searched based on the query condition. If you want to reconcile all the target system records, then do not specify a value for this parameter. The query can be composed with the AND (&) and OR (\|) logical operators. Sample value: `givenname=John` For more information about this parameter, refer to the "Partial Reconciliation" section.

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

Step 5: Configuring SSL

Note:

This is an optional step of the deployment procedure.

To enable SSL communication between Oracle Identity Manager and Sun Java System Directory:

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.
Restart the Oracle Identity Manager server.
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.