| Oracle® Identity Manager Connector Guide for PeopleSoft User Management Release 9.1.1 E11206-06 |
|
 Previous |
 Next |
| Oracle® Identity Manager Connector Guide for PeopleSoft User Management Release 9.1.1 E11206-06 |
|
Previous |
Next |
Deploying the connector involves the following steps:
Preinstallation information is divided across the following sections:
This section contains the following topics:
Section 2.1.1.1, "Files and Directories on the Installation Media"
Section 2.1.1.2, "Determining the Release Number of the Connector"
Section 2.1.1.3, "Creating a Backup of the Existing Common.jar File"
Table 2-1 lists the files and directories on the installation media.
Table 2-1 Files and Directories on the Installation Media
| File in the Installation Media Directory | Description |
|---|---|
|
configuration/Peoplesoft_User-Management-CI.xml |
This XML file contains configuration information that is used during connector installation. |
|
lib/PSFTUM.jar |
This JAR file contains the class files that are specific to PeopleSoft reconciliation and provisioning. During connector deployment, this file is copied into the following directory: OIM_HOME/xellerate/JavaTasks |
|
lib/Common.jar |
This JAR file contains the class files that are common to all connectors. During connector deployment, this file is copied into the following directory: OIM_HOME/xellerate/JavaTasks |
|
lib/PSFTCommon.jar |
This JAR file contains PeopleSoft-specific files common to both Employee Reconciliation and User Management versions of the connector. During connector deployment, this file is copied into the following directory: OIM_HOME/xellerate/JavaTasks |
|
lib/CustomClassLoader.jar |
This JAR file contains the class files that are needed to load the target system-specific JAR files at run time, for example psjoa.jar. |
|
lib/PeopleSoftOIMListener.war |
This Web Archive (WAR) file contains the classes and configuration files required to implement incremental reconciliation. |
|
The following files in the peoplecode directory: CurrencyCode.txt EmailType.txt LanguageCode.txt PermissionList.txt UserRoles.txt The following project files in the peoplecode directory: OIM_UM OIM_UM_DELETE |
These files contain the PeopleCode for the steps that you define for the Application Engine program. This is explained in "Creating the Application Engine Program". The project files contain the PeopleCode for the steps that you define for importing a Project from Application Designer. This is explained in Section 2.1.2.1, "Importing a Project from Application Designer." Each project file contains two files with .ini and .xml extension that has the same name as the project. They are listed as follows:
|
|
test/scripts/InvokeListener.bat test/scripts/InvokeListener.sh |
This BAT file and the UNIX shell script call the testing utility for reconciliation. |
|
test/scripts/PeoplesoftTestingUtility.bat test/scripts/PeoplesoftTestingUtility.sh |
This BAT file and the UNIX shell script call the testing utility for provisioning. |
|
test/config/reconConfig.properties test/config/log.properties |
These files are used by theInvokeListener.bat file. The reconConfig.properties file contains configuration information for running the InvokeListener.bat file. The log.properties file contains logger information. |
|
test/config/config.properties |
This file is used to specify the parameters and settings required to connect, create, update, and delete users in the target system by using the testing utility for provisioning. |
|
Files in the resources directory |
Each of these resource bundles contains language-specific information that is used by the connector. Note: A resource bundle is a file containing localized versions of the text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages. |
|
xml/PeoplesoftUserManagement-ConnectorConfig.xml |
This XML file contains definitions for the connector components.
|
|
JavaDoc |
This directory contains information about the Java APIs used by the connector. |
You might have a deployment of an earlier release of the connector. While deploying the current release, you might want to know the release number of the earlier release. To determine the release number of a connector that has been deployed:
In a temporary directory, extract the contents of the following JAR file:
OIM_HOME/xellerate/JavaTasks/PSFTUM.jar
Open the manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the PSFTUM.jar file.
In the Manifest.mf file, the release number of the connector is displayed as the value of the Version property.
The Common.jar file is in the deployment package of each 9.1.x release of the connector. With each new release, code corresponding to that particular release is added to the existing code in this file. For example, the Common.jar file shipped with Connector Y on 12-July contains:
Code specific to Connector Y
Code included in the Common.jar files shipped with all other 9.1.x release of the connectors that were released before 12-July
If you have installed a release 9.1.x connector that was released after the PeopleSoft User Management release 9.1.1 connector, back up the existing Common.jar file, install the PeopleSoft User Management connector, and then restore the Common.jar file. The steps to perform this procedure are as follows:
|
Caution: If you do not perform this procedure, then your release 9.1.x connectors might not work. |
Determine the release date of your existing release 9.1.x connector as follows:
Extract the contents of the following file in a temporary directory:
OIM_HOME/xellerate/JavaTasks/Common.jar
Open the Manifest.mf file in a text editor.
Note down the Build Date and Build Version values.
Determine the Build Date and Build Version values of the PeopleSoft User Management release 9.1.1 connector as follows:
On the installation media for the connector, extract the contents of the lib/Common.jar and then open the Manifest.mf file in a text editor.
Note down the Build Date and Build Version values.
If the Build Date and Build Version values for the PeopleSoft User Management connector are less than the Build Date and Build Version values for the connector that is installed, then:
Copy the OIM_HOME/xellerate/JavaTasks/Common.jar to a temporary location.
After you perform the procedure described in Section 2.2, "Installation" overwrite the new Common.jar file in the OIM_HOME/xellerate/JavaTasks directory with the Common.jar file that you backed up in the preceding step.
Permission Lists, Roles, and User Profiles are building blocks of PeopleSoft security. Each user of the system has an individual user profile, which in turn is linked to one or more roles. To each Role, you can add one or more permission lists, which defines what a user can access. So, a user inherits permissions through the role that is attached to a user profile.
You must create limited rights users who have restricted rights to access resources in the production environment to perform PeopleSoft-specific installation or maintenance operations. A limited rights user has the privilege to invoke PeopleSoft User Profile Component Interface Java APIs for provisioning.
The preinstallation steps consist of creating a user account with limited rights. Permission lists may contain any number of accesses, such as the Web libraries permission, Web services permissions, page permissions, and so on. You attach this permission list to a role, which in turn is linked to a user profile.
This section describes the following procedures, which have to be performed on the target system to create a user account with limited rights:
Section 2.1.2.1, "Importing a Project from Application Designer"
Section 2.1.2.2, "Creating a Target System User Account for Connector Operations"
A PeopleSoft Application Designer project is an efficient way to configure your application.
You can import the OIM_UM project created in Application Designer to automate the steps for creating a permission list. You can also create a permission list by manually performing the steps described in Section 2.1.2.2.1, "Creating a Permission List." If you import the OIM_UM project, then you need not perform the steps mentioned in this section. You must perform a separate set of instructions for creating an Application Engine if you have imported the project. See "Creating the Application Engine Program" for details.
|
Note: If you install, uninstall, or upgrade the same project repeatedly the earlier project definition will be overwritten in the database. |
To import a project from Application Designer:
|
Note: You can access the project files from the following directory:OIM_HOME/xellerate/XLIntegrations/PSFTUM/peoplecode/OIM_UM OIM_HOME/xellerate/XLIntegrations/PSFTUM/peoplecode/OIM_UM_DELETE These files should be copied to a location on your computer from where you can access the Application Designer program. |
To open Application Designer in 2-tier mode, click Start, Programs, Peoplesoft8.x, and then Application Designer.
From the Tools menu, click Copy Project and then From File.
The Copy From File : Select Project dialog box appears.
Navigate to the directory in which the PeopleSoft project file is placed.
Select the project from the Select Project from the List Below region. The name of the project file is OIM_UM.
Click Select.
Click Copy.
|
Note: You can remove the PeopleSoft project file and all its objects from the target system if needed. To do so, repeat the steps described in the preceding procedure. When you reach Step 4, select OIM_UM_DELETE from the Select Project from the List Below region. |
You must create a target system account with privileges required for connector operations. The user account created on the target system has the permission to perform all the configurations required for connector operations. This includes configuring the PeopleSoft Integration Broker for full reconciliation and incremental reconciliation. This account does not have access to pages or components that are not required by the connector.
The following section describes the procedures to create a target system account:
|
Note: For creating the target system account, you must log in to PeopleSoft Internet Architecture with administrator credentials. |
Section 2.1.2.2.2, "Creating a Role for a Limited Rights User"
Section 2.1.2.2.3, "Assigning the Required Privileges to the Target System Account"
To create a permission list:
|
Note: You can skip this section if you have imported a project from Application Designer. See Section 2.1.2.1, "Importing a Project from Application Designer" for more information. |
Open a Web browser and enter the URL for PeopleSoft Internet Architecture. The URL is in the following format:
http://IPADDRESS:PORT/psp/ps/?cmd=login
For example:
http://172.21.109.69:9080/psp/ps/?cmd=login
In the PeopleSoft Internet Architecture window, click PeopleTools, Security, Permissions & Roles, and then click Permission Lists.
Click Add a new Value. On the Add a New Value tab, enter the permission list name, for example, OIMUM and then click Add.
On the General tab, enter a description for the permission list in the Description field.
On the Component Interfaces tab, click the search icon for the Name field and perform the following:
In the Name lookup, enter USER_PROFILE and then click Lookup. From the list, select USER_PROFILE. The application returns to the Component Interfaces tab. Click Edit.
On the Component Interface Permissions page, click Full Access(All).
Click OK and then click Save.
Click the plus sign (+) to add a row for the Name field and repeat Steps a through c for the DELETE_USER_PROFILE component interface.
On the Pages tab, click the search icon for Menu Name and perform the following:
In the Menu Name lookup, enter APPLICATION_ENGINE and then click Lookup. From the list, select APPLICATION_ENGINE. The application returns to the Pages tab. Click Edit Components.
On the Component Permissions page, click Edit Pages for the AE_REQUEST component name.
Click Select All, and then click OK. Click OK on the Components Permissions page.
On the Pages tab, click the plus sign (+) to add a row for Menu Name. Click the search icon for Menu Name. In the Menu Name lookup, enter IB_PROFILE and then click Lookup. From the list, select IB_PROFILE. The application returns to the Pages tab. Click Edit Components.
On the Component Permissions page, click Edit Pages for each of the following component names:
IB_GATEWAY
IB_MESSAGE_BUILDER
IB_MONITOR_QUEUES
IB_NODE
IB_OPERATION
IB_QUEUEDEFN
IB_ROUTINGDEFN
IB_SERVICE
IB_SERVICEDEFN
IB_MONITOR
Click Select All, and then click OK for each of the components. Click OK on the Components Permissions page.
On the Pages tab, click the plus sign (+) to add another row for Menu Name.
In the Menu Name lookup, enter PROCESSMONITOR and then click Lookup. From the list, select PROCESSMONITOR. The application returns to the Pages tab. Click Edit Components.
On the Component Permissions page, click Edit Pages for the PROCESSMONITOR component name.
Click Select All, and then click OK. Click OK on the Components Permissions page.
On the Pages tab, click the plus sign (+) to add another row for Menu Name.
In the Menu Name lookup, enter PROCESS_SCHEDULER and then click Lookup. From the list, select PROCESS_SCHEDULER. The application returns to the Pages tab. Click Edit Components.
On the Component Permissions page, click Edit Pages for the PRCSDEFN component name.
Click Select All, and then click OK. Click OK on the Components Permissions page.
On the People Tools tab, select the Application Designer Access check box and click the Definition Permissions link. The Definition Permissions page is displayed.
On this page, grant full access to the following object types by selecting Full Access from the Access list:
App Engine Program
Message
Component Interface
Project
Application Package
Click OK.
Click the Tools Permissions link. The Tools Permissions page is displayed. On this page, grant full access to the SQL Editor tool by selecting Full Access from the Access list.
Click OK. The application returns to the People Tools tab.
On the Web Libraries tab, click the search icon for the Web Library Name field and perform the following:
In the Web Library Name lookup, enter WEBLIB_PORTAL and then click Lookup. From the list, select WEBLIB_PORTAL. The application returns to the Web Libraries tab. Click the Edit link.
On the WebLib Permissions page, click Full Access(All).
Click OK and then click Save.
Click the plus sign (+) to add a row for the Web Library Name field and repeat Steps a through c for the WEBLIB_PT_NAV library.
Click Save to save all the settings specified for the permission list.
On the Process tab, click the Process Group Permissions link. The Process Group Permission page is displayed.
In the Process Group lookup, click the search icon. From the list, select TLSALL. The application returns to the Process Group Permission page.
Click the plus sign (+) to add another row for Process Group.
In the Process Group lookup, click the search icon. From the list, select STALL. The application returns to the Process Group Permission page.
Click OK.
Click Save.
To create a role for a limited rights user:
Open a Web browser and enter the URL for PeopleSoft Internet Architecture. The URL is in the following format:
http://IPADDRESS:PORT/psp/ps/?cmd=login
For example:
http://172.21.109.69:9080/psp/ps/?cmd=login
In the PeopleSoft Internet Architecture window, click PeopleTools, Security, Permissions & Roles, and then click Roles.
Click Add a new Value. On the Add a New Value tab, enter the role name, for example, OIMUM and then click Add.
On the General tab, enter a description for the role in the Description field.
On the Permission Lists tab, click the search icon and perform the following:
In the Permission Lists lookup, enter OIMUM and then click Lookup. From the list, select OIMUM.
Click the plus sign (+) to add another row.
In the Permission Lists lookup, enter EOEI9000 and then click Lookup. From the list, select EOEI9000.
Click the plus sign (+) to add another row.
In the Permission Lists lookup, enter EOCO9000 and then click Lookup. From the list, select EOCO9000.
Click Save.
To assign the required privileges to a user:
Open a Web browser and enter the URL for PeopleSoft Internet Architecture. The URL is in the following format:
http://IPADDRESS:PORT/psp/ps/?cmd=login
For example:
http://172.21.109.69:9080/psp/ps/?cmd=login
In the PeopleSoft Internet Architecture window, click PeopleTools, Security, User Profiles, and then click User Profiles.
Click Add a new Value. On the Add a New Value tab, enter the user profile name, for example, OIMUM and then click Add.
On the General tab, perform the following:
From the Symbolic ID list, select the value that is displayed, for example, SYSADM1.
Enter valid values for the Password and Confirm Password fields.
Click the search icon for the Process Profile permission list.
In the Process Profile lookup, enter OIMUM and then click Lookup. From the list, select OIMUM. The application returns to the General tab.
On the ID tab, select none as the value of the ID type.
On the Roles tab, click the search icon and perform the following:
In the Roles lookup, enter OIMUM and then click Lookup. From the list, select OIMUM.
Click the plus sign (+) to add another row.
In the Roles lookup, enter ProcessSchedulerAdmin and then click Lookup. From the list, select ProcessSchedulerAdmin.
Click the plus sign (+) to add another row.
In the Roles lookup, enter EIR Administrator and then click Lookup. From the list, select EIR Administrator.
Click Save to save this user profile.
Oracle Identity Manager uses this profile for the Admin user parameter in IT resource to enable the connector to perform provisioning operations. This profile is also used for a user with limited rights in PeopleSoft for performing all reconciliation-related configurations.
Installation information is divided across the following sections:
Installation on Oracle Identity Manager consists of the following procedures:
Section 2.2.1.2, "Copying the Connector Files and External Code Files"
Section 2.2.1.4, "Configuring the Connector to Support Multiple Versions of the Target System"
|
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. |
To run the Connector Installer, refer to the instructions given in the "Installing Predefined Connectors" chapter of Oracle Identity Manager Administrative and User Console Guide. The following instructions are specific to individual steps of the procedure described in the "Installing a Predefined Connector" section of that chapter:
When you reach Step 3 of that procedure, apply the following instructions:
The following is the default connector installation directory:
OIM_HOME/xellerate/ConnectorDefaultDirectory
If you have copied the installation files into this directory, then select PeopleSoft User Management 9.1.1 from the Connector List list.
If you have copied the installation files into a different directory, then:
In the Alternative Directory field, enter the full path and name of that directory.
To repopulate the list of connectors in the Connector List list, click Refresh.
From the Connector List list, select the connector to install.
Perform Steps 1 through 5 of that procedure. When you reach Step 6 of that procedure, see Section 2.2.1.3, "Configuring the IT Resource" in this guide. Instructions to perform Step 6 of that procedure are described in detail in that section.
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 2-2.
Table 2-2 Files Copied to Oracle Identity Manager
| File in the Installation Media Directory | Destination Directory |
|---|---|
|
lib/PSFTUM.jar |
OIM_HOME/xellerate/JavaTasks |
|
lib/Common.jar |
OIM_HOME/xellerate/JavaTasks |
|
lib/PSFTCommon.jar |
OIM_HOME/xellerate/JavaTasks |
|
lib/CustomClassLoader.jar |
OIM_HOME/xellerate/JavaTasks |
|
lib/PeopleSoftOIMListener.war |
To be deployed on the Application Server |
Installing the Connector in an Oracle Identity Manager Cluster
While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Then, restart each node. See Section 2.1.1.1, "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.
Restoring the Common.jar File
If required, restore the Common.jar file that you had backed up by following the procedure described in Section 2.1.1.3, "Creating a Backup of the Existing Common.jar File."
Table 2-3 lists all the files that you must copy manually and the directories on the Oracle Identity Manager host computer to which you must copy them.
|
Note:
|
Table 2-3 Files to Be Copied to the Oracle Identity Manager Host Computer
| File in the Installation Media Directory | Destination Directory |
|---|---|
|
lib/PeopleSoftOIMListener.war |
OIM_HOME/xellerate/XLIntegrations/PSFTUM/WAR |
|
Files in the peoplecode directory |
OIM_HOME/xellerate/XLIntegrations/PSFTUM/peoplecode |
|
Files in the test/scripts directory |
OIM_HOME/xellerate/XLIntegrations/PSFTUM/scripts |
|
Files in the test/config directory |
OIM_HOME/xellerate/XLIntegrations/PSFTUM/config |
After you copy the connector files, copy the following files from the PEOPLESOFT_HOME/web/psjoa directory on the target system computer into the OIM_HOME/xellerate/ThirdParty directory.
|
Note: These files should be copied only if one version of the target system is supported, and the Multiple Version Support parameter in Lookup.PSFT.Configuration is set to No. |
psjoa.jar
This JAR file contains the compiled Java classes required by Oracle Identity Manager to remotely connect to the target system.
peoplesoft.jar
This JAR file contains APIs for the USER_PROFILE and DELETE_USER_PROFILE component interfaces.
The Section 2.2.2.4, "Configuring the Target System for Provisioning" provides information about the procedure to generate this file for the specific release of PeopleTools (8.49) that you are using.
|
Note: The supported JDK and JRE versions are linked to the PeopleTools version you are using. For PeopleTools 8.49, the supported JDK version is 1.5.0. |
The IT resource for the target system contains connection information about the target system. Oracle Identity Manager uses this information during provisioning and reconciliation.
When you run the Connector Installer, the PSFT Server IT resource is automatically created in Oracle Identity Manager. You must specify values for the parameters of this IT resource as follows:
Log in to the Administrative and User Console.
Expand Resource Management.
Click Manage IT Resource.
In the IT Resource Name field on the Manage IT Resource page, enter PSFT UM Server and then click Search.
Click the edit icon for the IT resource.
From the list at the top of the page, select Details and Parameters.
Specify values for the parameters of the IT resource. Table 2-4 describes each parameter.
Table 2-4 IT Resource Parameters
| Parameter | Description |
|---|---|
|
Admin |
Enter the user name of the target system account to be used for connector operations. You create this account by performing the procedure described in the Section 2.1.2.2, "Creating a Target System User Account for Connector Operations" section. Sample value: |
|
AdminCredentials |
Enter the password of the target system account specified by the Admin ID parameter. |
|
Configuration Lookup |
This parameter holds the name of the lookup definition that contains configuration information. Default value: Note: You must not change the value of this parameter. However, if you create a copy of all the connector objects, then you can specify the unique name of the copy of this lookup definition as the value of the Configuration Lookup Name parameter in the copy of the IT resource. |
|
IsActive |
This parameter is used to specify whether the specified IT Resource is in use or not. When If it is Default value: |
|
JAR File Location |
Location of JAR files to support multiple PeopleSoft versions. Sample value: Note: The connector reads the value of this attribute when the Multiple Version Support parameter in the Lookup.PSFT.Configuration lookup definition is set to |
|
Jolt URL |
URL of the computer hosting the PeopleSoft application server. Format: Sample value: See "Determining the Jolt Listener Port" for instructions to locate the Jolt Listener port. Note: If you have implemented high availability for PeopleSoft Application Servers, then you need not perform any additional step on Oracle Identity Manager for provisioning to work. You have to provide the correct Jolt URL according to your High Availability set up for PeopleSoft Application Servers. For more information about high availability, see Red Paper on Clustering and High Availability for Enterprise Tools 8.4x on Oracle Support and Working with Jolt Configuration Options in the PeopleBook Enterprise PeopleTools 8.49 PeopleBook: System and Server Administration. |
|
Abandoned connection timeout |
Time (in seconds) after which a connection must be automatically closed if it is not returned to the pool Note: You must set this parameter to a value that is high enough to accommodate processes that take a long time to complete (for example, full reconciliation). Default value: |
|
Connection wait timeout |
Maximum time (in seconds) for which the connector must wait for a connection to be available Default value: |
|
DelayBetweenRetries |
Use this parameter to specify the time difference between consecutive retries (in milliseconds). Default value: |
|
Inactive connection timeout |
Time (in seconds) of inactivity after which a connection must be dropped and replaced by a new connection in the pool Default value: |
|
Initial pool size |
Number of connections that must be established when the connection pool is initialized The pool is initialized when it receives the first connection request from a connector. Default value: Sample value: |
|
Max pool size |
Maximum number of connections that must be established in the pool at any point of time This number includes the connections that have been borrowed from the pool. Default value: 100 Sample value: |
|
Min pool size |
Minimum number of connections that must be in the pool at any point of time This number includes the connections that have been borrowed from the pool. Default value: |
|
Validate connection on borrow |
Specifies whether a connection must be validated before it is lent by the pool The value can be Default value: |
|
Timeout check interval |
Time interval (in seconds) at which the timeouts specified by the other parameters must be checked Default value: |
|
Pool preference |
Preferred connection pooling implementation Value: Note: Do not change the value of this parameter. |
|
Connection pooling supported |
Enter Default value: |
|
Target supports only one connection |
Indicates whether the target system can support one or more connections at a time Value: Note: Do not change the value of this parameter. |
|
ResourceConnection class definition |
Implementation of the ResourceConnection class Default value: Note: Do not change the value of this parameter. |
|
Native connection pool class definition |
Wrapper to the native pool mechanism that implements the GenericPool Note: Do not specify a value for this parameter. |
|
NumberOfRetries |
Use this parameter to specify the number of times Oracle Identity Manager must try connecting to the target system. Default value: Note: The timeout feature is enabled only for full reconciliation. |
|
Pool excluded fields |
Comma-separated list of IT parameters whose change should not trigger a refresh of the connector pool Default value: Note: You must not change the value of this parameter. |
To save the values, click Update.
Determining the Jolt Listener Port
You can obtain the Jolt Listener port number from the PeopleSoft Application Server configuration file, psappsrv.cfg.
To locate the Jolt Listener Port:
Log in to the computer where you have deployed the Application Server.
Navigate to the folder where you have deployed PeopleTools. For example, the PT8.49 folder for PeopleTools 8.49.
Navigate to the appserv folder.
Navigate to the folder that corresponds to the name of your application server.
Open the psappsrv.cfg file using WordPad.
The following is an example location for the file:
C:\PT8.49\appserv\HR8DMO\psappsrv.cfg
|
Note: You must not modify the contents of the file. |
Search for the following text in the file:
[JOLT Listener] ;========================================================================= ; Settings for JOLT Listener ;=========================================================================
Search for the string Port. This provides you the value for the Jolt Listener port.
You might want to configure the connector for different versions of the target system simultaneously. For example, you can use the connector to perform provisioning operations on both PeopleTools 8.48 and PeopleTools 8.49 simultaneously. The following example illustrates this requirement:
To meet the requirement posed by such a scenario:
The London and New York offices of Example Multinational Inc. have their own installations of the target system. The London office has PeopleTools 8.48 installation, while the New York office has PeopleTools 8.49 installation. You have to provision resources on both installations of PeopleTools simultaneously.
Now, with this release, you can configure a single version of the connector to simultaneously provision the resources on both the versions of the target system. The connector uses a class loading mechanism, which toggles between the different versions of the installation. You only need to place the target system-specific JAR files on the computer that hosts Oracle Identity Manager.
To configure the connector to support multiple versions of the target system:
Copy lib/PSFTUM.jar in a temporary directory, and extract the following class from the JAR file:
PSFTUMUserProxyProvisonManager.class
Sample temporary directory: c:\temp
Run the following command to extract the class file from the JAR file:
jar -xvf PSFTUM.jar
|
Note: You can also run the WinZip or WinRAR utility to extract the contents from the JAR file. |
Copy PSFTUMUserProxyProvisonManager.class to another location.
For example:
c:\temp1\oracle\iam\connectors\psft\usermgmt\integration
Create a new JAR file, PeopleSoftProxy.jar that contains the extracted PSFTUMUserProxyProvisonManager.class present in the directory defined in Step 3 as follows:
Open the command prompt and navigate to the following directory:
c:\temp1
Run the following command:
Jar -cvf PeopleSoftProxy.jar oracle
Create a new JAR file, PSFTUM.jar that contains the manifest file as follows:
Open the command prompt and navigate to the following directory:
c:\temp
Run the following command:
jar -cMvf PSFTUM.jar manifest-inclusion-file ./META-INF/MANIFEST.MF ./oracle
|
Note: You must ensure that the PSFTUM.jar does not contain the PSFTUMUserProxyProvisonManager.class file. |
Copy PSFTUM.jar to OIM_HOME/xellerate/JavaTasks.
Create a directory, for example PSFT849, which is accessible from Oracle Identity Manager.
|
Note: Ensure that the directory resides outside the Oracle Identity Manager classpath. In other words, the directory should be created outside the Oracle Identity Manager installation directory. |
Copy the following JAR files in the directory created in Step 5:
PeopleSoftProxy.jar
lib/common.jar
lib/PSFTCommon.jar
psjoa.jar (target specific)
peoplesoft.jar (target specific)
Provide the full path of the directory created in Step 5 in the ITResource attribute Jar File Location of the ITResource instance for PeopleSoft 8.49.
Repeat the preceding procedure for the other version of the target system, PeopleSoft 8.48 with the following information:
When you reach Step 5, create a directory with the following name: PSFT848.
You can reuse the PeopleSoftProxy.jar, lib/common.jar, and lib/PSFTCommon.jar files. In addition, copy the target-specific psjoa.jar and peoplesoft.jar files in the directory created in Step 5.
|
Note: Each target system directory should contain the same version of the following JAR files:
|
Set the Multiple Version Support parameter in the Lookup.PSFT.Configuration lookup definition to Yes.
|
Note: The following JAR files should not be present in OIM_HOME/xellerate/ThirdParty or in any other directory inside the Oracle Identity Manager installation path:
|
The PeopleSoft listener is a Web application that is deployed on an Oracle Identity Manager host computer. The PeopleSoft listener parses the XML message and creates a reconciliation event in Oracle Identity Manager.
To deploy the PeopleSoft listener:
Copy the OIM_HOME/xellerate/XLIntegrations/PSFTUM/WAR/PeopleSoftOIMListener.war file into a temporary folder. Enter the following command to extract the contents of the PeopleSoftOIMListener.war file.
jar –xvf PeopleSoftOIMListener.war
|
Note: All the files mentioned in the remaining steps of this procedure are extracted from the PeopleSoftOIMListener.war file. |
Copy the following files from the OIM_HOME/xellerate/lib directory to the WEB-INF/lib directory in the temporary folder:
|
Note: Before you copy these files from the OIM_HOME/xellerate/lib directory, check whether these files exist in the WEB-INF/lib directory of the temporary folder. If these files exist, then first delete them from the WEB-INF/lib directory. |
xlAPI.jar
xlAuthentication.jar
xlCache.jar
xlCrypto.jar
xlLogger.jar
xlVO.jar
xlDataObjectBeans.jar (For IBM WebSphere Application Server, copy this file from the OIM_CLIENT/xlclient/lib directory.)
Copy Common.jar from the /lib directory on the installation media to the WEB-INF/lib directory in the temporary folder.
Edit the web.xml file as follows:
Locate the Login Name of the OIM Admin User details.
<param-value>OIM_ADMIN_USER</param-value>
Replace OIM_ADMIN_USER with the Oracle Identity Manager administrator credentials.
For example, if the administrative account on Oracle Identity Manager is xelsysadm, then update the line as follows:
<param-value>xelsysadm</param-value>
Locate the XL Home Dir details, and replace OIM_HOME with Oracle Identity Manager Home location.
Locate the java security login config details.
<param-name>java.security.auth.login.config</param-name> <param-value>OIM_HOME/xellerate/config/auth(ws/wl).conf</param-value>
Here, the java.security.auth.login.config property is used to specify the fully qualified file name of the authentication configuration file. Typically, this file is located in the OIM_HOME/xellerate/config directory.
Each application server uses a different authentication configuration file:
IBM WebSphere Application Server: authws.conf
JBoss Application Server: auth.conf
Oracle WebLogic Server: authwl.conf
You must edit the auth(ws/wl).conf value in the preceding line to the application server-specific configuration file.
Locate the Message Handler Impl classes details.
<param-name>IT_RESOURCE_NAME</param-name>
Replace IT_RESOURCE_NAME with the name of the IT resource.
For example, if the name of the IT resource is PSFT Server, then update the line as follows:
<param-name>PSFT Server</param-name>
Locate the following line:
<param-value>MESSAGE~IMPLEMENTATION_CLASS;MESSAGE~IMPLEMENTATION_CLASS;MESSAGE~IMPLEMENTATION_CLASS</param-value>
In this format, the message name and its implementation class must be separated by a tilde (~). For multiple messages, each pair must be separated by a semicolon (;). For default implementation, you must modify the line as follows:
<param-value>PERSON_BASIC_SYNC~oracle.iam.connectors.psft.common.handler.impl.PSFTPersonSyncReconMessageHandlerImpl;USER_PROFILE~oracle.iam.connectors.psft.common.handler.impl.PSFTUserProfileReconMessageHandlerImpl;WORKFORCE_SYNC~oracle.iam.connectors.psft.common.handler.impl.PSFTWorkForceSyncReconMessageHandlerImpl;DELETE_USER_PROFILE~oracle.iam.connectors.psft.common.handler.impl.PSFTDeleteUserReconMessageHandlerImpl</param-value>
If PeopleSoft is sending the USER_PROFILE.VERSION_84 message instead of USER_PROFILE, then modify the line as follows:
<param-value>PERSON_BASIC_SYNC~oracle.iam.connectors.psft.common.handler.impl.PSFTPersonSyncReconMessageHandlerImpl;USER_PROFILE.VERSION_84~oracle.iam.connectors.psft.common.handler.impl.PSFTUserProfileReconMessageHandlerImpl;WORKFORCE_SYNC~oracle.iam.connectors.psft.common.handler.impl.PSFTWorkForceSyncReconMessageHandlerImpl;DELETE_USER_PROFILE~oracle.iam.connectors.psft.common.handler.impl.PSFTDeleteUserReconMessageHandlerImpl</param-value>
Delete the PeopleSoftOIMListener.war file from the temporary directory into which you extracted it, and then use the following command to re-create the file:
jar –cvf PeopleSoftOIMListener.war
Ensure that the old version of the PeopleSoftOIMListener.war file is deleted from the application server deployment directory.
Deploy the newly created PeopleSoftOIMListener.war file in the deployment directory of the application server as follows:
For IBM WebSphere Application Server:
Log in to the WebSphere Admin console.
Expand Applications.
Click Install New Application.
Click the Browse button to locate the WAR file.
In the Context root field, enter PeopleSoftOIMListener.
Click Next.
In the Select installation options field, enter PeopleSoftOIMListener as the application name and click Next.
On the Map modules to servers page, select PeopleSoftOIMListener.war and click Next.
On the Map virtual hosts page, select PeopleSoftOIMListener.war and click Next.
Click Finish.
Click Save to save all the configurations to the master configuration in IBM WebSphere Application Server.
Click Enterprise Applications.
On the Enterprise Applications page, select PeopleSoftOIMListener and then click Start to restart the application.
For JBoss Application Server:
Copy the modified WAR file to the JBOSS_HOME/server/default/deploy directory.
In case of JBoss cluster environment, copy the modified WAR file to the JBOSS_HOME/server/all/deploy directory.
Restart JBoss Application Server.
For Oracle WebLogic Server:
Log in to the Oracle WebLogic admin console.
From the Domain Structure list, select OIM_DOMAIN.
Where OIM_DOMAIN is the domain on which Oracle Identity Manager is installed.
Click the Deployments tab.
On Microsoft Windows, in the Change Centre window, click Lock & Edit. This enables the Install button of the Monitoring tab in the Summary Of Deployments section.
Click Install.
In the Install Application Assistant, enter the full path of the directory in which the WAR file is placed. Then, click Next.
Select the WAR file to install.
Click Next.
Select the Install this deployment as an application option, and then click Next.
In the Name of deployment field, enter PeopleSoftOIMListener.
In the Security section, select the DD Only: Use only roles and policies that are defined in the deployment descriptors option.
In the Source accessibility window, select the Use the defaults defined by the deployments targets option.
Click Finish.
On Microsoft Windows, the "The deployment has been successfully installed" message is displayed.
On UNIX platforms, click Save. The following messages are displayed:
Success All changes have been activated. No restarts are necessary.
Success Settings updated successfully.
On Microsoft Windows, to activate the changes that you have made up to this point:
i. Select the check box corresponding to the newly installed application.
ii. In the Change centre window, click Activate Changes.
On Microsoft Windows, select the check box for the newly installed application, select the Servicing all requests option from the Start list, and then click Yes.
Restart Oracle Identity Manager and the Design Console.
|
Note: This section is not a part of installation on Oracle Identity Manager. You might need this procedure to extend the connector. |
To remove the PeopleSoft listener:
For IBM WebSphere Application Server:
Log in to the WebSphere Admin console.
Expand Applications.
Select Enterprise Applications from the list.
A list of deployed applications is shown on the right pane.
Select the PeopleSoftOIMListener.war check box.
Specify the Context root as PeopleSoftOIMListener.
Click Uninstall.
An Uninstall Application confirmation screen appears with the name of the application to be uninstalled. In this scenario, the application would be PeopleSoftOIMListener.
Click OK.
For JBoss Application Server:
Delete the WAR file from the JBOSS_HOME/server/default/deploy directory.
In case of JBoss cluster environment, delete the WAR file from the JBOSS_HOME/server/all/deploy directory.
Restart JBoss Application Server.
For Oracle WebLogic Server:
Log in to the Oracle WebLogic admin console.
From the Domain Structure list, select OIM_DOMAIN.
Where OIM_DOMAIN is the domain on which Oracle Identity Manager is installed.
Click the Deployments tab.
On Microsoft Windows, in the Change Centre window, click Lock & Edit.
Select PeopleSoftOIMListener.war. This enables the Delete button of the Control tab in the Summary Of Deployments region.
Click Stop. A list appears.
Select Force Stop Now.
The Force Stop Application confirmation screen appears.
Click Yes.
On the Control tab in the Summary Of Deployments region, select PeopleSoftOIMListener.war.
Click Delete.
A confirmation message appears on successful deletion of the WAR file.
On the left pane, click the Active Changes button.
During this stage, you configure the target system to enable it for reconciliation and provisioning operations. This information is provided in the following sections:
Section 2.2.2.1, "Configuring the Target System for Lookup Reconciliation"
Section 2.2.2.2, "Configuring the Target System for Full Reconciliation"
Section 2.2.2.3, "Configuring the Target System for Incremental Reconciliation"
Section 2.2.2.4, "Configuring the Target System for Provisioning"
Lookup reconciliation is used to reconcile lookup definitions for currency codes, languages, roles, permissions, and e-mail types corresponding to the lookup fields on the target system created into Oracle Identity Manager.
Configuring the target system for lookup reconciliation involves creating the .properties file by performing the procedure described in the following section:
Creating the Application Engine Program
The Application Engine program populates the .properties file with lookup data that is required for look up reconciliation. This is a one-time procedure.
You can create the Application Engine program based on whether you have imported the PeopleSoft Application Designer project. Perform the procedure described in one of the following sections:
Creating the Application Engine Program If PeopleSoft Application Designer Project Is Not Imported
Creating the Application Engine Program If PeopleSoft Application Designer Project Is Imported
Creating the Application Engine Program If PeopleSoft Application Designer Project Is Not Imported
To create the Application Engine program if you have not imported the PeopleSoft Application Designer Project as described in Section 2.1.2.1, "Importing a Project from Application Designer," you must perform the following tasks:
To open Application Designer in 2-tier mode, click Start, Programs, Peoplesoft8.x, and then Application Designer.
|
Note: To open Application Designer in 2-tier mode, the database client (client of the database that PeopleSoft is using) must be installed on the server. In addition, you must select the appropriate database type from the Connection Type field (for example, Oracle Database) while providing sign-on information in the PeopleSoft Application Designer Signon window. |
From the File menu, click New.
In the New Definition dialog box, select App Engine Program from the Definition list.
On the App Engine Program page, a plus sign (+) is displayed besides the MAIN section. The MAIN section may contain multiple steps. Expand MAIN. A step named Step01 is added to MAIN.
Rename Step01 to Language.
Click Action in the Insert menu. An action is added to the Language step.
Select PeopleCode from the list for the new action.
Click Save in the File menu, and save the Application Engine program as LOOKUP_RECON.
Double-click the PeopleCode action. A new PeopleCode window is displayed.
Copy the code from the OIM_HOME/xellerate/XLIntegrations/PSFTUM/peoplecode/languageCode.txt file into the PeopleCode window.
Change the path to a directory location on the PeopleSoft server as follows:
&DataFile = GetFile("absolute path where you want to generate the DataFile", "w", %FilePath_Absolute);
&LOGFile = GetFile("absolute path where you want to generate the LogFile", "w", "a", %FilePath_Absolute);
For example:
&DataFile = GetFile("C:\PSFT_849_LOOKUPS\language.properties", "w", %FilePath_Absolute);
&LOGFile = GetFile("C:\PSFT_849_LOOKUPS\language.log", "w", "a", %FilePath_Absolute);
|
Note: Ensure that the name of the file ends in.properties. For example, language.properties. |
Save the PeopleCode action, and close the window.
On the App Engine Program page, select the language step and then select Step/Action from the Insert menu.
Repeat Steps 5 through 12 to create the remaining steps, which are listed in the following table:
| Step Name | File Containing the Required PeopleCode |
|---|---|
Currency |
CurrencyCode.txt |
userrole |
UserRoles.txt |
permiss |
PermissionList.txt |
EmailType |
EmailType.txt |
Save the Application Engine program.
Creating the Application Engine Program If PeopleSoft Application Designer Project Is Imported
To create the Application Engine program if you have imported the PeopleSoft Application Designer Project as described in Section 2.1.2.1, "Importing a Project from Application Designer," you must perform the following tasks:
To open Application Designer in 2-tier mode, click Start, Programs, Peoplesoft8.x, and then Application Designer.
From the File menu, select Open and then select Project. Search for and open the project OIM_UM.
The Open Definition dialog box appears.
In the Name field, enter OIM_UM as the project name and then click Open.
The project appears in the left pane.
Click the plus sign (+) below Application Engine Programs.
Double-click LOOKUP_RECON in the left pane.
The LOOKUP_RECON (App Engine Program) window appears in the right pane.
Double-click the PeopleCode action associated with Step01 - "Currency Code". A new PeopleCode window is displayed.
Change the path to a directory location on the PeopleSoft server as follows:
&DataFile = GetFile("absolute path where you want to generate the DataFile", "w", %FilePath_Absolute);
&LOGFile = GetFile("absolute path where you want to generate the LogFile", "w", "a", %FilePath_Absolute);
For example:
&DataFile = GetFile("C:\PSFT_849_LOOKUPS\currencycodes.properties", "w", %FilePath_Absolute);
&LOGFile = GetFile("C:\PSFT_849_LOOKUPS\lcurrencycodes.log", "w", "a", %FilePath_Absolute);
|
Note: Ensure that the name of the file ends in.properties. For example, language.properties. |
Save the PeopleCode action, and close the window.
Repeat Steps 6 to 8 for the remaining steps, such as Email Types, Language Codes, Permission Lists, and Roles.
Save the Application Engine program.
Configuring the target system for full reconciliation involves configuring the USER_PROFILE message by performing the following procedures:
Section 2.2.2.2.4, "Configuring the PeopleSoft Integration Broker"
Section 2.2.2.2.5, "Configuring the USER_PROFILE Service Operation"
EI Repository is a hidden folder in PeopleSoft. Therefore, you must display this folder.
To display the EI Repository folder:
|
Note: Perform this procedure using the PeopleSoft administrator credentials. |
In the PeopleSoft Internet Architecture, expand People Tools, Portal, and then Structure and Content.
Click the Enterprise Components link.
Click the Edit link for EI Repository, and then uncheck Hide from portal navigation.
The Hide from portal navigation check box is shown in the following screenshot:
Click Save.
Log out, and then log in.
You must activate the USER_PROFILE message so that it can be processed.
To activate USER_PROFILE messages:
In the PeopleSoft Internet Architecture, expand Enterprise Components, EI Repository, and then click Message Properties.
Search for and open the USER_PROFILE message.
Click Activate All.
The message to be activated is shown in the following screenshot:
Click the Subscription tab, and activate the Subscription PeopleCode if it exists.
|
Note: To perform this step, your user profile must have the EIR Administrator role consisting of EOEI9000 and EOCO9000 permission lists. |
You must define and activate this rule, because it acts as a catalyst for the Full Reconciliation process. This rule provides the Full Reconciliation process the desired information to initiate reconciliation.
To activate the full data publish rule:
In the PeopleSoft Internet Architecture, expand Enterprise Components, Integration Definitions, and then click Full Data Publish Rules.
Search for and open the USER_PROFILE message.
In the Publish Rule Definition region:
In the Publish Rule ID field, enter OIM_USER_PROFILE.
In the Description field, enter OIM_USER_PROFILE.
From the Status list, select Active.
The following screenshot displays the preceding steps:
Click Save.
The following sections explain the procedures to configure PeopleSoft Integration Broker:
Configuring the PeopleSoft Integration Broker Gateway
PeopleSoft Integration Broker is installed as part of the PeopleTools installation process. The Integration Broker Gateway is a component of PeopleSoft Integration Broker, which runs on the PeopleSoft Web Server. It is the physical hub between PeopleSoft and the third-party system. The integration gateway manages the receipt and delivery of messages passed among systems through PeopleSoft Integration Broker.
To configure the PeopleSoft Integration Broker gateway:
Open a Web browser and enter the URL for PeopleSoft Internet Architecture.
The URL for PeopleSoft Internet Architecture is in the following format:
http://IPADDRESS:PORT/psp/ps/?cmd=login
For example:
http://172.21.109.69:9080/psp/ps/?cmd=login
To display the Gateway component details, expand PeopleTools, Integration Broker, Configuration, and then Gateways. The Gateway component details are displayed.
In the Integration Gateway ID field, enter LOCAL and then click Search. The LOCAL gateway is a default gateway that is created when you install PeopleSoft Internet Architecture.
Ensure that the IP address and host name specified in the URL of the PeopleSoft listener are those on which the target system is installed. The URL of the PeopleSoft listener is in one of the following formats:
http://HOSTNAME_of_the_PeopleSoft_Web_Server or IP_address:port/PSIGW/PeopleSoftListeningConnector
For example:
http://10.121.16.42:80/PSIGW/PeopleSoftListeningConnector
To load all target connectors that are registered with the LOCAL gateway, click Load Gateway Connectors. A window is displayed mentioning that the loading process is successful. Click OK.
Click Save.
Click Ping Gateway to check whether the gateway component is active. The PeopleTools version and the status of the PeopleSoft listener are displayed. The status should be ACTIVE.
Configuring PeopleSoft Integration Broker
PeopleSoft Integration Broker provides a mechanism for communicating with the outside world using XML files. Communication can take place between different PeopleSoft applications or between PeopleSoft and third-party systems. To subscribe to data, third-party applications can accept and process XML messages posted by PeopleSoft by using the available PeopleSoft connectors. The Integration Broker routes messages to and from PeopleSoft.
To configure PeopleSoft Integration Broker:
Create a remote node by performing the following steps:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Nodes.
On the Add a New Value tab, enter the node name, for example, OIM_FILE_NODE and then click Add.
On the Node Definition tab, provide the following values:
In the Description field, enter a description for the node.
In the Default User ID field, enter PS.
Make this node a remote node by deselecting the Local Node check box and selecting the Active Node check box.
Make the Node Type as PIA.
On the Connectors tab, search for the following information by clicking the Lookup icon:
Gateway ID: LOCAL
Connector ID: FILEOUTPUT
On the Properties page in the Connectors tab, enter the following information:
Property ID: HEADER
Property Name: sendUncompressed
Required value: Y
Property ID: PROPERTY
Property Name: Method
Required value: PUT
Property ID: PROPERTY
Property Name: FilePath
Required value: FilePath of the PeopleSoft Server
Property ID: PROPERTY
Property Name: Password
Required value: Same value as of ig.fileconnector.password in the integrationGateway.properties file
|
Note: To locate the intergrationGateway.properties file, perform the following steps using the PeopleSoft administrator credentials:
|
Click Save.
Click Ping Node to check whether a connection is established with the specified IP address.
To configure the USER_PROFILE service operation perform the following procedures:
Verifying the Queue Status for the USER_PROFILE Service Operation
Setting Up the Security for the USER_PROFILE Service Operation
Activating the USER_PROFILE Service Operation
The service operation is a mechanism to trigger, receive, transform, and route messages that provide information about updates in the PeopleSoft or an external application. You must activate the service operation for successful transmission or receipt of messages.
To activate the USER_PROFILE service operation:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
On the Find Service Operation tab, enter USER_PROFILE in the Service field, and then click Search.
Click the USER_PROFILE link.
|
Note: In PeopleSoft HRMS, there are two versions of the message associated with this service operation. But, when you integrate PeopleSoft HRMS 9.0 and Oracle Identity Manager, you must sendversion_84. So, you must use the default version, VERSION_84, for HRMS 9.0. |
In the Default Service Operation Version region, click Active. The following screenshot displays the default version of the USER_PROFILE service operation:
Click Save.
Verifying the Queue Status for the USER_PROFILE Service Operation
All messages in PeopleSoft are sent through a queue. This is done to ensure that the messages are delivered in the correct sequence. Therefore, you must ensure that the queue is in the Run status.
To ensure that the status of the queue for the USER_PROFILE service operation is Run:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Queues.
Search for the USER_PROFILE queue.
In the Queue Status list, ensure that Run is selected.
|
Note: If the queue status is not Run:
|
The queue status is shown in the following screenshot:
Click Return to Search.
Setting Up the Security for the USER_PROFILE Service Operation
The target system user who has the permission to modify, add, or delete personal or job information of an employee might not have access to send messages regarding these updates. Therefore, it is imperative to explicitly grant security to enable operations.
To set up the security for the USER_PROFILE service operation:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
Search for and open the USER_PROFILE service operation.
On the General tab, click the Service Operation Security link. The link is shown in the following screenshot:
Attach the permission list OIMUM to the USER_PROFILE service operation. This list is created in Step 3 of the preinstallation procedure discussed in Section 2.1.2.2.1, "Creating a Permission List."
To attach the permission list:
|
Note: This procedure describes how to grant access to the OIMUM permission list. The OIMUM permission list is used as an example. However, to implement this procedure you must use the permission list (attached through a role) to the user profile of the actual user who maintains the user profile information or the user who performs full reconciliation. |
Click the plus sign (+) to add a row to the Permission List field.
In the Permission List field, enter OIM and then click the Look up Permission List icon.
The OIMUM permission list appears.
From the Access list, select Full Access.
The following screenshot displays the Access list with Full Access:
Click Save.
Click Return to Search.
Defining the Routing for the USER_PROFILE Service Operation
Routing is defined to inform PeopleSoft about the origin and the intended recipient of the message. You might have to transform the message being sent or received according to the business rules.
To define the routing for the USER_PROFILE service operation:
On the Routing tab, enter USER_PROFILE_HR_TO_UMFILE as the routing name and then click Add.
The following screenshot displays the Routing Name field:
On the Routing Definition tab, enter the following:
Sender Node: PSFT_HR
|
Note: The Sender Node is the default active local node. To locate the sender node:
|
Receiver Node: OIM_FILE_NODE
The following screenshot displays the Sender and Receiver nodes:
Click Save.
Click Return to go back to the Routings tab of the Service Operation, and verify whether your routing is active.
Configuring the target system for incremental reconciliation involves configuration of USER_PROFILE and DELETE_USER_PROFILE service operations, nodes, and routing to send messages from PeopleSoft Integration Broker to other systems, and configuring PeopleSoft Integration Broker.
The USER_PROFILE message contains information about user accounts that are created or modified. The DELETE_USER_PROFILE message contains information about user accounts that have been deleted.
A message is the physical container for the XML data that is sent from the target system. Message definitions provide the physical description of data that is sent from the target system. This data includes fields, field types, and field lengths. A queue is used to carry messages. It is a mechanism for structuring data into logical groups. A message can belong to only one queue.
Setting the PeopleSoft Integration Broker gateway is mandatory when you configure PeopleSoft Integration Broker. To subscribe to XML data, Oracle Identity Manager can accept and process XML messages posted by PeopleSoft by using PeopleSoft connectors located in the PeopleSoft Integration Broker gateway. These connectors are Java programs that are controlled by the Integration Broker gateway.
This gateway is a program that runs on the PeopleSoft Web server. It acts as a physical hub between PeopleSoft and PeopleSoft applications (or third-party systems, such as Oracle Identity Manager). The gateway manages the receipt and delivery of messages passed among systems through PeopleSoft Integration Broker.
To configure the target system for incremental reconciliation, perform the following procedures:
|
Note: You must use an administrator account to perform the following procedures. |
The following sections explain the procedures to configure PeopleSoft Integration Broker:
Configuring the PeopleSoft Integration Broker Gateway
The Integration Broker Gateway is a component of PeopleSoft Integration Broker (a messaging system), which is deployed at the PeopleSoft Web server. The Integration Broker Gateway is used for sending messages from PeopleSoft and for receiving messages for PeopleSoft. The "Configuring the PeopleSoft Integration Broker Gateway" describes the procedure to configure the PeopleSoft Integration Broker gateway.
Configuring PeopleSoft Integration Broker
Integration Broker is the inherent messaging system of PeopleSoft. You must configure Integration Broker to send and receive messages from and to PeopleSoft.
To configure PeopleSoft Integration Broker:
Create a remote node by performing the following steps:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Nodes.
On the Add a New Value tab, enter the node name, for example, OIM_NODE, and then click Add.
On the Node Definition tab, enter a description for the node in the Description field. In addition, enter PS in the Default User ID field.
Make this node a remote node by deselecting the Local Node check box and selecting the Active Node check box.
Make the Node Type as PIA.
On the Connectors tab, search for the following information by clicking on the Lookup icon:
Gateway ID: LOCAL
Connector ID: HTTPTARGET
On the Properties subpage in the Connectors tab, enter the following information:
Property ID: HEADER
Property Name: sendUncompressed
Required value: Y
Property ID: HTTP PROPERTY
Property Name: Method
Required value: POST
Property ID: HEADER
Property Name: Host
Required value: Enter the value of the IT resource name as configured for the target system.
Sample value: PSFT Server
Property ID: PRIMARYURL
Property Name: URL
Required value: Enter the URL of the PeopleSoft listener that is configured to receive XML messages. This URL must be in the following format:
http://HOSTNAME_of_OIM_SERVER or IPADDRESS:PORT/
PeopleSoftOIMListener
The URL depends on the application server that you are using. For an environment on which SSL is not enabled, the URL must be in the following format:
For IBM WebSphere Application Server:
http://10.121.16.42:9080/PeopleSoftOIMListener
For JBoss Application Server:
http://10.121.16.42:8080/PeopleSoftOIMListener
For Oracle WebLogic Server:
http://10.121.16.42:7001/PeopleSoftOIMListener
For an environment on which SSL is enabled, the URL must be in the following format:
https://COMMON_NAME:PORT/PeopleSoftOIMListener
For IBM WebSphere Application Server:
https://example088196:9443/PeopleSoftOIMListener
For JBoss Application Server:
https://example088196:8443/PeopleSoftOIMListener
For Oracle WebLogic Server:
https://example088196:7002/PeopleSoftOIMListener
Click Save to save the changes.
Click Ping Node to check whether a connection is established with the specified IP address.
Perform the following procedures to configure the service operations:
Configuring the USER_PROFILE Service Operation
The USER_PROFILE message contains information about user accounts that are created or modified.
To configure the USER_PROFILE service operation:
|
Note: See Section 2.2.2.2.5, "Configuring the USER_PROFILE Service Operation" for performing the initial configuration steps. This section describes the additional steps required for configuration. |
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
Search for and open the USER_PROFILE service operation.
On the Routing tab, enter USER_PROFILE_HR_TO_OIM as the routing name and then click Add.
The following screenshot displays the Routing Name field:
On the Routing Definition tab, enter the following:
Sender Node: PSFT_HR
|
Note: The Sender Node is the default active local node. To locate the sender node:
|
Receiver Node: OIM_NODE
The following screenshot displays the Sender and Receiver nodes:
Click Save.
Click Return to go back to the Routings tab of the Service Operation and verify whether your routing is active.
Configuring the DELETE_USER_PROFILE Service Operation
The DELETE_USER_PROFILE message contains information about user accounts that have been deleted. To configure the DELETE_USER_PROFILE service operation perform the following procedures:
Verifying the Queue Status for the DELETE_USER_PROFILE Service Operation
Setting Up the Security for the DELETE_USER_PROFILE Service Operation
Defining the Routing for the DELETE_USER_PROFILE Service Operation
Activating the DELETE_USER_PROFILE Service Operation
To activate the DELETE_USER_PROFILE service operation:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
On the Find Service Operation tab, enter DELETE_USER_PROFILE in the Service field, and then click Search.
Click the DELETE_USER_PROFILE link.
In the Default Service Operation Version region, click Active.
The following screenshot displays the Active check box:
Click Save.
Verifying the Queue Status for the DELETE_USER_PROFILE Service Operation
To ensure that the status of the queue for the DELETE_USER_PROFILE service operation is Run:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Queues.
Search for the DELETE_USER_PROFILE queue.
In the Queue Status List, ensure that Run is selected.
|
Note: If the queue status is not Run:
|
The following screenshot displays the queue status:
Click Return to Search.
Setting Up the Security for the DELETE_USER_PROFILE Service Operation
To set up the security for the DELETE_USER_PROFILE service operation:
In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
Search for and open the DELETE_USER_PROFILE service operation.
On the General tab, click the Service Operation Security link.
The link is shown in the following screenshot:
Attach the permission list OIMUM, created as a part of the preinstalltion, in Step 3, (See Section 2.1.2.2.1, "Creating a Permission List") to the USER_PROFILE service operation.
To attach the permission list:
|
Note: This procedure describes how to grant access to the OIMUM permission list. The OIMUM permission list is used as an example. However, to implement this procedure you must use the permission list (attached through a role) to the user profile of the actual user who maintains the user profile information. |
Click the plus sign (+) to add a row for the Permission List field.
In the Permission List field, enter OIM and then click the Look up Permission List icon.
The OIMUM permission list appears.
From the Access list, select Full Access.
The following screenshot displays the Access list:
Click Save.
Click Return to Search.
Defining the Routing for the DELETE_USER_PROFILE Service Operation
To define the routing for the DELETE_USER_PROFILE service operation:
On the Routing tab, enter DELETE_USER_PROFILE_HR_TO_OIM as the routing name and then click Add. The following screenshot displays the routing information:
On the Routing Definition tab, enter the following:
Sender Node: PSFT_HR
|
Note: The Sender Node is the default active local node. To locate the sender node:
|
Receiver Node: OIM_NODE
The following screenshot displays the Sender and Receiver nodes:
Click Save.
Click Return to go back to the Routings tab of the Service Operation, and verify whether your routing is active.
To configure the target system for provisioning, create the APIs for the component interface as follows:
To open the Application Designer, click Start and then select Programs, Peoplesoft8.x, and Application Designer.
On the Application Designer page, click Open from the File menu.
In the Open Definition dialog box, select Component Interface from the Definition list.
Enter USER_PROFILE in the Name field, and then press Enter.
All the component interfaces with names that start with USER_PROFILE are displayed in the Open Definition dialog box.
Double-click the USER_PROFILE entry.
If you are not authorized to perform any action on the USER_PROFILE component interface:
Log in to Application Designer with administrator credentials.
From the Go menu, select Definition Security.
A new console PS Definition Security appears.
From the File menu select Open, and then select Group.
The Definition Security Open dialog box appears.
From the Group ID list, select PEOPLETOOLS, and then click OK.
The PS Definition Security - Group ID : PEOPLETOOLS window appears.
From the list, select Component Interfaces.
From the Component Interfaces list, select USER_PROFILE and DELETE_USER_PROFILE. Click the right arrow to move these to the Excluded Component Interfaces: list.
From the File menu, select Save.
From the File menu, select Open.
The Open Definition window appears.
In the Name field, enter USER_PROFILE, and then click Open.
The properties of the USER_PROFILE component interface are displayed in the Definition matching selection criteria: region.
Double-click the USER_PROFILE entry.
From the Build menu, select PeopleSoft APIs. The Build PeopleSoft API Bindings dialog box is displayed.
In the Java Classes region of the Build PeopleSoft API Bindings dialog box, select the Build check box.
|
Note: Ensure that the other check boxes are unchecked. |
From the Select APIs to Build list, select the following APIs:
CompIntfc.CompIntfcPropertyInfo
CompIntfc.CompIntfcPropertyInfoCollection
PeopleSoft.CompintfcCollection
PeopleSoft.Property
PeopleSoft.PropertyList
PeopleSoft.PSMessage
PeopleSoft.PSMessageCollection
PeopleSoft.RegionalSettings
PeopleSoft.Session
PeopleSoft.TraceSettings
CompIntfc.DELETE_USER_PROFILE
CompIntfc.DELETE_USER_PROFILECollection
APIs with names that start with CompIntfc.USER_PROFILE
In the Target Directory field, enter the path for the directory where you want to create the Java API classes, and then click OK.
Ensure that the psjoa.jar file is included in the CLASSPATH environment variable. This file is located in the PEOPLESOFT_HOME/web/psjoa directory.
Compile the APIs from the target directory specified in Step 11. To do so:
Specify the JAVA_HOME environment variable.
In the command prompt, run the following command in the directory that you specified in Step 10 of this procedure:
%JAVA_HOME%\bin\javac PeopleSoft\Generated\CompIntfc\*.java
Bundle the compiled class files in a JAR named peoplesoft.jar, as follows:
Copy all the .class files into the following directory:
temp\PeopleSoft\Generated\CompIntfc
|
Note: This directory should contain only .class files. |
Run the following command while being in the temp directory:
jar -cvf peoplesoft.jar *.*
Postinstallation information is divided across the following sections:
Postinstallation on Oracle Identity Manager consists of the following procedures:
|
Note: In a clustered environment, you must perform these procedures on each node of the cluster. |
Section 2.3.1.1, "Clearing Content Related to Connector Resource Bundles from the Server Cache"
Section 2.3.1.3, "Setting Up the Lookup.PSFT.UM.ExclusionList Lookup Definition"
Section 2.3.1.4, "Setting Up the Lookup.PSFT.UM.UserProfile.UserStatus Lookup Definition"
Section 2.3.1.5, "Setting Up the Lookup.PSFT.Configuration Lookup Definition"
While you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle to 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, switch 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 delete from the server cache. Refer to the following file for information about the other content categories:
OIM_HOME/xellerate/config/xlconfig.xml
When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during 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:
IBM WebSphere Application Server
To enable logging:
Make the following changes in the OIM_HOME/xellerate/config/log.properties:
Search for the following line:
log4j.rootLogger=WARN,stdout
Make this line a comment and remove the comment the line preceding this line.
Locate and remove the comment from following lines:
#log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.logfile.DatePattern='.'yyyy-MM-dd
#log4j.appender.logfile.File=DIRECTORY_PATH/xel.log
#log4j.appender.logfile.MaxBackupIndex=20
#log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
#log4j.appender.logfile.layout.ConversionPattern=%p %t %c - %m%n
Specify the name and the location of the file to which the preceding logs have to be written. You can do this by changing the value of the following line:
log4j.appender.logfile.File=c:/oracle/xellerate/logs/xel.log
Replace c:/oracle/xellerate/logs with a valid directory location.
Add the following line in the OIM_HOME/xellerate/config/log.properties file:
log4j.logger.OIMCP.PSFTUM=log_level
log4j.logger.OIMCP.PSFTCOMMON=LOG_LEVEL
In this line, replace log_level with the log level to set.
For example:
log4j.logger.OIMCP.PSFTUM=DEBUG log4j.logger.OIMCP.PSFTCOMMON=DEBUG
After you enable logging, the log information is written to the following file:
DIRECTORY_PATH/xel.log
JBoss Application Server
To enable logging:
In the JBOSS_HOME/server/default/conf/jboss-log4j.xml file, add the following lines:
<category name="OIMCP.PSFTUM">
<priority value="log_level"/>
</category>
<category name="OIMCP.PSFTCOMMON">
<priority value="LOG_LEVEL"/>
</category>
In case of cluster, make the changes in the following file:
JBOSS_HOME/server/all/conf/jboss-log4j.xml
In these lines, replace log_level with the log level that you want to set. For example:
<category name="OIMCP.PSFTUM"> <priority value="DEBUG"/> </category> <category name="OIMCP.PSFTCOMMON"> <priority value="DEBUG"/> </category>
After you enable logging, the log information is written to the following file:
JBOSS_HOME\server\default\log\server.log
In case of cluster, the log information is written to the following file:
JBOSS_HOME\server\all\log\server.log
Oracle WebLogic Server
To enable logging:
Make the following changes in the OIM_HOME/xellerate/config/log.properties:
Search for the following line:
log4j.rootLogger=WARN,stdout
Make this line a comment and remove the comment the line preceding this line.
Locate and remove the comment from the following lines:
#log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.logfile.DatePattern='.'yyyy-MM-dd
#log4j.appender.logfile.File=DIRECTORY_PATH/xel.log
#log4j.appender.logfile.MaxBackupIndex=20
#log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
#log4j.appender.logfile.layout.ConversionPattern=%p %t %c - %m%n
Specify the name and the location of the file to which the preceding logs have to be written. You can do this by changing the value of the following line:
log4j.appender.logfile.File=c:/oracle/xellerate/logs/xel.log
Replace c:/oracle/xellerate/logs with a valid directory location.
Add the following line in the OIM_HOME/xellerate/config/log.properties file:
log4j.logger.OIMCP.PSFTUM=log_level
In this line, replace log_level with the log level that you want to set.
For example:
log4j.logger.OIMCP.PSFTUM=DEBUG
After you enable logging, the log information is written to the following file:
DIRECTORY_PATH/xel.log
In the Lookup.PSFT.UM.ExclusionList lookup definition, enter the user IDs of target system accounts for which you do not want to perform reconciliation and provisioning. See Section 1.5.2.3.4, "Lookup.PSFT.UM.ExclusionList" for more information about this lookup definition.
On the Design Console, expand Administration and then double-click Lookup Definition.
Search for and open the Lookup.PSFT.UM.ExclusionList lookup definition.
Click Add.
|
Note: The Code Key represents the resource object field name on which the exclusion list is applied during reconciliation. In provisioning, the exclusion list is applied to User Id (OPRID) by default. |
In the Code Key and Decode columns, enter the first user ID to exclude.
Repeat Steps 3 and 4 for all the user IDs to exclude.
For example, if you do not want to provision users with user ID 's User001, User002, and User088 then you must populate the lookup definition with the following values:
| Code Key | Decode |
|---|---|
| User ID | User001~User002~User088 |
Click the Save icon.
The lookup provides the mapping between the ACCTLOCK node in the USER_PROFILE message XML and the status to be shown on Oracle Identity Manager for the employee. See Section 1.5.2.1.4, "Lookup.PSFT.UM.UserProfile.UserStatus" for more information about this lookup definition.
You can change the Decode value in this lookup definition for the Code Key to modify the status of the provisioned resource. For example, you can change the Decode value from Enabled to Provisioned for the Code Key 0 defined in this lookup definition. This enables you to modify the status of the provisioned resource from Enabled to Provisioned.
To modify or set the Decode value in this lookup definition:
On the Design Console, expand Administration and then double-click Lookup Definition.
Search for and open the Lookup.PSFT.UM.UserProfile.UserStatus lookup definition.
Click Add.
In the Decode column for the Code Key, enter the following value.
Code Key: 0
Decode: Provisioned
Click the Save icon.
Every standard PeopleSoft message has a message-specific configuration defined in the Lookup.PSFT.Configuration lookup definition. See Section 1.5.2.3.1, "Lookup.PSFT.Configuration" for more information about this lookup definition.
For example, the mapping for the USER_PROFILE message in this lookup definition is defined as follows:
Code Key: USER_PROFILE
Decode: Lookup.PSFT.Message.UserProfile.Configuration
You can configure the message names, such as USER_PROFILE and DELETE_USER_PROFILE defined in this lookup definition.
Consider a scenario in which the target system sends the USER_PROFILE.VERSION_3 message. You must change the Code Key value in this lookup definition to implement the message sent by the target system.
To modify or set the Code Key value:
On the Design Console, expand Administration and then double-click Lookup Definition.
Search for and open the Lookup.PSFT.Configuration lookup definition.
Click Add.
In the Code Key column, enter the name of the message you want to modify. In this scenario define the mapping as follows:
Code Key: USER_PROFILE.VERSION_3
Decode: Lookup.PSFT.Message.UserProfile.Configuration
Repeat Steps 3 and 4 to rename the DELETE_USER_PROFILE message name.
Click the Save icon.
The following sections describe the procedure to configure SSL connectivity between Oracle Identity Manager and the target system:
Section 2.3.1.6.1, "Configuring SSL on IBM WebSphere Application Server"
Section 2.3.1.6.2, "Configuring SSL on JBoss Application Server"
Section 2.3.1.6.3, "Configuring SSL on Oracle WebLogic Server"
You can configure SSL connectivity on IBM WebSphere Application Server with either a self-signed certificate or a CA certificate. The following sections describe this:
Configuring SSL on IBM WebSphere Application Server with a Self-Signed Certificate
Configuring SSL on IBM WebSphere Application Server with a CA Certificate
Configuring SSL on IBM WebSphere Application Server with a Self-Signed Certificate
To configure SSL connectivity between Oracle Identity Manager on IBM WebSphere Application Server and the target system with a self-signed certificate, you must perform the following tasks:
Log in to the WebSphere Integrated Solutions Console. The URL may be similar to the following:
https://localhost:9043/ibm/console/logon.jsp
Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore, and then click Personal certificates.
Click Create a self-signed certificate.
In the Alias field, enter an alias name. You specify the alias name to identify the certificate request in the keystore.
In the CN field, enter a value for common name. The common name must be the fully qualified DNS host name or the name of the computer. The CN of the certificate must match the domain name or the name of the computer. For example, if the name of your domain is us.example.com, then the CN of the SSL certificate that you create for your domain must also be us.example.com.
In the Organization field, enter an organization name.
In the Organization unit field, specify the organization unit.
In the Locality field, enter the locality.
In the State or Province field, enter the state.
In the Zip Code field, enter the zip code.
From the Country or region list, select the country code.
Click Apply and then Save.
Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore, and then click Personal certificates.
Select the check box for the new alias name.
Click Extract.
Specify the absolute file path where you want to extract the certificate under the certificate file name, for example, C:\SSLCerts\sslcert.cer.
Click Apply and then click OK.
Configuring SSL on IBM WebSphere Application Server with a CA Certificate
To configure SSL connectivity between Oracle Identity Manager on IBM WebSphere Application Server and the target system with a CA certificate, you must perform the following tasks:
Log in to the WebSphere Integrated Solutions Console. The URL may be similar to the following:
https://localhost:9043/ibm/console/logon.jsp
Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore.
On the Additional Properties tab, click Personal certificate requests.
Click New.
In the File for certificate request field, enter the full path where the certificate request is to be stored, and a file name. For example: c:\servercertreq.arm (for a computer running on Microsoft Windows).
In the Key label field, enter an alias name. You specify the alias name to identify the certificate request in the keystore.
In the CN field, enter a value for common name. The common name must be the fully-qualified DNS host name or the name of the computer. The CN of the certificate must match the domain name of your community. For example, if the name of your domain is us.example.com, then the CN of the SSL certificate that you create for your community must also be us.example.com.
In the Organization field, enter an organization name.
In the Organization unit field, specify the organization unit.
In the Locality field, enter the locality.
In the State or Province field, enter the state.
In the Zip Code field, enter the zip code.
From the Country or region list, select the country code.
Click Apply and then Save. The certificate request is created in the specified file location in the keystore. This request functions as a temporary placeholder for the signed certificate until you manually receive the certificate in the keystore.
|
Note: Keystore tools such as iKeyman and keyTool cannot receive signed certificates that are generated by certificate requests from IBM WebSphere Application Server. Similarly, IBM WebSphere Application Server cannot accept certificates that are generated by certificate requests from other keystore utilities. |
Send the certification request arm file to a CA for signing.
Create a backup of your keystore file. You must create this backup before receiving the CA-signed certificate into the keystore. The default password for the keystore is WebAS. The Integrated Solutions Console contains the path information for the location of the keystore. The path to the NodeDefaultKeyStore is listed in the Integrated Solutions Console as:
was_profile_root\config\cells\cell_name\nodes\node_name\key.p12
Now you can receive the CA-signed certificate into the keystore to complete the process of generating a signed certificate for IBM WebSphere Application Server.
To receive a signed certificate issued by a CA, perform the following tasks:
In the WebSphere Integrated Solutions Console, click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore, and then click Personal Certificates.
Click Receive a certificate from a certificate authority.
Enter the full path and name of the certificate file.
Select the default data type from the list.
Click Apply and then Save.
The keystore contains a new personal certificate that is issued by a CA. The SSL configuration is ready to use the new CA-signed personal certificate.
Before configuring SSL on JBoss Application Server, ensure the following:
JBoss Application Server is installed on the Oracle Identity Manager host computer
Java Runtime Environment is installed on the JBoss Application Server host
You can configure SSL connectivity on JBoss Application Server with either a self-signed certificate or a CA certificate. The following sections describe this. If you are configuring SSL on JBoss Application Server with a self-signed certificate, then perform the following tasks:
If you are configuring SSL on JBoss Application Server with a CA certificate, then perform the following tasks:
Creating the Self-Signed Certificate
To create the self-signed certificate, see "Generating Keystore".
Importing a CA Certificate
To import a CA certificate, perform the following tasks:
Run the following command:
keytool -genkey -alias ALIAS_NAME -keystore ABSOLUTE_KEYSTORE_PATH -keyalg KEY_ALGORITHM -storepass KEYSTORE_PASSWORD -keypass PRIVATE_KEY_PASS
For example:
keytool -genkey -alias example088196 -keystore c:\temp\keys\custom.keystore -keyalg RSA -storepass example1234 -keypass example1234
|
Note: - The keystore password and the private key password must be the same. - Typically, the alias is the name or the IP address of the computer on which you are configuring SSL. - The alias used in the various commands of this procedure must be the same. |
When prompted, enter the information about the certificate, such as company and contact name. This information is displayed to employees attempting to access a secure page in the application. This is illustrated in the following example:
What is your first and last name? [Unknown]: Must be the name or IP address of the computer What is the name of your organizational unit? [Unknown]: example What is the name of your organization? [Unknown]: example What is the name of your City or Locality? [Unknown]: New York What is the name of your State or Province? [Unknown]: New York What is the two-letter country code for this unit? [Unknown]: US Is <CN=Name or IP address of the computer, OU=example, O=example, L=New York, ST=New York, C=US> correct? [no]: yes
When you enter yes in the last line of the preceding example, the custom keystore file is created in the c:\temp\keys\ directory.
Generate the certificate signing request by running the following command:
keytool -certreq -alias ALIAS_NAME -file ABSOLUTE_CSR_PATH -keystore ABSOLUTE_KEYSTORE_PATH
For example:
keytool -certreq -alias example088196 -file c:\temp\keys\certReq.csr -keystore c:\temp\keys\custom.keystore
Submit the certReq.csr file on a CA Web site for downloading the CA certificate.
Ensure that your %JAVA_HOME%\jre\lib\security\cacerts has the root certificate of the CA that has generated the CA certificate.
To check all the root certificates that %JAVA_HOME%\jre\lib\security\cacerts contains, run the following command:
keytool -list -keystore %JAVA_HOME%\jre\lib\security\cacerts -storepass cacerts_store_password
For example:
%JAVA_HOME%\jre\bin\keytool -list -keystore %JAVA_HOME%\jre\lib\security\cacerts -storepass changeit
If the %JAVA_HOME%\jre\lib\security\cacerts keystore does not contain the root certificate of CA that has generated the CA certificate, then you must import the root certificate of CA into %JAVA_HOME%\jre\lib\security\cacerts.
Run the following command to import the root certificate of CA:
keytool -import -alias <cacerts_key_entry_alias> -file <CARootCertificate.cer> -keystore %JAVA_HOME%\jre\lib\security\cacerts -storepass cacerts_store_password
For example:
keytool -import -alias cakey -file "C:\temp\Thawte Test Root.cer" -keystore %JAVA_HOME%\jre\lib\security\cacerts -storepass changeit
The certificate is added to the keystore.
Import the CA certificate by running the following command:
keytool -import -alias ALIAS_NAME -keystore ABSOLUTE_KEYSTORE_PATH -trustcacerts -file ABSOLUTE_CACERT_PATH
ABSOLUTE_CACERT_PATH represents the path in which you have stored the certificate downloaded from CA.
For example:
keytool -import -alias example088196 -keystore c:\temp\keys\custom.keystore -trustcacerts -file c:\temp\keys\CACert.cer
When you run this command, you are prompted for the keystore password, as shown:
Enter keystore password: example1234 [Enter] Owner: CN=Thawte Test CA Root, OU=TEST TEST TEST, O=Thawte Certification, ST=FOR TESTING PURPOSES ONLY, C=ZA Issuer: CN=Thawte Test CA Root, OU=TEST TEST TEST, O=Thawte Certification, ST=FOR TESTING PURPOSES ONLY, C=ZA Serial number: 0 Valid from: Thu Aug 01 05:30:00 GMT+05:30 1996 until: Fri Jan 01 03:29:59 GMT+05:30 2021 Certificate fingerprints: MD5: 5E:E0:0E:1D:17:B7:CA:A5:7D:36:D6:02:DF:4D:26:A4 SHA1: 39:C6:9D:27:AF:DC:EB:47:D6:33:36:6A:B2:05:F1:47:A9:B4:DA:EA Trust this certificate? [no]: yes [Enter]
In this example, the instances when you can press Enter are shown in bold.
Moving the Keystore
To move the certificate to a JBoss Application Server directory, copy the generated keystore to the conf directory of your JBoss installation. For example, the directory can be C:\Program Files\jboss-4.0.3\server\default\conf\.
Updating the Configuration File
Before updating the configuration file, shut down JBoss Application Server. The JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml file contains information about what Web features to enable when the server starts. Inside this file, there is a part that looks similar to the following:
<!-- SSL/TLS Connector configuration using the admin devl guide keystore
<Connector port="8443" address="${jboss.bind.address}"
maxThreads="100" strategy="ms" maxHttpHeaderSize="8192"
emptySessionPath="true"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${jboss.server.home.dir}/conf/chap08.keystore"
keystorePass="rmi+ssl" sslProtocol = "TLS" />
-->
In the code, make the following changes:
Remove the comment from the block of code.
Change the value of Connector port to 443 (default SSL port).
Change the value of keystoreFile to the absolute path of the keystore generated in "Generating Keystore".
Change the value of keystorePass to the password of the keystore.
After the changes are made, the code block looks similar to the following:
<!-- SSL/TLS Connector configuration using the admin devl guide keystore -->
<Connector port="443" address="${jboss.bind.address}"
maxThreads="100" strategy="ms" maxHttpHeaderSize="8192"
emptySessionPath="true"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${jboss.server.home.dir}/conf/ custom.keystore"
keystorePass=" example1234 " sslProtocol = "TLS" />
<!-- -->
SSL is now enabled. You can restart JBoss Application Server and browse to the following URL to verify whether SSL is enabled:
https://localhost:443
You can configure SSL connectivity on Oracle WebLogic Server with either a self-signed certificate or a CA certificate. The following sections describe the procedures:
Configuring SSL on Oracle WebLogic Server with a Self-Signed Certificate
Configuring SSL on Oracle WebLogic Server with a CA Certificate
Configuring SSL on Oracle WebLogic Server with a Self-Signed Certificate
To configure SSL connectivity between Oracle Identity Manager on Oracle WebLogic Server and the target system with a self-signed certificate, you must perform the following tasks:
Generating Keystore
To generate the keystore:
Run the following command:
keytool -genkey -keystore ABSOLUTE_KEYSTORE_PATH -alias ALIAS_NAME -keyalg KEY_ALGORITHM -storepass KEYSTORE_PASSWORD -keypass PRIVATE_KEY_PASSWORD
For example:
keytool -genkey -keystore c:\temp\keys\keystore.jks -alias example088196 -keyalg RSA -storepass example1234 -keypass example1234
|
Note: - The keystore password and the private key password must be the same. - Typically, the alias is the name or the IP address of the computer on which you are configuring SSL. - The alias used in the various commands of this procedure must be the same. |
When prompted, enter information about the certificate. This information is displayed to users attempting to access a secure page in the application. This is illustrated in the following example:
keytool -genkey -keystore c:\temp\keys\keystore.jks -alias example088196 -keyalg RSA -storepass example1234 -keypass example1234 What is your first and last name? [Unknown]: Must be the name or IP address of the computer What is the name of your organizational unit? [Unknown]: example What is the name of your organization? [Unknown]: example What is the name of your City or Locality? [Unknown]: New York What is the name of your State or Province? [Unknown]: New York What is the two-letter country code for this unit? [Unknown]: US Is <CN=Name or IP address of the computer, OU=example, O=example, L=New York, ST=New York, C=US> correct? [no]: yes
When you enter yes in the last line of the preceding example, the keystore.jks file is created in the c:\temp\keys\directory.
Export the keystore to a certificate file by running the following command:
keytool -export -alias ALIAS_NAME -keystore ABSOLUTE_KEYSTORE_PATH -file CERTIFICATE_FILE_ABSOLUTE_PATH
For example:
keytool -export -alias example088196 -keystore c:\temp\keys\keystore.jks -file c:\temp\keys\keystore.cert
When prompted for the private key password, enter the same password used for the keystore, for example, example1234.
Import the keystore by running the following command:
keytool -import -alias ALIAS_NAME -keystore NEW_KEYSTORE_ABSOLUTE_PATH -file CERTIFICATE_FILE_ABSOLUTE_PATH
For example:
keytool -import -alias example088196 -keystore c:\temp\keys\new.jks -file c:\temp\keys\keystore.cert
When you run this command, it prompts for the keystore password, as shown in the following example:
Enter keystore password: example1234 [Enter] Trust this certificate? [no]: yes [Enter] Certificate was added to keystore
In this example, the instances when you can press Enter are shown in bold.
Configuring Oracle WebLogic Server
After generating and importing the keystore, start Oracle WebLogic Server. To configure Oracle WebLogic Server:
Log in to the Oracle WebLogic Server console at http://localhost:7001/console and perform the following:
Expand the servers node and select the server instance.
Select the General tab.
Select the SSL Listen Port Enabled option.
Ensure that a valid port is specified in the SSL Listen Port field. The default port is 7002.
Click Apply to save your changes.
Click the Keystore & SSL tab, and then click Change.
From the Keystores list, select Custom identity And Java Standard Trust, and then click Continue.
Configure the keystore properties. To do so:
In the Custom Identity Key Store File Name column, specify the full path of the keystore generated in Step 1 of "Generating Keystore", for example, c:\temp\keys\keystore.jks. In the Custom Identity Key Store Type column, specify the type of keystore, for example, JKS. In the Custom Identity Key Store Pass Phrase and Confirm Custom Identity Key Store Pass Phrase columns, specify the keystore password.
Provide the Java standard trust keystore pass phrase and the Confirm Java standard trust keystore pass phrase. The default password is changeit, unless you change the password.
Click Continue.
Specify the private key alias, pass phrase and the confirm pass phrase as the keystore password. Click Continue.
Click Finish.
Restart Oracle WebLogic Server. If the server starts successfully with the SSL configuration, then lines similar to the following are recorded in the startup log:
<Apr 21, 2008 2:35:43 PM GMT+05:30> <Notice> <WebLogicServer> <BEA-000355> <Thread "ListenThread.Default" listening on port 7001, ip address *.*> <Apr 21, 2008 2:35:43 PM GMT+05:30> <Notice> <WebLogicServer> <BEA-000355> <Thread "SSLListenThread.Default" listening on port 7002, ip address *.*>
|
Note: 7002 is the default SSL port for Oracle WebLogic Server. |
Configuring SSL on Oracle WebLogic Server with a CA Certificate
To configure SSL connectivity between Oracle Identity Manager on Oracle WebLogic Server and the target system with a CA certificate, you must perform the following tasks:
|
Note: Although this is an optional step in the deployment procedure, Oracle strongly recommends that you configure SSL communication between the target system and Oracle Identity Manager. |
Generating Keystore
The connector requires Certificate Services to be running on the host computer. To generate the keystore:
Run the following command:
keytool -genkey -keystore ABSOLUTE_KEYSTORE_PATH -alias ALIAS_NAME -keyalg KEY_ALGORITHM -storepass KEYSTORE_PASSWORD -keypass PRIVATE_KEY_PASSWORD
For example:
keytool -genkey -keystore c:\temp\keys\keystore.jks -alias example088196 -keyalg RSA -storepass example1234 -keypass example1234
|
Note: The keystore password and the private key password must be the same. Typically, the alias name is the name or the IP address of the computer on which you are configuring SSL. |
When prompted, enter the information about the certificate. This information is displayed to users attempting to access a secure page in the application. This is illustrated in the following example:
keytool -genkey -keystore c:\temp\keys\keystore.jks -alias example088196 -keyalg RSA -storepass example1234 -keypass example1234 What is your first and last name? [Unknown]: Must be the name or IP address of the computer What is the name of your organizational unit? [Unknown]: example What is the name of your organization? [Unknown]: example What is the name of your City or Locality? [Unknown]: New York What is the name of your State or Province? [Unknown]: New York What is the two-letter country code for this unit? [Unknown]: US Is <CN=Name or IP address of the computer, OU=example, O=example, L=New York, ST=New York, C=US> correct? [no]: yes
When you enter yes in the last line of the preceding example, the keystore.jks file is created in the c:\temp\keys\directory.
Generate the certificate signing request by running the following command:
keytool -certreq -keystore ABSOLUTE_KEYSTORE_PATH -alias ALIAS_NAME -keyalg KEY_ALGORITHM -file CERTIFICATE_FILE_ABSOLUTE_PATH
For example:
keytool -certreq -keystore c:\temp\keys\keystore.jks -alias example088196 -keyalg RSA -file c:\temp\keys\keystore.cert
When prompted for the keystore password, enter the same password used for the keystore in Step 1, for example example1234. This stores a certificate request in the file that you specified in the preceding command.
Get the certificate from a CA by using the certificate request generated in the previous step and store the certificate in a file.
Export the keystore generated in Step 1 to a new certificate file, for example, myCert.cer, by running the following command:
keytool –export –keystore ABSOLUTE_KEYSTORE_PATH -alias alias-name specified in step 1 -file CERTIFICATE_FILE_ABSOLUTE_PATH
For example:
keytool –export –keystore c:\temp\keys\keystore.jks -alias example088196 -file c:\temp\keys\myCert.cer
Import the CA certificate to a new keystore by running the following command:
keytool -import -alias ALIAS_NAME -file CERTIFICATE_FILE_ABSOLUTE_PATH -keystore NEW_KEYSTORE_ABSOLUTE_PATH -storepass KEYSTORE_PASSWORD generated in Step 1
For example:
keytool -import -alias example088196 -file c:\temp\keys\rootCert.cert -keystore c:\temp\keys\rootkeystore.jks
When you run this command, it prompts for the keystore password, as shown:
Enter keystore password: example1234 [Enter] Trust this certificate? [no]: yes [Enter] Certificate was added to keystore
In this example, the instances when you can press Enter are shown in bold.
Configuring Oracle WebLogic Server
After creating and importing the keystore to the system, start Oracle WebLogic Server. To configure Oracle WebLogic Server:
Log in to the Oracle WebLogic Server console ((http://localhost:7001/console) and perform the following:
Expand the server node and select the server instance.
Select the General tab.
Select the SSL Port Enabled option.
Ensure that a valid port is specified in the SSL Listen Port field. The default port is 7002.
Click Apply to save your changes.
Click the Keystore & SSL tab, and click the Change link.
From the Keystores list, select Custom Identity And Custom Trust, and then click Continue.
Configure the keystore properties. To do so:
In the Custom Identity Key Store File Name column, specify the full path of the keystore generated in Step 1 of "Generating Keystore", for example, c:\temp\keys\keystore.jks. In the Custom Identity Key Store Type column, specify the type of keystore, for example, JKS. In the Custom Identity Key Store Pass Phrase and Confirm Custom Identity Key Store Pass Phrase columns, specify the keystore password.
In the Custom Trust and Custom Trust Key Store File Name column, specify the full path of the keystore generated in Step 1 of "Generating Keystore", for example, c:\temp\keys\rootkeystore.jks. In the Custom Trust Key Store Type column, specify the type of keystore, for example, JKS. In the Custom Trust Key Store Pass Phrase and Confirm Custom Trust Key Store Pass Phrase columns, specify the keystore password.
Provide the Java standard trust keystore password. The default password is changeit, unless you change the password.
Click Continue.
Specify the alias name and private key password. Click Continue.
Click Finish.
Restart Oracle WebLogic Server. If the server starts successfully with the SSL configuration, then lines similar to the following are recorded in the startup log:
<Apr 21, 2008 2:35:43 PM GMT+05:30> <Notice> <WebLogicServer> <BEA-000355> <Thread "ListenThread.Default" listening on port 7001, ip address *.*> <Apr 21, 2008 2:35:43 PM GMT+05:30> <Notice> <WebLogicServer> <BEA-000355> <Thread "SSLListenThread.Default" listening on port 7002, ip address *.*>
|
Note: 7002 is the default SSL port for Oracle WebLogic Server. |
Postinstallation on the target system consists of the following procedure:
To configure SSL on the target system:
Copy the certificate to the computer on which PeopleSoft Enterprise Applications is installed.
|
Note: If you are using IBM WebSphere Application Server, then you must download the root certificate from a CA. |
Run the following command:
PEOPLESOFT_HOME/webserv/peoplesoft/bin/pskeymanager.cmd -import
When prompted, enter the current keystore password.
When prompted, enter the alias of the certificate that you imported while performing the application server specific procedures listed in Section 2.3.1.6, "Configuring SSL."
|
Note: The alias must be the same as the one created when the keystore was generated.If you are using IBM WebSphere Application Server, then enter |
When prompted, enter the full path and name of the certificate and press Enter.
|
Note: If you are using IBM WebSphere Application Server, then enter the path of the root certificate. |
When prompted for the following:
Trust this certificate? [no]: yes
Select yes and press Enter.
Restart the Web server of the target system.
|
 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|