2 Deploying the Connector

Deploying the connector involves the following steps:

Note:

In this guide, PeopleSoft Campus is referred to as the target system.

2.1 Preinstallation

Preinstallation information is divided across the following sections:

2.1.1 Determining the Version of PeopleTools and the Target System

You might want to determine the versions of PeopleTools and the target system you are using to check whether this release of the connector supports that combination. To determine the versions of PeopleTools and the target system:

  1. Open a Web browser and enter the URL of PeopleSoft Internet Architecture. The URL of 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
    
  2. Click Change My Password. On the page that is displayed, press Ctrl+J. The versions of PeopleTools and the target system that you are using are displayed.

2.1.2 Files and Directories on the Installation Media

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/PSFT_Campus_Reconciliation-CI.xml

This XML file contains configuration information that is used during connector installation.

javadoc

This directory contains information about the Java APIs used by the connector.

lib/PSFT_CS-oim-integration.jar

This JAR file contains the class files that are specific to integration of the connector with PeopleSoft target systems.

During connector deployment, this file is copied to the Oracle Identity Manager database.

lib/PSFTCommon.jar

This JAR file contains PeopleSoft-specific files common to Campus, Employee Reconciliation, and User Management versions of the connector.

During connector deployment, this file is copied to the Oracle Identity Manager database.

The following files and directories in the listener directory:

base directory

lib/deploytool.jar

build.xml

deploy.properties

README.txt

The base directory contains the class files for the PeopleSoftOIMListener.ear file. This Enterprise Archive (EAR) file contains one or more entries representing the modules of the Web application to be deployed onto an application server.

During connector deployment, the PeopleSoft listener is deployed as an EAR file.

The deploytool.jar file contains the class files required for deploying the listeners.

The build.xml file is the deployment script, which contains configurations to deploy the listener.

The deploy.properties file contains Oracle Identity Manager connection details.

The README.txt file contains instructions to deploy, remove, and redeploy the listener.

Files in the resources directory

Each of these resource bundles contains language-specific information that is used by the connector.

During connector deployment, this file is copied to the Oracle Identity Manager database.

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.

test/config/log.properties

test/config/reconConfig.properties

These files are used by the InvokeListener.bat file. The reconConfig.properties file contains configuration information for running the InvokeListener.bat file. The log.properties file contains logger information.

test/lib/PSFTTest.jar

This JAR file is used by the testing utility for reconciliation.

test/scripts/InvokeListener.bat

test/scripts/InvokeListener.sh

This BAT file and the UNIX shell script call the testing utility for reconciliation.

xml/PeoplesoftCampus-ConnectorConfig.xml

This XML file contains definitions for the connector components.

  • Resource object

  • Process definition

  • IT resource type

  • Reconciliation rules

  • Scheduled tasks

  • Lookup definitions

2.1.3 Preinstallation on the Target System

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.

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 procedure, which has to be performed on the target system to create a user account with limited rights:

2.1.3.1 Creating a Target System User Account for Connector Operations

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 cannot access pages or components that are not required by the connector.

The following sections describe the procedures to create this target system account:

Note:

For creating the target system account, you must log in to PeopleSoft Internet Architecture with administrator credentials.

2.1.3.1.1 Creating a Permission List

To create a permission list:

  1. 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
    
  2. In the PeopleSoft Internet Architecture window, click PeopleTools, Security, Permissions & Roles, and then click Permission Lists.

  3. Click Add a new Value. On the Add a New Value tab, enter the permission list name, for example, OIMCS, and then click Add.

  4. On the General tab, enter a description for the permission list in the Description field.

  5. On the Pages tab, click the search icon for Menu Name and perform the following:

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

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

    3. Click Select All, and then click OK for each of the components. Click OK on the Components Permissions page.

    4. On the Pages tab, click the plus sign (+) to add another row for Menu Name.

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

    6. On the Component Permissions page, click Edit Pages for the PROCESSMONITOR component name.

    7. Click Select All, and then click OK. Click OK on the Components Permissions page.

    8. On the Pages tab, click the plus sign (+) to add another row for Menu Name.

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

    10. On the Component Permissions page, click Edit Pages for the PRCSDEFN component name.

    11. Click Select All, and then click OK. Click OK on the Components Permissions page.

    12. On the Pages tab, click the plus sign (+) to add another row for Menu Name.

    13. In the Menu Name lookup, enter MANAGE_INTEGRATION_RULES and then click Lookup. From the list, select MANAGE_INTEGRATION_RULES. The application returns to the Pages tab. Click Edit Components.

    14. On the Component Permissions page, click Edit Pages for the EO_EFFDTPUB component name.

    15. Click Select All, and then click OK. Click OK on the Components Permissions page. The application returns to the Pages tab.

  6. On the People Tools tab, select the Application Designer Access check box and click the Definition Permissions link. The Definition Permissions page is displayed.

  7. On this page, grant full access to the following object types by selecting Full Access from the Access list:

    • App Engine Program

    • Message

    • Component

    • Project

    • Application Package

  8. Click OK.

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

  10. Click OK. The application returns to the People Tools tab.

  11. On the Process tab, click the Process Group Permissions link. The Process Group Permission page is displayed.

  12. In the Process Group lookup, click the search icon. From the list, select TLSALL.

  13. On the Process Group Permission page, click the plus sign (+) to add another row for Process Group.

  14. In the Process Group lookup, click the search icon. From the list, select STALL. The application returns to the Process Group Permission page.

  15. Click OK.

  16. On the Web Libraries tab, click the search icon for the Web Library Name field and perform the following:

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

    2. On the WebLib Permissions page, click Full Access(All).

    3. Click OK and then click Save.

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

    5. Click Save to save all the settings specified for the permission list.

2.1.3.1.2 Creating a Role for a Limited Rights User

To create a role for a limited rights user:

  1. 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
    
  2. In the PeopleSoft Internet Architecture window, click PeopleTools, Security, Permissions & Roles, and then click Roles.

  3. Click Add a new Value. On the Add a New Value tab, enter the role name, for example, OIMCS, and then click Add.

  4. On the General tab, enter a description for the role in the Description field.

  5. On the Permission Lists tab, click the search icon and perform the following:

    1. In the Permission Lists lookup, enter OIMCS and then click Lookup. From the list, select OIMCS.

    2. Click the plus sign (+) to add another row.

    3. In the Permission Lists lookup, enter EOEI9000 and then click Lookup. From the list, select EOEI9000.

      Note:

      Permission list EOEI9000 is not available in PeopleTools 8.53, and is hence not applicable.

    4. Click the plus sign (+) to add another row.

    5. In the Permission Lists lookup, enter EOCO9000 and then click Lookup. From the list, select EOCO9000.

  6. Click Save.

2.1.3.1.3 Assigning the Required Privileges to the Target System Account

To assign the required privileges to the target system account:

  1. 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
    
  2. In the PeopleSoft Internet Architecture window, click PeopleTools, Security, User Profiles, and then click User Profiles.

  3. Click Add a new Value. On the Add a New Value tab, enter the user profile name, for example, OIMCS, and then click Add.

  4. On the General tab, perform the following:

    1. From the Symbolic ID list, select the value that is displayed. For example, SYSADM1.

    2. Enter valid values for the Password and Confirm Password fields.

    3. Click the search icon for the Process Profile permission list.

    4. In the Process Profile lookup, enter OIMCS and then click Lookup. From the list, select OIMCS. The application returns to the General tab.

  5. On the ID tab, select none as the value of the ID type.

  6. On the Roles tab, click the search icon:

    1. In the Roles lookup, enter OIMCS and then click Lookup. From the list, select OIMCS.

    2. Click the plus sign (+) to add another row.

    3. In the Roles lookup, enter ProcessSchedulerAdmin and then click Lookup. From the list, select ProcessSchedulerAdmin.

    4. Click the plus sign (+) to add another row.

    5. In the Roles lookup, enter EIR Administrator and then click Lookup. From the list, select EIR Administrator.

      Note:

      Role EIR Administrator is not available in PeopleTools 8.53, and is hence not applicable.

    6. Click Save to save this user profile. This profile is also used for a person with limited rights in PeopleSoft for performing all reconciliation-related configurations.

2.2 Installation

Installation information is divided across the following sections:

2.2.1 Installation on Oracle Identity Manager

Installation on Oracle Identity Manager consists of the following procedures:

2.2.1.1 Running the Connector Installer

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Administrative and User Console.

