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

Note:

In this guide, PeopleSoft HRMS/HCM has been referred to as the target system.

2.1 Step 1: Verifying Deployment Requirements

To verify deployment requirements for the PeopleSoft Employee Reconciliation connector:

Ensure that your environment meets the requirements listed in the following table.

Item	Requirement
Oracle Identity Manager	Oracle Identity Manager release 8.5.3 or later
Target system	The following are the supported target systems and the PeopleTools versions for each: PeopleSoft HRMS 8.3 SP1 with PeopleTools 8.22 PeopleSoft Enterprise HCM 8.9 with PeopleTools 8.45 through 8.47 PeopleSoft Enterprise HCM 9.0 with PeopleTools 8.48 You must ensure that the following components are installed and configured: Tuxedo and Jolt (the application server) PeopleSoft Internet Architecture
Target system host platform	Applications running on PeopleTools 8.22 and PeopleSoft HRMS 8.3 SP1 are supported only on Microsoft Windows platforms. For applications running on any other supported PeopleTools versions, there is no platform dependency.
External code	The `csv.jar` external code file is included in the installation media directory for this connector. Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.

Ensure that you have administrative rights on the target system server to configure the "Configuring PeopleSoft Integration Broker" component.

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:

- 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/PeopleSoft Enterprise Applications/PeopleSoft Employee Reconciliation

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

- If a particular destination directory does not already exist on the Oracle Identity Manager server, then create it.

File in the Installation Media Directory	Destination Directory
Files in the `config` directory	OIM_HOME/xellerate/XLIntegrations/PSFTHR/config
ext/csv.jar	OIM_HOME/xellerate/ThirdParty
lib/peopleSoftApp.war	OIM_HOME/cbrecon_webapp/lib
lib/xlPSFTHRRecon.jar	OIM_HOME/xellerate/ScheduleTask
For PeopleTools 8.22, copy the files from the `lib/MsgPublisher` directory	OIM_HOME/xellerate/MsgPublisher
For PeopleTools 8.22, copy the files from the `PeopleCode/PT822` directory For PeopleTools 8.45 through 8.48, copy the files from the `PeopleCode` directory	OIM_HOME/xellerate/scripts Note: You must copy the files for either PeopleTools 8.22 or PeopleTools 8.45 through 8.48. Do not copy both sets of files.
Copy the files from the `resources` directory	OIM_HOME/xellerate/connectorResources
Files in the `test/cbrecon` directory	OIM_HOME/xellerate/XLIntegrations/PSFTHR/cbrecon
Files in the `xml` directory	OIM_HOME/xlclient

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

2.3 Step 3: Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note:

In a clustered environment, you must perform these procedures 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 procedure 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. An exception is thrown if you run the command described in Step 2 as follows:
```
OIM_HOME/xellerate/bin/script_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. This exception is different from the one mentioned in Step 1.

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

BEA WebLogic

To enable logging:

Add the following line in the OIM_HOME/xellerate/config/log.properties file:

log4j.logger.ADAPTER.PSFTEMPLOYEE=log_level
log4j.logger.com.thortech.xl.integration.peoplesoft.PeopleSoftAction=log_level
log4j.logger.com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation=log_level

In these lines, replace log_level with the log level that you want to set.

For example:

log4j.logger.ADAPTER.PSFTEMPLOYEE=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.PeopleSoftAction=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation=DEBUG

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:

Add the following line in the OIM_HOME/xellerate/config/log.properties file:

log4j.logger.ADAPTER.PSFTEMPLOYEE=log_level
log4j.logger.com.thortech.xl.integration.peoplesoft.PeopleSoftAction=log_level
log4j.logger.com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation=log_level

In these lines, replace log_level with the log level that you want to set.

For example:

log4j.logger.ADAPTER.PSFTEMPLOYEE=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.PeopleSoftAction=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation=DEBUG

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

WEBSPHERE_HOME/AppServer/logs/server_name/SystemOut.log

JBoss Application Server

To enable logging:

In the JBOSS_HOME/server/default/conf/log4j.xml file, locate the following lines:

<category name="ADAPTER.PSFTEMPLOYEE">
   <priority value="log_level"/>
</category>

<category name="com.thortech.xl.integration.peoplesoft.PeopleSoftAction">
   <priority value="log_level"/>
</category>

<category name="com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation">
   <priority value="log_level"/>
</category>

In these lines, replace log_level with the log level that you want to set. For example:

<category name="ADAPTER.PSFTEMPLOYEE">
   <priority value="DEBUG"/>
</category>

<category name="com.thortech.xl.integration.peoplesoft.PeopleSoftAction">
   <priority value="DEBUG"/>
</category>

<category name="com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation">
   <priority value="DEBUG"/>
</category>

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

JBOSS_HOME/server/default/log/server.log

Oracle Application Server

To enable logging:

Add the following line in the OIM_HOME/xellerate/config/log.properties file:

log4j.logger.ADAPTER.PSFTEMPLOYEE=log_level
log4j.logger.com.thortech.xl.Integration.peoplesoft.PeopleSoftAction=log_level
log4j.logger.com.thortech.xl.Integration.peoplesoft.util.tcUtilReconciliation=log_level

In these lines, replace log_level with the log level that you want to set.

For example:

log4j.logger.ADAPTER.PSFTEMPLOYEE=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.PeopleSoftAction=DEBUG
log4j.logger.com.thortech.xl.integration.peoplesoft.util.tcUtilReconciliation=DEBUG

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

OAS_HOME/opmn/logs/default_group~home~default_group~1.log

2.4 Step 4: Importing the Connector XML Files

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 opening files is displayed.
Locate and open the adpPSFT_RECON_DM.xml file, which is in the OIM_HOME/xlclient directory. Details of the XML file are shown on the File Review 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 PSFT_Employee IT resource is displayed.

Specify values for the parameters of the PSFT_Employee IT resource. The following table lists the values to be specified:

Parameter	Description
`NumberOfRetries`	Use this parameter to specify the number of times Oracle Identity Manager must try connecting to the target system before the `InvocationTargetException` is thrown. Default value: 2
`DelayBetweenRetries`	Use this parameter to specify the time difference between consecutive retries (in milliseconds). Default value: 20000
`IndexOfLastReconciledRecord`	This parameter stores the index of the last successful reconciled record. This parameter is applicable only for full reconciliation. Refer to the "Configuring the IndexOfLastReconciledRecord Parameter" section for more information about this parameter. Default value: `-1`

Click Next. The Provide IT Resource Instance Data page for a new instance of the PSFT_Employee 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 file is imported into Oracle Identity Manager.

Note:
The default name of the IT resource provided in the connector xml file is PSFT_Employee. This name is hardcoded in the incremental reconciliation code for PeopleTools 8.22. This IT resource name must not be changed for incremental reconciliation to be run successfully.
To import the adpPSFT_XellerateUser_RECON_DM.xml file, perform Steps 2 through 7 and Steps 9 through 12. Do not perform Step 8.

Caution:
Only one target system can be designated as a trusted source. By importing the adpPSFT_XellerateUser_RECON_DM.xml file, you configure trusted source reconciliation. If you import this XML file while you have another trusted source configured, then both connector reconciliations would stop working.