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

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 or later
Target systems	RSA ClearTrust 5.5 or 5.52
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 the "Defining IT Resources" section.

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 the "Files and Directories That Comprise the Connector" section for more information about these files.

Connector File/External Code File	Destination Directory
lib/xliClearTrust.jar	OIM_home/xellerate/JavaTasks 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 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.

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

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

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

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

Step 4: Importing the Connector XML Files

As mentioned in the "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.

You must import the connector XML files into Oracle Identity Manager in the following sequence:

XLIClearTrust_DM.xml
XLIClearTrustEntityAdp_DM.xml
XLICTAutoSaveAdapter_DM.xml
XLIClearTrustScheduleTask_DM.xml

Caution:

If you do not import the connector XML files in the specified order, then the connector may not work.

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 locating files is displayed.
Locate and open the XLIClearTrust_DM.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 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 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 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 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.

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.