To run the Connector Installer:

  1. Create a directory for the connector, for example, PSFT_CS-11.1.1.5.0, in the OIM_HOME/server/ConnectorDefaultDirectory directory.

  2. Copy the contents of the connector installation media directory into directory created in Step 1.

  3. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 11.1.1:

      1. Log in to the Administrative and User Console by using the user account described in Creating the User Account for Installing Connectors in Oracle Fusion Middleware Administering Oracle Identity Manager.

      2. On the Welcome to Identity Manager Advanced Administration page, in the System Management region, click Manage Connector.

    • For Oracle Identity Manager release 11.1.2.x:

      1. Log in to Oracle Identity System Administration by using the user account described in Creating the User Account for Installing Connectors in Oracle Fusion Middleware Administering Oracle Identity Manager.

      2. In the left pane, under System Management, click Manage Connector.

  4. In the Manage Connector page, click Install.

  5. From the Connector List list, select PeopleSoft Campus 11.1.1.5.0. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

    If you have copied the installation files into a different directory, then:

    1. In the Alternative Directory field, enter the full path and name of that directory.

    2. To repopulate the list of connectors in the Connector List list, click Refresh.

    3. From the Connector List list, select PeopleSoft Campus 11.1.1.5.0.

  6. Click Load.

  7. To start the installation process, click Continue.

    The following tasks are performed, in sequence:

    1. Configuration of connector libraries

    2. Import of the connector XML files (by using the Deployment Manager)

    3. Compilation of adapter definitions

    On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure is displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:

    • Retry the installation by clicking Retry.

    • Cancel the installation and begin again from Step 1.

  8. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of steps that you must perform after the installation is displayed. These steps are as follows:

    1. Configuring the IT resource for the connector

      See Configuring the IT Resource for more information.

    2. Configuring the scheduled tasks

      See Configuring Scheduled Jobs for more information.

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

2.2.1.2 Copying the Connector Files and External Code Files

Table 2-2 lists the files that you must copy manually and the directories on the Oracle Identity Manager host computer to which you must copy them.

If the connector files are extracted to the OIM_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/ directory on the Oracle Identity Manager host computer, then there is no need to copy these files manually.

Note:

  • The directory paths given in the first column of this table correspond to the location of the connector files in the PeopleSoft Campus directory on the installation media. See Files and Directories on the Installation Media for more information about these files.

    If a particular destination directory does not exist on the Oracle Identity Manager host computer, then create it.

Table 2-2 Files to Be Copied to the Oracle Identity Manager Host Computer

File in the Installation Media Directory Destination for Oracle Identity Manager

lib/PeopleSoftOIMListener.ear

OIM_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/listener

Files in the test/scripts directory

OIM_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/scripts

Files in the test/config directory

OIM_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/config

2.2.1.3 Configuring the IT Resource

The IT resource for the target system contains connection information about the target system. Oracle Identity Manager uses this information during reconciliation.

When you run the Connector Installer, the PSFT Campus IT resource is automatically created in Oracle Identity Manager. You must specify values for the parameters of this IT resource as follows:

  1. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 11.1.1:

      Log in to the Administrative and User Console

    • For Oracle Identity Manager release 11.1.2.x:

      Log in to Oracle Identity System Administration

  2. If you are using Oracle Identity Manager release 11.1.1, then:

    1. On the Welcome page, click Advanced in the upper-right corner of the page.

    2. On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.

  3. If you are using Oracle Identity Manager release 11.1.2.x, and if you want to create a sandbox, then create application instance as follows:

    See Also:

    Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager for more information about application instance and sandbox

    1. On the upper navigation bar, click Sandboxes. The Manage Sandboxes page is displayed.

    2. On the toolbar, click Create Sandbox. The Create Sandbox dialog box is displayed.

    3. In the Sandbox Name field, enter a name for the sandbox. This is a mandatory field.

    4. In the Sandbox Description field, enter a description of the sandbox. This is an optional field.

    5. Click Save and Close. A message is displayed with the sandbox name and creation label.

    6. Click OK. The sandbox is displayed in the Available Sandboxes section of the Manage Sandboxes page.

    7. Select the sandbox that you created.

    8. On the toolbar, click Activate Sandbox.

      The table refreshes and a marker in the Active column is displayed. In addition, the Sandboxes link on the upper navigation bar also displays the active sandbox name in parentheses.

    9. In the left pane, under Configuration, click Application Instances. The Application Instances page is displayed.

    10. From the Actions menu, select Create. Alternatively, click Create on the toolbar. The Create Application Instance page is displayed.

    11. Enter the values of the attributes. For example:

      Name: PeopleSoftInstance

      Display Name: PeopleSoftInstance

      Resource Object: Affiliation

      IT Resource Instance: PSFT Campus

    12. Click Save. The application instance is created, and the details of the application instance is displayed in a page.

    13. To create a form to be associated with the application instance, open the Create Application Instance page or the Attributes tab of the Application Instance details page.

    14. Adjacent to the Forms field, click Create. The Create Form page is displayed.

    15. Enter values for the form attributes. For example:

      Resource Type: Affiliation

      Form Name: CampusForm

    16. Click Create. A message is displayed stating that the form is created.

    17. In the Create Application Instance page or the Attributes tab of the Application Instance details page, click Refresh adjacent to the Form field. The newly created form is available for selection in the Form list.

    18. Select the new form from the drop-down list and click Apply.

      The application instance is created.

    19. Before publishing the sandbox, close all the open tabs and pages.

    20. From the table showing the available sandboxes in the Manage Sandboxes page, select the sandbox that you created.

    21. On the toolbar, click Publish Sandbox. A message is displayed asking for confirmation.

    22. Click Yes to confirm. The sandbox is published and the customizations it contained are merged with the main line.

    23. Search for and run the Catalog Synchronization Job scheduled job to sync the application instance with the catalog. See Configuring Scheduled Jobs for more information about configuring and running scheduled jobs.

  4. In the left pane, under Configuration, click IT Resource.

  5. In the IT Resource Name field on the Manage IT Resource page, enter PSFT Campus and then click Search. Alternatively, from the IT Resource Type menu, select PSFT Campus, and then click Search.

  6. Click the edit icon for the IT resource.

  7. From the list at the top of the page, select Details and Parameters.

  8. Specify values for the parameters discussed in Table 2-3. The remaining parameters of IT resource are not applicable for this connector.

  9. To save the values, click Update.

2.2.1.4 IT Resource Parameters

Specify values for the parameters discussed in Table 2-3.s

Table 2-3 IT Resource Parameters

Parameter Description

Configuration Lookup

This parameter holds the name of the lookup definition that contains configuration information.

Default value: Lookup.PSFT.Campus.Configuration

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. Enter one of the following as the value of the IsActive parameter:

Enter yes as the value to specify that the target system installation represented by this IT resource is active. If you specify yes as the value, then the connector processes messages sent from this target system installation.

Enter no as the value if you do not want the connector to process messages sent from this target system installation.

Default value: Yes

2.2.1.5 Deploying the PeopleSoft Listener

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.

Note:

  • If you have already deployed a listener for the PeopleSoft User Management or Employee Reconciliation connector, then you must remove that listener and deploy the listener from the installation media of the PeopleSoft Campus connector.

  • The PeopleSoft Campus, PeopleSoft Employee Reconciliation, and PeopleSoft User Management connectors have different IT resources. Therefore, you must configure separate HTTP nodes for messages of the Campus, Employee Reconciliation, and User Management connectors.

    Even if an existing node is configured to the PeopleSoft listener on Oracle Identity Manager, a separate node is required for messages of the PeopleSoft Campus connector.

  • If you are using IBM WebSphere Application Server, perform the procedure described in Deploying the PeopleSoft Listener on WebSphere Application Server.

This section contains the following topics:

2.2.1.5.1 Setting the Prerequisites of Deploying the PeopleSoft Listener

Before deploying the PeopleSoft listener, perform the following steps:

  • Ensure Apache Ant 1.7 or later and JDK 1.6 or later are installed.

  • Set the following environment values in ant.properties:

    • ORACLE_HOME maps to the Oracle Identity Manager installation directory. For example, /ps1/beahome/Oracle_IDM1

    • ORACLE_COMMON maps to the common directory in ORACLE_HOME. For example, /ps1/beahome/Oracle_IDM1/common

    • WLS_HOME maps to the WebLogic Server directory. For example, /middleware/wlserver_10.3

    • JAVA_HOME maps to your JDK environment. For example, /usr/local/packages/jdk16/

    • PATH must include the JAVA_HOME/bin directory. You can set the PATH variable using the SET PATH=$JAVA_HOME/bin:$PATH command.

  • Build the wlfullclient.jar file in Oracle WebLogic server, for example, in the WLS_HOME/server/lib directory:

    1. Change directories to WLS_HOME/server/lib.

    2. Run the following command:

      java -jar ../../../modules/com.bea.core.jarbuilder_1.3.0.0.jar
      

      Note:

      The exact jar file version can be different based on the WebLogic Server. Use the corresponding file with the name as com.bea.core.jarbuilder at the WLS_HOME/../modules/ directory.

  • Start Oracle Identity Manager and the Admin Server.

2.2.1.5.2 Deploying the PeopleSoft Listener on Oracle Identity Manager

To deploy the PeopleSoft listener on Oracle Identity Manager:

  1. Set the Oracle Identity Manager connection details in the listener/deploy.properties file.

    The listener directory is located in the connector package directory, for example, OIM_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0.

  2. Run the following command:
    ant setup-listener
    

Note:

If you need to deploy the listener in an Oracle Identity Manager cluster, then:

  • Specify the name of the cluster for the oim.server.name property in the listener/deploy.properties file.

  • Update the following configurations appropriately with the URL of the listener, /PeopleSoftOIMListener:

    • Front-end web server

    • Load balancer

    • PeopleSoft nodes

  • Copy the connector package into the OIM_HOME/server/ConnectorDefaultDirectory directory of every node.

2.2.1.5.3 Setting the Prerequisites of Deploying the PeopleSoft Listener on WebSphere Application Server

