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 Files
Step 4: Configuring the Oracle Identity Manager Server
Step 5: Importing the Connector XML File
Step 6: 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	Oracle Internet Directory 9.x (9.2.0.1) or 10x
Target system user account	User account to which the BROWSE, ADD, DELETE, READ, WRITE, and SEARCH rights 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 Access Rights" message is displayed.

Item

Requirement

Oracle Identity Manager

Oracle Identity Manager release 8.5.3 or later

Target systems

Oracle Internet Directory 9.x (9.2.0.1) or 10x

Target system user account

User account to which the BROWSE, ADD, DELETE, READ, WRITE, and SEARCH rights 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 Access Rights" message is displayed.

Step 2: Configuring the Target System

You must add a custom object class and custom attribute to the Oracle Internet Directory schema for the provisioning and reconciliation of user roles.

To add a custom object class and custom attribute:

Ensure that Oracle Internet Directory is running.
Copy the contents of the Batch/custom directory from the installation media ZIP file to a directory on the target Oracle Internet Directory server.
Using any text editor, open the custom.bat file.

In the commands listed in the custom.bat file, provide the host name, port, and Oracle Internet Directory superuser DN and password.

The following is the syntax for providing these values:

ldapmodify -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customRoleOccupant.ldif
ldapadd -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customIndex.ldif
ldapmodify -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customOrganizationalRole.ldif

For example:

ldapmodify -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customRoleOccupant.ldif
ldapadd -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customIndex.ldif
ldapmodify -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customOrganizationalRole.ldif

Run the custom.bat file.
Open Oracle Directory Manager and click Schema Management in the left pane. The details of all schema elements are displayed in the right pane. Check if the customOrganizationalRole object class and customRoleOccupant attributes have been added to the schema.

Step 3: 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/Oracle Internet Directory

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
Files in the `Batch/custom` directory	Refer to the "Step 2: Configuring the Target System" section for instructions on copying these files.
lib/xliOID.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/OID/xml

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 4: 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 performing the following procedures:

Note:

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

Customizing the xlconfig.xml File
Changing to the Required Input Locale
Clearing Content Related to Connector Resource Bundles from the Server Cache
Enabling Logging

Customizing the xlconfig.xml File

In the xlconfig.xml file, you must provide a higher value, 50,000 or more, for the checkouttimeout attribute. This XML file is in the OIM_home/xellerate/config directory. You must modify the checkouttimeout attribute value to ensure that the connector XML files are correctly imported.

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 3: 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.OID=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.OID=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.OID=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.OID=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.OID">
   <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.OID">
   <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.OID=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.OID=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 5: 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 file:

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 oimOIDUser.xml file, which is in the OIM_home/xellerate/OID/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 OID Server IT resource is displayed.
Specify values for the parameters of the OID Server IT resource. Refer to the table in the "Defining IT Resources" section for 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.
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 XML file is imported into Oracle Identity Manager.

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

Defining IT Resources

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

Parameter	Description
`Admin Id`	DN value of the user who has administrator rights on the Oracle Internet Directory server Sample value: `cn=Admin,ou=People, o=xyz`
`Admin Password`	Password of the user who has administrator rights on the target Oracle Internet Directory server
`Server Address`	IP address of the Oracle Internet Directory server
`Port`	Port number to connect to the Oracle Internet Directory server Sample value: `389`
`Root DN`	Base DN on which all the user operations are to be carried out Sample value: dc=host_name, dc=com Here, `host_name` is the host name under which Oracle ConText is created.
`SSL`	If this parameter is set to `true,` then SSL is used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. In this case, the authentication certificate of the Oracle Internet Directory server must be imported into the Oracle Identity Manager server. If this parameter is set to `false,` then SSL is not used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. Note: It is recommended that you enable SSL to secure communication with the target system.
`Prov Attribute Lookup Code`	Name of the lookup definition that has the target attribute mappings required for provisioning The value must be `AttrName.Prov.Map.OID`.
`Recon Attribute Lookup Code`	Name of the lookup definition that has the target attribute mappings required for reconciliation The value must be `AttrName.Recon.Map.OID`.
`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.
`Last Recon TimeStamp`	For the first reconciliation run, the timestamp 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. You do not need to provide a value for this parameter. Sample value: `20060524110907Z`
`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: `cn=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 6: Configuring SSL

Note:

This is an optional step of the deployment procedure.

To set up SSL connectivity between Oracle Identity Manager and the Oracle Internet Directory server:

Export the Oracle Internet Directory server certificate using Wallet Manager.
Check if the Oracle Internet Directory server is listening at the SSL port. If it is not, then set it to the SSL port (typically, the default SSL port is 636). Then, restart the server.
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
```
Restart the Oracle Identity Manager server.
In the OID Server IT resource definition:
- Set the SSL parameter value to true.
- Set the Port parameter value to the SSL port number. Typically, this number is 636.