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 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 system	Oracle e-Business Suite 11.5.10, 12.0.1
External code	JDBC class library (`classes12.jar`)
Target system user account	APPS user with full privileges You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. If this user account is not assigned the specified privileges, then one of the following error message is thrown when Oracle Identity Manager tries exchange data with the target system: `table or view does not exist` `insufficient privileges`

Step 2: Configuring the Target System

For this connector, you do not need to perform any configuration steps on the target system.

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:

Enterprise Applications/Oracle e-Business/Oracle e-Business Employee Reconciliation

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
lib/ScheduleTask/xlReconOraHREmp.jar	OIM_home/xellerate/ScheduleTask
Files in the `resources` directory	OIM_home/xellerate/connectorResources
Files in the `test/config` directory	OIM_home/xellerate/XLIntegrations/OracleEmpRecon/config
Files in the `xml` directory	OIM_home/xlclient

Copy the JDBC class library (classes12.jar) from the oracle_home/ora92/jdbc/lib/classes12.jar directory to the OIM_home/xellerate/ThirdParty directory. Here, oracle_home is the directory in which Oracle9i Database is installed. For example, C:\Oracle.

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

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. Then, restart each node.

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 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 depends on the application server that you use:

BEA WebLogic

To enable logging:
1. Add the following line in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.Adapter.OracleEmpRecon=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.OracleEmpRecon=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
```
IBM WebSphere

To enable logging:
1. Add the following line in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.Adapter.OracleEmpRecon=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.OracleEmpRecon=INFO
```
After you enable logging, log information is written to the following file:
```
WebSphere_home/AppServer/logs/server_name/startServer.log
```
JBoss Application Server

To enable logging:
1. In the JBoss_home/server/default/conf/log4j.xml file, locate the following lines:
```
<category name="Adapter.OracleEmpRecon">
   <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="Adapter.OracleEmpRecon">
   <priority value="INFO"/>
</category>
```
After you enable logging, log information is written to the following file:
```
JBoss_home/server/default/log/server.log
```
OC4J

To enable logging:
1. Add the following line in the OIM_home/xellerate/config/log.properties file:
```
log4j.logger.Adapter.OracleEmpRecon=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.OracleEmpRecon=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 5: Importing the Connector XML File

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 oracleHRResAdp.xml file, which is in the OIM_home/xlclient directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitution page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the Oracle HR IT resource is displayed.
Specify values for the parameters of the Oracle HR IT resource. Refer to the table given 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 Oracle HR 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 next chapter.

Defining IT Resources

You must specify values for the following Oracle HR IT resource parameter.

Parameter	Description
`Admin`	User ID to connect to the Oracle e-Business Employee Reconciliation database The default value is `Apps.`
`AdminCredentials`	Password of the administrator
`Host`	Host name or IP address of the Oracle e-Business Employee Reconciliation database
`OracleHREmp.Organization Name`	Default value for the Oracle Identity Manager Organization name This value is used to create the Xellerate User in trusted mode. The default value is `Xellerate Users.`
`Port`	TCP/IP port at which the Oracle e-Business Employee Reconciliation server is listening The default value is `1521`.
`isSecure`	This parameter is meant for use in a future release of the connector. Do not change the default value.
`SID`	SID for the Oracle e-Business Employee Reconciliation database
`TrustedTimeStamp`	This parameter is used for trusted source reconciliation. Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends. The default value is `0.` The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the `TimeStamp` parameter value for the date 31-Jan-2006, run the following SQL query: SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual; When you specify the output of this query as the value of the `TimeStamp` parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.
`NonTrustedTimeStamp`	This parameter is used for nontrusted source reconciliation. Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends. The default value is `0.` The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the `TimeStamp` parameter value for the date 31-Jan-2006, run the following SQL query: SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual; When you specify the output of this query as the value of the `TimeStamp` parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.

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

Note:

You must use the existing standard APPS User for connecting to the Oracle e-Business Employee Reconciliation database because only this user has the rights required to update the database.