Before deploying the PeopleSoft listener, ensure Apache Ant 1.7 or later and JDK 1.6 or later are installed. Then, set the following environment values in the ant.properties file:

  • OIM_ORACLE_HOME maps to the Oracle Identity Manager installation directory. For example, /ps1/was/Oracle_IDM1

    You can set this variable using the setenv OIM_ORACLE_HOME <value> command.

  • JAVA_HOME maps to your JDK environment. For example, /usr/local/packages/jdk16/

    You can set this variable using the setenv JAVA_HOME <value> command.

  • PATH must include the JAVA_HOME/bin directory. You can set this variable using the setenv PATH $JAVA_HOME/bin:$PATH command.

2.2.1.5.4 Deploying the PeopleSoft Listener on WebSphere Application Server

To deploy the PeopleSoft listener on IBM WebSphere Application Server:

  1. Copy the listener EAR creation scripts to the following directory:

    OIM_ORACLE_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/listener

  2. Set the Oracle Identity Manager connection details in the listener/deploy.properties file.
  3. Run the following command:
    ant setup-listener
    
  4. The listener EAR will be created in the following directory:

    OIM_ORACLE_HOME/server/ConnectorDefaultDirectory/PSFT_CS-11.1.1.5.0/listener/deployear

  5. Log in to the WebSphere Admin console.
  6. Expand Applications.
  7. Select Enterprise Applications from the list.
  8. Click Install and browse for the listener EAR directory.
  9. Select Fast Path and click Next.
  10. Under Map modules to servers, select oim_server1 to map the listener EAR file.
  11. Save the listener EAR application and start the service.
2.2.1.5.5 Importing Oracle Identity Manager CA Root Certificate into PeopleSoft WebServer

If you have configured SSL in Oracle Identity Manager, for the PeopleSoft listener to work in SSL you must import Oracle Identity Manager CA root certificate into PeopleSoft WebServer.

To do so, perform one of the following procedures depending on the PeopleSoft WebServer you are using:

  • For Oracle WebLogic Server:

    1. Identity the certificate of issuing authority, the root CA for Oracle Identity Manager.

      If you use the default demo certificate, then the root certificate is located in the following location:

      MW_HOME/wlserver_10.3/server/lib/CertGenCA.der

      If the certificate is issued by an external entity, then you must import the corresponding root certificate.

    2. Use pskeymanager to import the root certificate into PeopleSoft WebServer keystore.

  • For IBM WebSphere Application Server:

    1. Identity the certificate of issuing authority, the root CA for Oracle Identity Manager.

      In the WebSphere Admin console, navigate to Security, SSL certificate and key management, Key stores and certificates, CellDefaultTrustStore, and Signer certificates. Then, select root and click Extract.

      If the certificate is issued by a different entity, then you must import the corresponding root certificate.

    2. Use pskeymanager to import the root certificate into PeopleSoft WebServer keystore.

2.2.1.6 Removing the PeopleSoft Listener

This section contains the following topics:

Note:

  • This section is not a part of installation on Oracle Identity Manager. You might need this procedure to extend the connector.

  • If you uninstall the connector, you must also remove the listener. Installing a new connector over a previously deployed listener creates discrepancies.

  • Do not remove the listener if the PeopleSoft User Management connector is installed and if it is using the listener.

2.2.1.6.1 Removing the PeopleSoft Listener for IBM WebSphere Application Server

To remove the PeopleSoft listener:

  1. Log in to the WebSphere Admin console.
  2. Expand Applications.
  3. Select Enterprise Applications from the list.

    A list of deployed applications is shown in the right pane.

  4. Select the PeopleSoftOIMListener.ear check box.
  5. Specify the Context root as PeopleSoftOIMListener.
  6. 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.

  7. Click OK.
2.2.1.6.2 Removing the PeopleSoft Listener for Oracle WebLogic Server

From the listener directory, run the following command:

ant undeploy

To remove the PeopleSoft listener of the connector of a previous release:

  1. Log in to the Oracle WebLogic admin console.
  2. From the Domain Structure list, select OIM_DOMAIN.

    Where OIM_DOMAIN is the domain on which Oracle Identity Manager is installed.

  3. Click the Deployments tab.
  4. On Microsoft Windows, in the Change Centre window, click Lock & Edit.
  5. Select PeopleSoftOIMListener.ear. This enables the Delete button of the Control tab in the Summary Of Deployments region.
  6. Click Stop. A list appears.
  7. Select Force Stop Now.

    The Force Stop Application confirmation screen appears.

  8. Click Yes.
  9. On the Control tab in the Summary Of Deployments region, select PeopleSoftOIMListener.ear.
  10. Click Delete.

    A confirmation message appears on successful deletion of the WAR file.

  11. On the left pane, click the Active Changes button.

2.2.2 Installation on the Target System

During this stage, you configure the target system to enable it for reconciliation. This information is provided in the following sections:

2.2.2.1 Configuring the Target System for Full Reconciliation

As described in About the Connector, full reconciliation is used to reconcile all existing person data into Oracle Identity Manager.

Configuring the target system for full reconciliation involves creation of XML files for full reconciliation by performing the following procedures:

2.2.2.1.1 Configuring the PeopleSoft Integration Broker

The following sections explain the procedure to configure PeopleSoft Integration Broker:

2.2.2.1.1.1 Configuring 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:

  1. 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
    
  2. To display the Gateway component details, expand PeopleTools, Integration Broker, Configuration, and then Gateways. The Gateway component details are displayed.
  3. 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.
  4. 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
    IPADDRESS:PORT/PSIGW/PeopleSoftListeningConnector
    

    For example:

    http://10.121.16.42:80/PSIGW/PeopleSoftListeningConnector
    
  5. 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.
  6. Click Save.
  7. 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.
2.2.2.1.1.2 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 using the available PeopleSoft connectors. The Integration Broker routes messages to and from PeopleSoft.

To configure PeopleSoft Integration Broker:

  1. Create a remote node as follows:

    1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Nodes.

    2. On the Add a New Value tab, enter the node name, for example, OIM_FILE_NODE, and then click Add.

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

    4. Make this node a remote node by deselecting the Local Node check box and selecting the Active Node check box.

    5. Ensure that the Node Type is PIA.

    6. On the Connectors tab, search for the following information by clicking the Lookup icon:

      Gateway ID: LOCAL

      Connector ID: FILEOUTPUT

    7. 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: Any location writable by the Integration Broker. This location is used to generate the full data publish files.

      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:

      1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Configuration, and then click Gateways.

      2. In the Integration Gateway ID field, enter LOCAL, and then click Search.

      3. Click the Gateway Setup Properties link.

        You are prompted to enter the user ID and password.

      4. Specify the following values:

        In the UserID field, enter the appropriate user ID.

        In the Password field, enter the appropriate password.

    8. Click Save.

    9. Click Ping Node to check whether a connection is established with the specified IP address.

2.2.2.1.2 Configuring the SCC_CONSTITUENT_FULLSYNC Service Operation

The SCC_CONSTITUENT_FULLSYNC message contains the basic personal information about all the persons. This information includes the ID, First Name, Last Name, Affiliation Type, and other contact information.

To configure the SCC_CONSTITUENT_FULLSYNC service operation, perform the following procedures:

2.2.2.1.2.1 Activating the SCC_CONSTITUENT_FULLSYNC Service Operation

The service operation is a mechanism to trigger, receive, transform, and route messages that provide information about updates in PeopleSoft or an external application. You must activate the service operation to successfully transfer or receive messages.

To activate the SCC_CONSTITUENT_FULLSYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
  2. On the Find Service Operation tab, enter SCC_CONSTITUENT_FULLSYNC in the Service field, and then click Search.
  3. Click the SCC_CONSTITUENT_FULLSYNC link.

    Note:

    In PeopleSoft Campus, there are two versions of the message (INTERNAL and VERSION_1) associated with this service operation. But, when you integrate PeopleSoft Campus 9.0 and Oracle Identity Manager, you must use the default version INTERNAL.

    The following screenshot displays the default version associated with this service operation:

    Default version, VERSION_3 of the service operation
  4. In the Default Service Operation Version region, click Active.
  5. Click Save.
  6. In the Non-Default Versions region, click the VERSION_1 link, as shown in the following screenshot.
    In the Non-Default Versions region, click the VERSION_1 link, as shown in this screenshot
  7. Click Active.
  8. Click Save.
  9. Click Return.
2.2.2.1.2.2 Verifying the Queue Status for the SCC_CONSTITUENT_FULLSYNC Service Operation

All messages in PeopleSoft are sent through a queue. This is done to ensure that the messages are delivered in a correct sequence. Therefore, you must ensure that the queue is in the Run status.

To ensure that the status of the queue for the SCC_CONSTITUENT_FULLSYNC service operation is Run:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Queues.

  2. Search for the PERSON_DATA queue.

  3. In the Queue Status list, ensure that Run is selected.

    Note:

    If the queue status is not Run:

    1. From the Queue Status list, select Run.

    2. Click Save.

    The queue status is highlighted in the following screenshot:

    Queue status for PERSON_BASIC_FULLSYNC
  4. Click Return to Search.

2.2.2.1.2.3 Setting Up the Security for the SCC_CONSTITUENT_FULLSYNC Service Operation

