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 deployment requirements for the connector.

Item	Requirement
Oracle Identity Manager	Oracle Identity Manager release 8.5.3 or later
Target systems	The target system can be any one of the following: PeopleSoft Enterprise Applications 8.3 SP 1 PeopleSoft Enterprise Applications 8.9 PeopleTools 8.22 and 8.45 through 8.46 You must ensure that the following components are installed and configured: Tuxedo and Jolt (the application server) PeopleSoft Internet Architecture PeopleSoft Application Designer (2-tier mode)
Target system host platforms	Microsoft Windows
Target system user account	`PS` user Oracle Identity Manager uses this user account to connect to and exchange data with PeopleSoft User Management. 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 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/PeopleSoft Enterprise Applications/PeopleSoft User Management

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/JavaTasks/PSFTBaseProvisioning.jar	OIM_home/xellerate/JavaTasks
lib/ScheduleTask/PSFTBaseReconciliation.jar	OIM_home/xellerate/ScheduleTask
lib/ext/csv.jar	OIM_home/xellerate/ThirdParty
For PeopleTools 8.22, copy the files from the `MsgPublisher` directory	OIM_home/xellerate/MsgPublisher
For PeopleTools 8.22, copy the files from the `PeopleCode/PT822` directory For PeopleTools 8.45 through 8.47, 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.47, not both.
For PeopleTools 8.22, copy the files from the `resources/PT822` directory For PeopleTools 8.45 through 8.47, copy the files from the `resources` directory	OIM_home/xellerate/connectorResources Note: You must copy the files for either PeopleTools 8.22 or PeopleTools 8.45 through 8.47, not both.
For PeopleTools 8.22, copy the files from the `test/cbrecon/PT822` directory For PeopleTools 8.45 through 8.47, copy the files from the `test/cbrecon` directory	OIM_home/xellerate/XLIntegrations/PSFTBASE/cbrecon Note: You must copy the files for either PeopleTools 8.22 or PeopleTools 8.45 through 8.47, not both.
Files in the `test/config` directory	OIM_home/xellerate/XLIntegrations/PSFTBASE/config
For PeopleTools 8.22: xml/PT822/PSFTBaseConnector.xml xml/PT822/PSFTBaseXellerateUser.xml For PeopleTools 8.45 through 8.47: xml/PSFTBaseConnector.xml xml/PSFTBaseXellerateUser.xml	OIM_home/xlclient Note: You must copy the files for either PeopleTools 8.22 or PeopleTools 8.45 through 8.47, not both.

After you copy the connector files, copy the following files from the PeopleSoft_home/PT8xx/web/PSJOA directory into the OIM_home/xellerate/ThirdParty directory.

psjoa.jar

This is the PeopleSoft Java object adapter file.
peoplesoft.jar

This JAR file contains APIs for the USER_PROFILE component interface.

The "Creating the APIs for the Component Interface" section for information about the procedure to generate this file for the specific release of PeopleTools, 8.22 or 8.45 through 8.47, that you are using.
pshttp.jar (PeopleTools 8.45 through 8.47 only)

Create this JAR file using the PeopleSoft class files that are in the pshttp and cache directories on the PeopleSoft server. The location of these directories depends on the PeopleTools release that you are using. For PeopleTools 4.5, the directories are located at the following paths:
```
pt8.45/class/psft/pt8/pshttp
pt8.45/class/psft/pt8/cache
```

The pstools.properties file contains the Tuxedo parameter settings used by the PeopleSoft Integration Gateway. You must copy it into the OIM_home/xellerate/bin directory.

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

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.

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

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.PSFTBase=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.PSFTBase=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.PSFTBase=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.PSFTBase=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.PSFTBase">
   <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.PSFTBase">
   <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.PSFTBase=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.PSFTBase=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 4: Importing the Connector XML Files

To import the connector 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 locating files is displayed.
Locate and open the PSFTBaseConnector.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 Base Server IT resource is displayed.
Specify values for the parameters of the PSFT Base Server IT resource. Refer to 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 PSFTBase 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 PSFT Base Server IT resource parameters listed in the following table.

Parameter	Description
`Admin`	User ID of the PeopleSoft User Management administrator Default value: `PS`
`AdminCredentials`	Password of the PeopleSoft User Management administrator
`ComponentInterfaceName`	Component interface used to load user data in PeopleSoft User Management Default value: `USER_PROFILE`
`ServerName`	IP address or computer name of the PeopleSoft User Management server
`ServerPort`	Port at which the PeopleSoft User Management server is listening Default value: `9000`
`IsSecure`	Specify whether or not the SSL feature is enabled The value can be `YES` or `NO`. The default value is `NO`. Note: It is recommended that you enable SSL to secure communication with the target system.
`SymbolicId`	Specifies the AccessId associated with the user profile The AccessId specifies whether or not the user has sufficient privileges on the PeopleSoft User Management database. Sample value: `PS89`
`RecordName`	Used to validate the employee ID during user provisioning in PeopleSoft User Management Default value: `PERSONAL_DATA`
`NumberOfRetries`	Number of times the connection to the target system must be retried before the `InvocationTargetException` is thrown Default value: 2 Note: The timeout feature is enabled only for bulk reconciliation and provisioning. It is not applied during change-based reconciliation.
`DelayBetweenRetries`	Time difference between subsequent retries (in milliseconds) Default value: 20000
`IndexOfLastReconciledRecords`	Stores the index of last successful reconciled record Default value: `-1`

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