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 Files

Depending on the release of Oracle Identity Manager that you use, perform the procedure:

Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

2.1 Step 1: Verifying Deployment Requirements

The following table lists the installation requirements for the connector.

Item	Requirement
Oracle Identity Manager	Oracle Identity Manager release 8.5.3.1 or later
Target systems	RSA ClearTrust 5.5 or 5.5.2
External code	The following files from the directory in which RSA ClearTrust is installed: ct_admin_api.jar ct_runtime_api.jar cleartrust.jar
Target system user account	RSA ClearTrust administrator account You provide the credentials of this user account while performing the procedure in "Defining IT Resources".

2.2 Step 2: Copying the Connector Files and External Code Files

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

Note:

For the connector files, 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:

Web Access Control/RSA ClearTrust

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

Connector File/External Code File	Destination Directory
lib/xliClearTrust.jar	OIM_HOME/xellerate/JavaTasks
lib/xliClearTrustRecon.jar	OIM_HOME/xellerate/ScheduleTask
Files in the `resources` directory on the installation media	OIM_HOME/xellerate/connectorResources
Files and directories in the `tests` directory on the installation media	OIM_HOME/xellerate/tests
Files in the `xml` directory on the installation media	OIM_HOME/xellerate/XLIntegrations/ClearTrust/xml
The following files from the `ClearTrust_installation_dir/lib` directory: ct_admin_api.jar ct_runtime_api.jar cleartrust.jar	OIM_HOME/ThirdParty
The following files in the `ClearTrust_installation_dir/lib/` directory: ct_admin_api.jar ct_runtime_api.jar	OIM_HOME/xellerate/ext

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

2.3 Step 3: Configuring the Oracle Identity Manager Server

This section discusses the following topics:

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

2.3.1 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.

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

While performing the instructions described in "Step 2: Copying the Connector Files and External Code Files", 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. An exception is thrown if you run the command described in Step 2 as follows:
```
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
```

2.3.3 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 messages that highlight the progress of the application at a 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 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 Server

To enable logging:
1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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 Application Server

To enable logging:
1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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="ADAPTERS.CTINTEGRATION">
   <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="ADAPTERS.CTINTEGRATION">
   <priority value="INFO"/>
</category>

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

JBoss_home/server/default/log/server.log

Oracle Application Server

To enable logging:
1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.XELLERATE=log_level
log4j.logger.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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
```

2.4 Step 4: Importing the Connector XML Files

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

To import the connector XML file 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 opening files is displayed.
Locate and open the RSAClearTrustResourceObject.xml file, which is in the OIM_HOME/xellerate/XLIntegrations/ClearTrust/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 ClearTrust IT resource is displayed.
Specify values for the parameters of the ClearTrust IT resource. Refer to the table in "Defining IT Resources" for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the ClearTrust 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 Administrative and User Console 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 XML file is imported into Oracle Identity Manager.
Perform the same procedure to import the remaining connector XML files. These files are in the OIM_HOME/xellerate/XLIntegrations/ClearTrust/xml directory.

After you import the connector XML files, proceed to the next chapter.

2.4.1 Defining IT Resources

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

Parameter	Description
`CTAdminUserId`	Name of the RSA ClearTrust administrator This is a required parameter.
`CTAdminPassword`	Password of the RSA ClearTrust administrator This is a required parameter.
`MachineName or IPAddress`	Host name or IP address of the computer on which the RSA ClearTrust Entitlements Server is running. This is a required parameter.
`Port`	Port number on which the RSA ClearTrust Entitlements Server is running This is a required parameter. The default value is `5601`.
`SSLMode`	SSL mode that is used to connect to the RSA ClearTrust server Note: Ensure that RSA ClearTrust is running in this mode. Otherwise, Oracle Identity Manager cannot connect to RSA ClearTrust. This is a required parameter. Note: It is recommended that you enable SSL to secure communication with the target system.
`TimeOut`	Timeout value for the connection that is established between Oracle Identity Manager and RSA ClearTrust This is a required parameter.
`Default User Group`	Default user group in RSA ClearTrust This is a required parameter.
`CaFileLocation`	Location of the CA certificate This parameter is used only with mutual authentication.
`CaPassword`	Password for the CA certificate This parameter is used only with mutual authentication.
`KsFileLocation`	Location of the keystore file This parameter is used only with mutual authentication.
`KsPassword`	Password of the keystore file This parameter is used only with mutual authentication.
`KeyAlias`	Key name that is to be used with the keystore file This parameter is used only with mutual authentication.
`PrivatePassword`	Password for the private key in the keystore file This parameter is used only with mutual authentication.
`TimeStamp`	This parameter is reserved for future use.
`CTAdmin Group`	Group to which the RSA ClearTrust administrative user belongs
`CTAdmin Role`	Role of the RSA ClearTrust administrative user
`Target Locale: Country`	Country code Default value: `US` Note: You must specify the value in uppercase.
`Target Locale: Language`	Language code Default value: `en` Note: You must specify the value in lowercase.

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

2.5 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Oracle Identity Manager Administrative and User Console.

Installing the connector on Oracle Identity Manager release 9.1.0 or later involves the procedure described in the following section. See "Running the Connector Installer" section for more information.

2.5.1 Running the Connector Installer

To run the Connector Installer:

Copy the contents of the connector installation media into the following directory:
```
OIM_HOME/xellerate/ConnectorDefaultDirectory
```
Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of Oracle Identity Manager Administrative and User Console Guide.
Click Deployment Management, and then click Install Connector.
From the Connector List list, select RSA ClearTrust RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory:
```
OIM_HOME/xellerate/ConnectorDefaultDirectory 
```
If you have copied the installation files into a different directory, then:
1. In the Alternative Directory field, enter the full path and name of that directory.
2. To repopulate the list of connectors in the Connector List list, click Refresh.
3. From the Connector List list, select RSA ClearTrust RELEASE_NUMBER.
Click Load.
To start the installation process, click Continue.

The following tasks are performed in sequence:
1. Configuration of connector libraries
2. Import of the connector Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see "Configuring Trusted Source Reconciliation" for more information.
3. Compilation of adapters
On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:
- Retry the installation by clicking Retry.
- Cancel the installation and begin again from Step 1.
If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:
1. Ensuring that the prerequisites for using the connector are addressed
  
  Note:
  At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.
  There are no prerequisites for some predefined connectors.
2. Configuring the IT resource for the connector
  
  Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.
3. Configuring the scheduled tasks that are created when you installed the connector
  
  Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.
When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 1-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See Table 1-1 for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.