A person on the target system who has permission to modify or add personal or job information of a person 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 SCC_CONSTITUENT_FULLSYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.

  2. Search for and open the SCC_CONSTITUENT_FULLSYNC service operation.

  3. On the General tab, click the Service Operation Security link.

    The link is highlighted in the following screenshot:

    Service Operation Security link
  4. Attach the OIMCS permission list to the SCC_CONSTITUENT_FULLSYNC service operation. This list is created in Step 3 of the preinstallation procedure discussed in Creating a Permission List.

    To attach the permission list:

    1. Click the plus sign (+) to add a row to the Permission List field.

    2. In the Permission List field, enter OIMCS and then click the Look up Permission List icon.

      The OIMCS permission list appears.

    3. From the Access list, select Full Access.

      The following screenshot displays the preceding steps:

      Full access to PERSON_BASIC_FULLSYNC
    4. Click Save.

    5. Click Return to Search.

2.2.2.1.2.4 Defining the Routing for the SCC_CONSTITUENT_FULLSYNC Service Operation

Routing is defined to inform PeopleSoft about the origin and 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 SCC_CONSTITUENT_FULLSYNC service operation:

  1. On the Routing tab, enter SCC_CONSTITUENT_FULLSYNC_CS_FILE as the routing name and then click Add.

  2. On the Routing Definitions tab, enter the following:

    Sender Node: PSFT_CS

    Note:

    The Sender Node is the default active local node. To locate the sender node:

    1. Click the Look up icon.

    2. Click Default to sort the results in descending order.

      The default active local node should meet the following criteria:

      Local Node: 1

      Default Local Node: Y

      Node Type: PIA

      Only one node can meet all the above conditions at a time.

    3. Select the node.

    4. Click Save.

    Receiver Node: OIM_FILE_NODE

    The following screenshot displays the Sender and Receiver nodes:

    Routing for PERSON_BASIC_FULLSYNC
  3. Click the Parameters tab and enter the following details in the fields:

    • External Alias: SCC_CONSTITUENT_FULLSYNC.VERSION_1

    • Message.Ver into Transform 1: SCC_CONSTITUENT_FULLSYNC.INTERNAL

    • Transform Program 1: HMTF_TR_OA

      Click Cancel on the warning box that is displayed.

    • Message.Ver out of Transforms: SCC_CONSTITUENT_FULLSYNC.VERSION_1

    The following screenshot displays the Parameters tab:

    This screenshot displays the Parameters tab
  4. Click Save.

  5. Click Return to go back to the Routings tab of the service operation, and verify whether your routing is active.

2.2.2.1.2.5 Displaying the EI Repository Folder

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.

  1. In the PeopleSoft Internet Architecture, expand People Tools, Portal, and then Structure and Content.
  2. Click the Enterprise Components link.
  3. Click the Edit link for EI Repository, and then uncheck Hide from portal navigation.

    The following screenshot displays the Hide from portal navigation check box:

    Unhiding the EI Repository
  4. Click Save.
  5. Log out, and then log in.
2.2.2.1.2.6 Activating the SCC_CONSTITUENT_FULLSYNC Message

You must activate the SCC_CONSTITUENT_FULLSYNC message so that it can be processed.

To activate the SCC_CONSTITUENT_FULLSYNC message:

  1. In the PeopleSoft Internet Architecture, expand Enterprise Components, EI Repository, and then click Message Properties.
  2. Search for and open the SCC_CONSTITUENT_FULLSYNC message.
  3. Click Activate All.

    The following screenshot displays the message to be activated:

    Activating the PERSON_BASIC_FULLSYNC message
  4. 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.

2.2.2.1.2.7 Activating the Full Data Publish Rule

You must define and activate the Full Data Publish 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:

  1. In the PeopleSoft Internet Architecture, expand Enterprise Components, Integration Definitions, and then click Full Data Publish Rules.

  2. Search for and open the SCC_CONSTITUENT_FULLSYNC message.

  3. In the Publish Rule Definition region:

    1. In the Publish Rule ID field, enter SCC_CONSTITUENT_FULLSYNC.

    2. In the Description field, enter SCC_CONSTITUENT_FULLSYNC.

    3. From the Status list, select Active.

    The following screenshot displays the preceding steps:

    Full Data Publish Rule for PERSON_BASIC_FULLSYNC
  4. Click Save.

2.2.2.2 Enabling Content-based Filtering for Full Reconciliation in SCC_CONSTITUENT_FULLSYNC Message

Content-based filtering uses PeopleSoft Campus Solutions Affiliations codes for publishing rules. Affiliation Codes represent the relationship(s) a person has with an institution. This section assumes that you have already configured the SCC_CONSTITUENT_FULLSYNC message by following the procedure described in Configuring the SCC_CONSTITUENT_FULLSYNC Service Operation.

The following procedures are discussed in this section:

2.2.2.2.1 Setting Affiliation Routing Rules

Using content-based filtering for the SCC_CONSTITUENT_FULLSYNC message requires that you define valid Affiliation Codes that you wish to include in the data sent to Oracle Identity Manager. Selecting Affiliation Codes allows you to define the scope of persons which will be included in the generated XML files.

Note:

Affiliation Codes are defined and set appropriately for persons in the PeopleSoft Campus Solutions target system. See PeopleSoft Campus Solutions documentation for more information about defining and using Affiliations.

To set Affiliate Routing rules:

  1. Open the Affiliation Routing component details by expanding Set Up SACR, Common Definitions, Affiliations, Affiliation Routing.
  2. Select the node that represents your OIM File Node, as displayed in the following sample screenshot.
    Select the node that represents your OIM File Node, as displayed in this screenshot
  3. In the Institution field, select the Institution Code(s).
  4. In the Affiliation Code field, select the Affiliation Code(s) you wish to include.
  5. If needed, click the plus (+) button to insert additional rows.
  6. Click Save.
2.2.2.2.2 Setting the Routing Transformation Parameters for the SCC_CONSTITUENT_FULLSYNC message

You will transform the message being sent by enabling an additional transform program on the Affiliation Routing parameters.

To define the routing for SCC_CONSTITUENT_FULLSYNC service operation:

  1. In the PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
  2. Search for and open the SCC_CONSTITUENT_FULLSYNC message.
  3. On the Routing Definitions tab, click the routing name.
  4. Click the Parameters tab and enter the following details in the fields:
    • Transform Program 1: SCC_AFL_FLTR

    • Transform Program 2: HMTF_TR_OA

      Click Cancel on the warning box that is displayed.

    The following screenshot displays the routing transformation program settings on the Parameters tab:

    This screenshot displays the routing transformation program settings on the Parameters tab
  5. Click Save.
  6. Click Return to go back to the Routings tab of the service operation, and verify whether your routing is active.
2.2.2.2.3 Activating the Full Data Publish Rule with Content-based Filtering

You must define and activate the Full Data Publish rule that uses the Affiliation Routing settings you defined. This rule provides the full reconciliation process the desired information to initiate reconciliation.

To activate the full data publish rule:

  1. In the PeopleSoft Internet Architecture, expand Enterprise Components, Integration Definitions, and then click Full Data Publish Rules.

  2. Search for and open the SCC_CONSTITUENT_FULLSYNC message.

  3. In the Publish Rule Definition region:

    1. In the Publish Rule ID field, enter AFFILIATION_FILTER.

    2. In the Description field, enter Only affiliations of interest.

    3. From the Status list, select Active.

    4. Verify in the Message Options box that Create Message Header and Create Message Trailer are selected.

    The following screenshot displays the preceding steps:

    This screenshot displays the preceding steps
  4. Click the Record Mapping tab.

  5. In the Record Source Mapping region, enter the following values:

    Message Record Name Source/Order by Record Name

    ADDRESS_TYPE_V2

    SCC_ADRTYP_AFLT

    NAME_TYPE_VW2

    SCC_NAMTYP_AFLT

    PERSON_SA

    SCC_PER_SA_AFLT

    SCC_AFL_PERSON

    SCC_PERAFL_AFLT

    SCC_CM_PERSON_I

    SCC_PERSON_AFLT

    SCC_PER_ADDR_I

    SCC_PERADR_AFLT

    SCC_PER_NAME_I2

    SCC_PERNAM_AFLT

    SCC_PER_NID_I

    SCC_PERNID_AFLT

    SCC_PER_PDE_I

    SCC_PERPDE_AFLT

    SCC_PER_PHONE_I

    SCC_PERPHN_AFLT

    The following screenshot displays the preceding steps:

    This screenshot displays the preceding steps
  6. Click Save.

2.2.2.3 Configuring the Target System for Incremental Reconciliation

Configuring the target system for incremental reconciliation involves configuring PeopleSoft Integration Broker and configuring the SCC_CONSTITUENT_SYNC messages.

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 PeopleSoft 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 to external applications 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.

2.2.2.3.1 Configuring PeopleSoft Integration Broker

To configure PeopleSoft Integration Broker:

Note:

  • SectionConfiguring PeopleSoft Integration Broker Gateway describes the procedure to configure the PeopleSoft Integration Broker gateway.

  • The PeopleSoft Campus, PeopleSoft Employee Reconciliation, and PeopleSoft User Management connectors have different IT resources. Therefore, you must configure separate HTTP nodes for messages of the Campus, Employee Reconciliation, and User Management connectors.

    Even if an existing node is configured to the PeopleSoft listener on Oracle Identity Manager, a separate node is required for messages of the PeopleSoft User Management connector.

  • A single listener is sufficient for all the connectors. However, you must remove any existing listeners and deploy the listener from the installation media of the PeopleSoft Campus connector. You can configure the nodes to point to the same listener with different IT resource names.

  1. Create a remote node by performing the following steps:

    1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Nodes.

    2. On the Add a New Value tab, enter the node name, for example, OIM_CS_NODE, and then click Add.

    3. On the Node Definition tab, enter a description for the node in the Description field. In addition, specify the SuperUserID in the Default User ID field. For example, PS.

    4. Make this node a remote node by deselecting the Local Node check box and selecting the Active Node check box.

    5. Ensure Node Type is PIA.

    6. On the Connectors tab, search for the following information by clicking the Lookup icon:

      Gateway ID: LOCAL

      Connector ID: HTTPTARGET

    7. On the Properties page 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: Location

      Required value: Enter the value of the IT Resource name as configured for PeopleSoft Campus

      Sample value: PSFT Campus

      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://ORACLE_IDENTITY_MANAGER_SERVER_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 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 Oracle WebLogic Server:

      https://example088196:7002/PeopleSoftOIMListener
      

      Note:

      The ports may vary depending on the installation that you are using.

    8. Click Save to save the changes.

    9. Click the Ping Node button to check whether a connection is established with the specified IP address.

      Note:

      Ping also validates the target authentication, in this case, the IT resource name.

Before the XML messages are sent from the target system to Oracle Identity Manager, you must verify whether the PeopleSoft node is running. You can do so by clicking the Ping Node button in the Connectors tab. To access the Connectors tab, click PeopleTools, Integration Broker, Integration Setup, and then Nodes.

Note:

You might encounter the following error when you send a message from PeopleSoft Integration Broker over HTTP PeopleTools 8.50 target system:

HttpTargetConnector:PSHttpFactory init or setCertificate failed

You might also encounter the following error when you ping the node:

Cannot establish HTTP connection

This happens because the Integration Broker Gateway Web server tries to access the keystore even if SSL is not enabled using the parameters defined in the integrationgateway.properties file as follows:

secureFileKeystorePath=<path to pskey>

secureFileKeystorePasswd=password

To find the integrationgateway.properties file, go to PeopleTools, Integration Broker, Configuration, Gateways, and then click Gateway Setup Properties.After logging in, click on the Advanced Properties Page link

If either the <path to pskey> or the password (unencrypted) is incorrect, you will receive the preceding error message. Perform the following steps to resolve the error:

  1. Verify if secureFileKeystorePath in the integrationgateway.properties file is correct.

  2. Verify if secureFileKeystorePasswd in the integrationgateway.properties file is correct.

  3. Then, find the secureFileKeystorePasswd option and copy the password down to the Password Encryption box. Next, click Encrypt to get your encrypted version.

  4. Finally, copy the encrypted version back up to the setting.

  5. Save and exit.

Usually, a new PeopleTools 8.50 instance throws the preceding error when you message over the HTTP target connector. The reason is that the default password is not in the encrypted format in the integrationgateway.properties file.

For more information, see https://support.oracle.com/epmos/faces/ui/km/DocumentDisplay.jspx?id=1270683.1

2.2.2.3.2 Configuring the SCC_CONSTITUENT_SYNC Service Operation

The SCC_CONSTITUENT_SYNC message contains the updated information about a particular person. This information includes the Employee ID and the information that is added or modified.

To configure the SCC_CONSTITUENT_SYNC service operation perform the following procedures:

2.2.2.3.2.1 Activating the PERSON_BASIC_SYNC Service Operation

To activate the PERSON_BASIC_SYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
  2. On the Find Service Operation tab, enter PERSON_BASIC_SYNC in the Service field, and then click Search.
  3. Click the PERSON_BASIC_SYNC link.
  4. In the Default Service Operation Version region, enter INTERNAL in the Version field and click Active.

    The following screenshot displays the default version of the PERSON_BASIC_SYNC service operation:

    This screenshot displays the default version of the PERSON_BASIC_SYNC service operation
  5. In the Non-Default Versions region, click the VERSION_4 link and click Active.

    The following screenshot displays the non-default version of the PERSON_BASIC_SYNC service operation:

    This screenshot displays the non-default version of the PERSON_BASIC_SYNC service operation
  6. Click the Handlers tab, as shown in the following screenshot.
    Click handlers as suggested in this screenshot
  7. Confirm that the SCC_SERVICE OnNotify Handler is Active. Click Details.
  8. Confirm that the values are set as shown in the following screenshot and click OK.
    Confirm that the values are set as shown in this screenshot
  9. Click the Routing Definitions tab.
  10. Confirm that the Local Routing SCC_PERSON is Active, as shown in the following screenshot:
    Confirm that the Local Routing SCC_PERSON is Active, as shown in this screenshot
  11. On the Parameters tab, confirm that the values are set as shown in the following screenshot:
    On the Parameters tab, confirm that the values are set as shown in this screenshot
  12. Click Save.
  13. Click Return.
2.2.2.3.2.2 Activating the SCC_PERSON_SYNC Service Operation

To activate the SCC_PERSON_SYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
  2. On the Find Service Operation tab, enter SCC_PERSON_SYNC in the Service field, and then click Search.
  3. Click the SCC_PERSON_SYNC link.
  4. In the Default Service Operation Version region, enter v1 in the Version field and click Active.

    The following screenshot displays the default version of the SCC_PERSON_SYNC service operation:

    This screenshot displays the default version of the SCC_PERSON_SYNC service operation
  5. On the Handlers tab, confirm that the SCC_SERVICE is Active. Click Details.
  6. Confirm that the values are set as shown in the following screenshot and click OK.
    Confirm that the values are set as shown in this screenshot
  7. Click the Routings tab.
  8. Select the SCC_SERVICE routing definition and click Activate Selected Routings, as shown in the following screenshot:
    Select the SCC_SERVICE routing definition and click Activate Selected Routings, as shown in this screenshot

    If the SCC_SERVICE routing is not available by default, you must add it manually and enter the following fields:

    Service Operation: SCC_PERSON_SYNC

    Sender Node, Receiver Node: Name of the default local active node. To determine the default local active node, perform the steps in the note in Defining the Routing for the SCC_CONSTITUENT_FULLSYNC Service Operation.

  9. Click Save.
2.2.2.3.2.3 Activating the SCC_CONSTITUENT_SYNC Service Operation

To activate the SCC_CONSTITUENT_SYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Service Operations.
  2. On the Find Service Operation tab, enter SCC_CONSTITUENT_SYNC in the Service field, and then click Search.
  3. Click the SCC_CONSTITUENT_SYNC link.
  4. In the Default Service Operation Version region, click Active.

    The following screenshot displays the default version of the SCC_CONSTITUENT_SYNC service operation:

    This screenshot displays the default version of the SCC_CONSTITUENT_SYNC service operation
  5. Click Save.
2.2.2.3.2.4 Activating the SSC_CONSTITUENT_SYNC Event

To activate SCC_CONSTITUENT_SYNC event:

  1. In the PeopleSoft Internet Architecture, expand Set Up SACR, System Administration, Integrations, and Event Registry.
  2. Search for and open the SCC_CONSTITUENT_SYNC message.
  3. Click Active.
  4. In the Application Class region, confirm the values shown in the following screenshot:
    In the Application Class region, confirm the values shown in this screenshot
2.2.2.3.2.5 Activating the PERSON_BASIC_SYNC Notification Handler

To activate PERSON_BASIC_SYNC notification handler:

  1. In the PeopleSoft Internet Architecture, expand Set Up SACR, System Administration, Integrations, and Notification Handler.
  2. On the Find Service Operation tab, enter PERSON_BASIC_SYNC in the Service field and CM Handler in the Subscriber field. Click Search.
  3. Click Active.
  4. In the Application Class region, confirm the values shown in the following screenshot:
    In the Application Class region, confirm the values shown in this screenshot
2.2.2.3.2.6 Activating the SCC_PERSON_SYNC Notification Handler

To activate SCC_PERSON_SYNC notification handler:

  1. In the PeopleSoft Internet Architecture, expand Set Up SACR, System Administration, Integrations, and Notification Handler.
  2. On the Find Service Operation tab, enter SCC_PERSON_SYNC in the Service field and CM Handler in the Subscriber field. Click Search.
  3. Click Active.
  4. In the Application Class region, confirm the values shown in the following screenshot:
    In the Application Class region, confirm the values shown in this screenshot
2.2.2.3.2.7 Verifying the Queue Status for the SCC_CONSTITUENT_SYNC Service Operation

To ensure that the status of the queue for the SCC_CONSTITUENT_SYNC service operation is Run:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Integration Setup, and then click Queues.

  2. Search for the PERSON_DATA queue.

  3. In the Queue Status list, ensure that Run is selected.

    Note:

    If the queue status is not Run:

    1. From the Queue Status list, select Run.

    2. Click Save.

    The PERSON_BASIC_SYNC and SCC_PERSON_SYNC service operations also use this queue.

    The queue status is shown in the following screenshot:

    The queue status is shown in this screenshot
  4. Click Return to Search.

2.2.2.3.2.8 Setting Up the Security for Service Operations

Perform this procedure for each of the following service operations:

  • PERSON_BASIC_SYNC

  • SCC_PERSON_SYNC

  • SCC_CONSTITUENT_SYNC

To set up the security for the PERSON_BASIC_SYNC service operation:

  1. In PeopleSoft Internet Architecture, expand PeopleTools, Integration Broker, Service Utilities, and then click Service Operation Permissions.

  2. In the Operation field, enter PERSON_BASIC_SYNC and click Search.

  3. In the Service Operations region, click the Set Security link, as shown in the following screenshot:

    In the Service Operations region, click the Set Security link, as shown in this screenshot
  4. Attach the OIMCS permission list to the PERSON_BASIC_SYNC service operation. This list is created in Step 3 of the preinstallation procedure discussed in Creating a Permission List.

    To attach the permission list:

    Note:

    This procedure describes how to grant access to the OIMCS permission list. The OIMCS permission list is used as an example. But, to implement this procedure you must use the permission list (attached through a role) to the user profile that has the privilege to modify personal data in the target system.

    1. Click the plus sign (+) to add a row for the Permission List field.

    2. In the Permission List field, enter OIMCS and then click the Look up Permission List icon.

      The OIMCS permission list appears.

    3. From the Access list, select Full Access.

      The following screenshot displays the permission list with Full Access:

      This screenshot displays the permission list with Full Access
    4. Click Save.

    5. Click Return to Search.

  5. Repeat the Steps 1 to 4 for the SCC_PERSON_SYNC and SCC_CONSTITUENT_SYNC service operations.

2.2.2.3.2.9 Defining the Routing for the SCC_CONSTITUENT_SYNC Service Operation

To define the routing for the SCC_CONSTITUENT_SYNC service operation:

  1. On the Routing tab, enter SCC_CONSTITUENT_SYNC_CS_OIM as the routing name and then click Add.

  2. On the Routing Definitions tab, enter the following:

    Sender Node: PSFT_CS

    Note:

    The Sender Node is the default active local node. To locate the sender node:

    1. Click the Look up icon.

    2. Click Default to sort the results in descending order.

      The default active local node should meet the following criteria:

      Local Node: 1

      Default Local Node: Y

      Node Type: PIA

      Only one node can meet all the above conditions at a time.

    3. Select the node.

    4. Click Save.

    Receiver Node: OIM_CS_NODE

    The following screenshot displays the Sender and Receiver nodes:

    This screenshot displays the Sender and Receiver nodes
  3. On the Parameters tab, verify that the following values are set as default:

    1. In the External Alias field, enter SCC_CONSTITUENT_SYNC.v1.

    2. In the Message.Ver into Transform 1 field, enter SCC_CONSTITUENT_DS.v1.

      The following screenshot displays the preceding steps:

      This screenshot displays the preceding steps
    3. In the Message.Ver out of Transforms field, enter SCC_CONSTITUENT_DS.v1.

    4. Click Save.

    5. Click Return to go back to the Routings tab of the Service Operation, and verify whether your routing is active.

    The following graphic displays the routing SCC_CONSTITUENT_SYNC_CS_OIM and its transformation:

    This graphic displays the routing SCC_CONSTITUENT_SYNC_CS_OIM and its transformation
2.2.2.3.2.10 Displaying the EI Repository Folder

To display the EI Repository folder:

Note:

  • If you have performed this procedure as described in Displaying the EI Repository Folder, then you can skip this section.

  • Perform this procedure using the PeopleSoft administrator credentials.

  1. In the PeopleSoft Internet Architecture, expand People Tools, Portal, and then Structure and Content.
  2. Click the Enterprise Components link.
  3. Click the Edit link for EI Repository, and then uncheck Hide from portal navigation.

    The following screenshot displays the Hide from portal navigation check box:

    Unhiding the EI Repository
  4. Click Save.
  5. Log out, and then log in.
2.2.2.3.2.11 Activating the PERSON_BASIC_SYNC Message

To activate PERSON_BASIC_SYNC message:

Note:

To perform this step, your User Profile must have the EIR Administrator role consisting of EOEI9000 and EOCO9000 permission lists.

  1. In the PeopleSoft Internet Architecture, expand Enterprise Components, EI Repository, and then click Message Properties.
  2. Search for and open the PERSON_BASIC_SYNC message.
  3. Click Activate All.

    The following screenshot displays the message to be activated:

    This screenshot displays the message to be activated
  4. Click Save.
2.2.2.3.3 Preventing Transmission of Unwanted Fields During Incremental Reconciliation
2.2.2.3.3.1 About Preventing Transmission of Unwanted Fields During Incremental Reconciliation

By default, PeopleSoft messages contain fields that are not needed in Oracle Identity Manager. If there is a strong use case that these fields should not be published to Oracle Identity Manager, then do the following:

Locate if there are any local-to-local or local-to-third party PeopleSoft active routings for the service operations using the message under study.

2.2.2.3.3.2 Removing Unwanted Fields at Message Level

To remove unwanted fields at the message level:

  1. Expand PeopleTools, Integration Broker, Integration Setup, and then click Messages.
  2. Search for and open the desired message, for example, SCC_CONSTITUENT_DS.v1 used for incremental reconciliation.
  3. Expand the message.
    expand message
  4. Navigate to the field that you do not want to transmit to Oracle Identity Manager, for example, NAME_ROYAL_PREFIX.
    navigate to field
  5. Click the field and clear the Include check box.
    Include check box
  6. Click OK, return and save the message.

2.2.2.4 Enabling Content-based Routing for Incremental Reconciliation in SCC_CONSTITUENT_SYNC Message

2.2.2.4.1 About Content-based Routing with Affiliations

The assumption is that other routings and service operations are properly configured. When person data is added or updated, a PERSON_BASIC_SYNC message triggers an SCC_CONSTITUENT_SYNC message to publish. Before that message routes to any target nodes, it runs through the OnRoute Send handler to determine the list of nodes to which it will route. It starts with the list of current routings for that service operation and winnows it down. If the node is not found in the Affiliation Routing table, it will not route to that node. If it is found, then it checks to see if the Send Blank Affiliations option is enabled. If it is and there are no affiliation codes in the message (and in this case there are not), then it sends it on through. If it is not enabled (not checked), then it does not send it through. You will be leaving it unchecked.

When an affiliation is added, changed or deleted for a person, an SCC_CONSTITUENT_SYNC message is published. The OnRoute Send grabs this one and looks to see if any of the affiliations in the message are in the Affiliation Routing table. If they are, the message is sent on through. If they are not, then the message skips that node.

Next if the message is going on through, it gets to the routing transformation. The transformation program checks to see if the person data is blank in this message. If it is, then it fills it in with data from the database and sets the PSCAMA AUDIT_ACTN to 'A' (add). Then it lets it go out to the target node.

2.2.2.4.2 Enabling Content-Based Routing With Affiliations

To enable content-based routing with affiliations:

  1. Set affiliation routings as follows:

    1. Navigate to Set Up SACR, Common Definitions, Affiliations, and Affiliation Routing.

    2. Add the Oracle Identity Manager target node.

    3. Add the affiliation codes for which you want to receive SCC_CONSTITUENT_SYNC messages.

  2. Enable affiliation content-based routing as follows:

    1. Navigate to PeopleTools, Integration Broker, Integration Setup, and Service Operations.

    2. Select service operation SCC_CONSTITUENT_SYNC.

    3. Select the Handlers tab.

    4. Add a new row with the following details:

      Handler name: ROUTERSENDHDLR.*

      Type: OnRoute

      Implementation: Application Class

      Status: Active

    5. Click Details and enter the following information:

      Description: Affiliations Filter

      Comments: Affiliations Filter

      Handler Owner: SCC

      Package Name: SCC_AFFILIATIONS

      Path: HANDLER

      Class ID: AffiliationOnRouteSend

      Method: OnRouteSend

    6. Click OK and Save.

    7. Click the Routings tab.

    8. Click the link for the routing name that corresponds to the outbound routing from PeopleSoft Campus to the Oracle Identity Manager target node.

    9. Click the Parameters tab and add the following details:

      Transform Program 1: SCC_AFL_RICH (this may clear defaults.)

      The External Alias: SCC_CONSTITUENT_SYNC.v1

      Message.Ver into Transform 1: SCC_CONSTITUENT_DS.v1

      Message.Ver out of Transforms: SCC_CONSTITUENT_DS.v1

      Transform Program: blank

    10. Click Save, Return, and then Save.

Note:

No matter what you name this handler, the system always automatically renames it to ROUTESENDHDLR. This means that you can only have one OnRoute Send handler for a given service operation.

2.2.3 Installation with Other PeopleSoft Connectors

If you want to use the PeopleSoft Campus connector along with the PeopleSoft Employee Reconciliation and PeopleSoft User Management connectors, then consider the following points:

  • Installing the Campus connector after installing the Employee Reconciliation and PeopleSoft User Management connectors

    When installing the Campus connector after the Employee Reconciliation or the User Management connector, you must remove the existing listener (PeopleSoftOIMListener) and deploy the new listener shipped with the Campus connector. This is required because the listener uses the PSFTCommon.jar file, which has been modified to include Campus specific classes.You must also ensure that the PSFTCommon.jar file has been updated in the Oracle Identity Manager database during the connector installation.

  • Installing the Employee Reconciliation or User Management connector after installing the Campus connector

    When the Employee Reconciliation or User Management connector is installed after the Campus connector, you must continue to use the existing listener shipped with the Campus connector.

    During installation, the PSFTCommon.jar file in the Oracle Identity Manager database would be replaced with the PSFTCommon.jar file shipped with the Employee Reconciliation or User Management connector. To restore the PSFTCommon.jar file shipped with the Campus connector, run the UpdateJars utility shipped with Oracle Identity Manager. This file has some Campus connector specific additions.

2.3 Postinstallation

Postinstallation information is divided across the following sections:

2.3.1 Configuring Oracle Identity Manager

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster.

2.3.1.1 Enabling Logging

2.3.1.1.1 Log Levels and ODL Message Types

Oracle Identity Manager uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger. 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:

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

    This level enables logging of information about errors that may allow Oracle Identity Manager to continue running.

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

    This level enables logging of messages that highlight the progress of the application.

  • CONFIG

    This level enables logging of information about fine-grained events that are useful for debugging.

  • FINE, FINER, FINEST

    These levels enable logging of information about fine-grained events, where FINEST logs information about all events.

These message types are mapped to ODL message type and level combinations as shown in Table 2-4.

Table 2-4 Log Levels and ODL Message Type:Level Combinations

Java Level ODL Message Type:Level

SEVERE.intValue()+100

INCIDENT_ERROR:1

SEVERE

ERROR:1

WARNING

WARNING:1

INFO

NOTIFICATION:1

CONFIG

NOTIFICATION:16

FINE

TRACE:1

FINER

TRACE:16

FINEST

TRACE:32

The configuration file for OJDL is logging.xml, which is located at the following path:

DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SEVER are the domain name and server name specified during the installation of Oracle Identity Manager.

2.3.1.1.2 Enabling Logging on Oracle WebLogic Server

To enable logging on Oracle WebLogic Server:

  1. Edit the logging.xml file as follows:

    1. Add the following blocks in the file:

      <log_handler name='psft-cs-handler' level='[LOG_LEVEL]' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='[FILE_NAME]'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
      
      <logger name="ORACLE.IAM.CONNECTORS.PSFT" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="psft-cs-handler"/>
           <handler name="console-handler"/>
         </logger>
      
      <logger name="ORACLE.IAM.CONNECTORS.PSFT.CAMPUS" level="[LOG_LEVEL]" useParentHandlers="false">
      <handler name="psft-cs-handler"/>
      <handler name="console-handler"/>
      </logger>
      
    2. Replace all occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 2-4 lists the supported message type and level combinations.

      Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded.

      The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME]:

      <log_handler name='psft-cs-handler' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
      
      <logger name="ORACLE.IAM.CONNECTORS.PSFT" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="psft-cs-handler"/>
           <handler name="console-handler"/>
         </logger>
      
      <logger name="ORACLE.IAM.CONNECTORS.PSFT.CAMPUS" level="NOTIFICATION:1" useParentHandlers="false">
      <handler name="psft-cs-handler"/>
      <handler name="console-handler"/>
      </logger>
      

      With these sample values, when you use Oracle Identity Manager, all messages generated for this connector that are of a log level equal to or higher than the NOTIFICATION:1 level are recorded in the specified file.

      Note:

      The logging level for console-handler must be as fine as the level set in the loggers.For example, if the NOTIFICATION:1 level is specified in the ORACLE.IAM.CONNECTORS.PSFT logger, and the console-handler has ERROR:1 level, then only logs at ERROR:1 or coarser levels would be available.

  2. Save and close the file.

  3. Set the following environment variable to redirect the server logs to a file:

    For Microsoft Windows:

    set WLS_REDIRECT_LOG=FILENAME
    

    For UNIX:

    export WLS_REDIRECT_LOG=FILENAME
    

    Replace FILENAME with the actual name of the file to which you want to redirect the output.

  4. Restart the application server.

2.3.1.2 Setting Up the Lookup.PSFT.Campus.Configuration Lookup Definition

Every standard PeopleSoft message has a message-specific configuration defined in the Lookup.PSFT.Campus.Configuration lookup definition. See Lookup.PSFT.Campus.Configuration for more information about this lookup definition.

For example, the mapping for the SCC_CONSTITUENT_SYNC message in this lookup definition is defined as follows:

Code Key: SCC_CONSTITUENT_SYNC

Decode: Lookup.PSFT.Message.SccConstituentSync.Configuration

You can configure the message names, such as SCC_CONSTITUENT_SYNC and SCC_CONSTITUENT_FULLSYNC defined in this lookup definition.

Consider a scenario in which the target system sends the SCC_CONSTITUENT_SYNC.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:

  1. On the Design Console, expand Administration and then double-click Lookup Definition.
  2. Search for and open the Lookup.PSFT.Campus.Configuration lookup definition.
  3. Click Add.
  4. 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: SCC_CONSTITUENT_SYNC.VERSION_3

    Decode: Lookup.PSFT.Message.SccConstituentSync.Configuration

  5. Repeat Steps 3 and 4 to modify the Code Key values for all the standard PeopleSoft messages you want to rename in this lookup definition.
  6. Click the Save icon.

2.3.1.3 Setting Up the Lookup.PSFT.Campus.ExclusionList Lookup Definition

In the Lookup.PSFT.Campus.ExclusionList lookup definition, enter the user IDs of target system accounts for which you do not want to perform reconciliation. See Lookup.PSFT.Campus.ExclusionList for more information about this lookup definition.

  1. On the Design Console, expand Administration and then double-click Lookup Definition.
  2. Search for and open the Lookup.PSFT.Campus.ExclusionList lookup definition.
  3. Click Add.
  4. In the Code Key and Decode columns, enter the first user ID to exclude.

    Note:

    The Code Key represents the resource object field name on which the exclusion list is applied during reconciliation.

  5. Repeat Steps 3 and 4 for the remaining user IDs to exclude.

    For example, if you do not want to provision users with user IDs User001, User002, and User088 then you must populate the lookup definition with the following values:

    Code Key Decode

    User ID

    User001

    User ID

    User002

    User ID

    User088

    You can also perform pattern matching to exclude user accounts. You can specify regular expressions supported by the representation in the java.util.regex.Pattern class.

    See Also:

    For information about the supported patterns, visit http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html

    For example, if you do not want to provision users matching any of the user IDs User001, User002, and User088, then you must populate the lookup definition with the following values:

    Code Key Decode

    User ID[PATTERN]

    User001|User002|User088

    If you do not want to provision users whose user IDs start with 00012, then you must populate the lookup definition with the following values:

    Code Key Decode

    User ID[PATTERN]

    00012*

  6. Click the Save icon.

2.3.1.4 Configuring SSL

The following sections describe the procedure to configure SSL connectivity between Oracle Identity Manager and the target system:

2.3.1.4.1 Configuring SSL on IBM WebSphere Application Server

You can configure SSL connectivity on IBM WebSphere Application Server with either a self-signed certificate or a CA certificate. Perform the procedure described in one of the following sections:

2.3.1.4.1.1 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:

  1. Log in to the WebSphere Integrated Solutions Console. The URL may be similar to the following:
    https://localhost:9043/ibm/console/logon.jsp
    
  2. Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore, and then click Personal certificates.
  3. Click Create a self-signed certificate.
  4. In the Alias field, enter an alias name. You specify the alias name to identify the certificate request in the keystore.
  5. 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.
  6. In the Organization field, enter an organization name.
  7. In the Organization unit field, specify the organization unit.
  8. In the Locality field, enter the locality.
  9. In the State or Province field, enter the state.
  10. In the Zip Code field, enter the zip code.
  11. From the Country or region list, select the country code.
  12. Click Apply and then Save.
  13. Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore, and then click Personal certificates.
  14. Select the check box for the new alias name.
  15. Click Extract.
  16. Specify the absolute file path where you want to extract the certificate under the certificate file name, for example, C:\SSLCerts\sslcert.cer.
  17. Click Apply and then click OK.
2.3.1.4.1.2 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:

  1. Log in to the WebSphere Integrated Solutions Console. The URL may be similar to the following:

    https://localhost:9043/ibm/console/logon.jsp
    
  2. Click Security, SSL certificate and key management, Related items, Key stores and certificates, NodeDefaultKeyStore.

  3. On the Additional Properties tab, click Personal certificate requests.

  4. Click New.

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

  6. In the Key label field, enter an alias name. You specify the alias name to identify the certificate request in the keystore.

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

  8. In the Organization field, enter an organization name.

  9. In the Organization unit field, specify the organization unit.

  10. In the Locality field, enter the locality.

  11. In the State or Province field, enter the state.

  12. In the Zip Code field, enter the zip code.

  13. From the Country or region list, select the country code.

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

  15. Send the certification request arm file to a CA for signing.

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

  17. To receive a signed certificate issued by a CA, perform the following tasks:

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

    2. Click Receive a certificate from a certificate authority.

    3. Enter the full path and name of the certificate file.

    4. Select the default data type from the list.

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

2.3.1.4.2 Configuring SSL on Oracle WebLogic Server

You can configure SSL connectivity on Oracle WebLogic Server with either a self-signed certificate or a CA certificate. Perform the procedure described in one of the following sections:

2.3.1.4.2.1 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:

2.3.1.4.2.1.1 Generating Keystore

To generate the keystore:

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

  2. When prompted, enter information about the certificate. This information is displayed to persons 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.

  3. 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
    
  4. When prompted for the private key password, enter the same password used for the keystore, for example, example1234.
  5. 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.

2.3.1.4.2.1.2 Configuring Oracle WebLogic Server

After generating and importing the keystore, start Oracle WebLogic Server. To configure Oracle WebLogic Server:

  1. Log in to the Oracle WebLogic Server console at http://localhost:7001/console and perform the following:

    1. Expand the servers node and select the oim server instance.

    2. Select the General tab.

    3. Select the SSL Listen Port Enabled option.

    4. Ensure that a valid port is specified in the SSL Listen Port field. The default port is 7002.

    5. Click Apply to save your changes.

  2. Click the Keystore & SSL tab, and then click Change.

  3. From the Keystores list, select Custom identity And Java Standard Trust, and then click Continue.

  4. Configure the keystore properties. To do so:

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

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

    3. Click Continue.

  5. Specify the private key alias, pass phrase and the confirm pass phrase as the keystore password. Click Continue.

  6. Click Finish.

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

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

2.3.1.4.2.2.1 Generating Keystore

The connector requires Certificate Services to be running on the host computer. To generate the keystore:

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

  2. When prompted, enter the information about the certificate. This information is displayed to persons 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.

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

  4. Get the certificate from a CA by using the certificate request generated in the previous step and store the certificate in a file.
  5. 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
    
  6. 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.

2.3.1.4.2.2.2 Configuring Oracle WebLogic Server

After creating and importing the keystore to the system, start Oracle WebLogic Server. To configure Oracle WebLogic Server:

  1. Log in to the Oracle WebLogic Server console ((http://localhost:7001/console) and perform the following:

    1. Expand the server node and select the server instance.

    2. Select the General tab.

    3. Select the SSL Port Enabled option.

    4. Ensure that a valid port is specified in the SSL Listen Port field. The default port is 7002.

    5. Click Apply to save your changes.

  2. Click the Keystore & SSL tab, and click the Change link.

  3. From the Keystores list, select Custom Identity And Custom Trust, and then click Continue.

  4. Configure the keystore properties. To do so:

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

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

    3. Provide the Java standard trust keystore password. The default password is changeit, unless you change the password.

    4. Click Continue.

  5. Specify the alias name and private key password. Click Continue.

  6. Click Finish.

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

2.3.1.5 Creating an Authorization Policy for Campus ID

Note:

Perform this procedure only if you are using Oracle Identity Manager release prior to 11.1.2.

To create an authorization policy for Campus ID, refer to the instructions given in Oracle Fusion Middleware User's Guide for Oracle Identity Manager. The following instructions are specific to individual steps of the procedure described in Creating an Authorization Policy for User Management. For detailed information on the individual steps, see http://docs.oracle.com/cd/E21764_01/doc.1111/e14316/auth_policy.htm#BGBHGHJI.

  • When you reach Step 3, then:

    In the Policy Name field, enter Campus ID Authorization Policy.

  • When you reach Step 4, then:

    In the Description field, enter Campus ID Authorization Policy.

  • When you reach Step 7, then:

    In the Permissions table, select the following check boxes in the Enable column:

    • Modify User Profile

    • Search User

    • View User Details

    Click Edit Attributes.

    On the Attribute Settings page, clear all the check boxes and select Campus ID.

  • When you reach Step 14 c, then:

    From the Available Roles list, select System Administrator, and then click the Move button to move the selected role to the Organizations to Add list.

2.3.1.6 Displaying UDFs in Oracle Identity Manager 11.1.2 or Later

In Oracle Identity Manager release 11.1.2 or later, some user-defined attributes (UDFs), such as Campus ID, that are included in the connector are created only in the backend. If you want to display these attributes as form fields in the Oracle Identity Manager user interface (UI), then you must customize the associated pages on the UI to add the custom form fields. To do so:

  1. Log in to Oracle Identity System Administration.
  2. Create and activate a sandbox.
  3. From the Identity System Administration Console, in the Upgrade region, click Upgrade User Form.

    All the UDFs are listed.

  4. Click Upgrade now.
  5. Publish the sandbox.

    For detailed steps to be performed, see Configuring Custom Attributes in Oracle Fusion Middleware Administering Oracle Identity Manager.

2.3.1.7 Localizing Field Labels in UI Forms

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.2.x or later and you want to localize UI form field labels.

To localize field label that you add to in UI forms:

  1. Log in to Oracle Enterprise Manager.

  2. In the left pane, expand Application Deployments and then select oracle.iam.console.identity.sysadmin.ear.

  3. In the right pane, from the Application Deployment list, select MDS Configuration.

  4. On the MDS Configuration page, click Export and save the archive to the local computer.

  5. Extract the contents of the archive, and open one of the following files in a text editor:

    • For Oracle Identity Manager 11g Release 2 PS2 (11.1.2.2.0) and later:

      SAVED_LOCATION\xliffBundles\oracle\iam\ui\runtime\BizEditorBundle_en.xlf

    • For releases prior to Oracle Identity Manager 11g Release 2 PS2 (11.1.2.2.0):

      SAVED_LOCATION\xliffBundles\oracle\iam\ui\runtime\BizEditorBundle.xlf

  6. Edit the BizEditorBundle.xlf file in the following manner:

    1. Search for the following text:

      <file source-language="en"  
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      
    2. Replace with the following text:

      <file source-language="en" target-language="LANG_CODE"
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      

      In this text, replace LANG_CODE with the code of the language that you want to localize the form field labels. The following is a sample value for localizing the form field labels in French:

      <file source-language="en" target-language="fr"
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      
    3. Search for the application instance code. This procedure shows a sample edit for PSFTCampus application instance. The original code is:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_AFFLN_CODE__c_description']}">
      <source>Affiliation Code</source>
      <target/>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.PSFTCampus.entity.PSFTCampusEO.UD_AFFLN_CODE__c_LABEL">
      <source>Affiliation Code</source>
      <target/>
      </trans-unit>
      
    4. Open the resource file from the connector package, for example PSFT-CS_fr.properties and get the value of the attribute from the file, for example, global.udf.UD_AFFLN_CODE=Code d'affiliation.

    5. Replace the original code shown in Step 6.c with the following:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_AFFLN_CODE__c_description']}">
      <source>Affiliation Code</source>
      <target>Code d'affiliation</target>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.PSFTCampus.entity.PSFTCampusEO.UD_AFFLN_CODE__c_LABEL">
      <source>Affiliation Code</source>
      <target>Code d'affiliation</target>
      </trans-unit>
      
    6. Repeat Steps 6.a through 6.d for all attributes of the process form.

    7. Save the file as BizEditorBundle_LANG_CODE.xlf. In this file name, replace LANG_CODE with the code of the language to which you are localizing.

      Sample file name: BizEditorBundle_fr.xlf.

  7. Repackage the ZIP file and import it into MDS.

    See Also:

    Deploying and Undeploying Customizations in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager, for more information about exporting and importing metadata files

  8. Log out of and log in to Oracle Identity Manager.

2.3.2 Configuring the Target System

Postinstallation on the target system configuring SSL.

To configure SSL:

  1. Copy the certificate to the computer on which PeopleSoft Campus is installed.

    Note:

    If you are using IBM WebSphere Application Server, then you must download the root certificate from a CA.

  2. Run the following command:
    PEOPLESOFT_HOME/webserv/peoplesoft/bin/pskeymanager.cmd -import
    
  3. When prompted, enter the current keystore password.
  4. When prompted, enter the alias of the certificate to import.

    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 root as the alias.

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

  6. When prompted for the following:
    Trust this certificate? [no]: yes 
    

    Select yes and press Enter.

  7. Restart the Web server of the target system.

2.4 Postcloning Steps

You can clone the PeopleSoft Campus connector by setting new names for some of the objects that comprise the connector. The outcome of the process is a new connector XML file. Most of the connector objects, such as Resource Object, Process Definition, Process Form, IT Resource Type Definition, IT Resource Instances, Lookup Definitions, Adapters, Reconciliation Rules and so on in the new connector XML file have new names.

See Also:

Managing Connector Lifecycle in Oracle Fusion Middleware Administering Oracle Identity Manager for detailed information about cloning connectors and the steps mentioned in this section

After a copy of the connector is created by setting new names for connector objects, some objects might contain the details of the old connector objects. Therefore, you must modify the following Oracle Identity Manager objects to replace the base connector artifacts or attribute references with the corresponding cloned artifacts or attributes:

  • Lookup Definition

    If the lookup definition contains the old lookup definition details, then you must modify it to provide the new cloned lookup definition names. If the Code Key and Decode values are referring the base connector attribute references, then replace these with new cloned attributes.

  • Scheduled Task

    You must replace the base connector resource object name in the scheduled task with the cloned resource object name. If the scheduled task parameter has any data referring to the base connector artifacts or attributes, then these must be replaced with the new cloned connector artifacts or attributes.

  • Localization Properties

    You must update the resource bundle of a user locale with new names of the process form attributes for proper translations after cloning the connector. You can modify the properties file of your locale in the resources directory of the connector bundle.

    For example, the process form attributes are referenced in the Japanese properties file, Campus_ja.properties, as global.udf.UD_CAMPUS_ALIASNAME. During cloning, if you change the process form name from UD_CAMPUS to UD_CAMPUS1, then you must update the process form attributes to global.udf.UD_CAMPUS1_ALIASNAME.