Before You Install the Recipe

To successfully connect to PeopleSoft using Oracle Integration and synchronize user accounts between PeopleSoft and OCI Identity and Access Management, you must perform certain configuration tasks on your PeopleSoft instance.

  1. Define integration gateways and load connectors.
    1. Configure gateway URL and activate domain.
      1. Go to PeopleTools > Integration Broker > Configuration > Integration Gateways.
      2. Leave the default gatway URL as is or enter the one you want to use.
      3. Click Ping Gateway.

        Ensure that a message displays that the gateway is active.

      4. To process asynchronous messages, one application server domain must be active. In the Integration Broker Domains pane, activate the appropriate domain you want to use.
      5. Click Save.
    2. Load gateway connectors.
      1. Go to PeopleTools > Integration Broker > Configuration > Integration Gateways.
      2. Search the existing gateways. If no gateway satisfies your search criteria, click the Add A New Value link.
      3. In the Integration Gateway ID field, enter the integration gateway ID, for example: IAM_LOCAL, and click Add.
      4. Select the Local Gateway check box, and in the URL field enter the gateway URL that you configured in the previous step.
      5. Click Load Gateway Connectors. All loaded gateway connectors are displayed in the Connectors area.
      6. Click Save to save the gateway information.
  2. Configure integration gateway properties.
    1. Go to PeopleTools > Integration Broker > Configuration > Integration Gateways.
    2. Search the gateway you defined in step 1b.
    3. Open the gateway and click the Gateways Setup Properties link next to the integration gateway URL field.
    4. In the displayed Gateway Properties Sign-in page, enter User ID and Password, and click OK.
    5. In the displayed PeopleSoft Node Configuration page, click the Advanced Properties Page link.
    6. Configure gateway properties in the displayed editor.

      The following integration gateway properties have to be configured:

      Delivered Connector Configuration
      • ig.isc.serverURL=PeopleSoft_server_name:port ig.isc.userid=username ig.isc.password=password ig.isc.toolsRel=PeopleTools_version
      • Use the supplied Password Encryption Utility to generate an encrypted password for ig.isc.password.
    7. Click OK to save the properties.
    8. Click Save to save the integration gateway configuration.
  3. Set up integration.
    1. Define nodes.

      Nodes represent any organization, application or system that will play a part in integrations. For example, nodes can represent customers, business units, suppliers, other trading partners, external or third-party software systems, and so on.

      1. Go to PeopleTools > Integration Broker > Integration Setup > Node Definitions.
      2. Search the existing nodes. If no node satisfies your search criteria, click the Add A New Value link. Enter Node Name and click Add.
      3. Click the Node Definitions tab to define the node:
        • In the Description field, enter a description.
        • From the Node Type drop-down field, select PIA.
        • Enter Default User ID.
        • Select the Active Node checkbox.
      4. Click the Connectors tab and define the connectors.
        • Specify Gateway ID or click the button to look up the Gateway ID you defined in step 1b.
        • Specify Connector ID or click the button to look up the Connector ID you defined in step 1b.

          The connector properties are loaded as shown in the following table.

          Field Action/Description
          HEADER

          Property Name: sendUncompressed

          Required: Enable this option.

          Value: Y

          Data Type: STRING

          Description: A descriptive text entry is optional.

          HEADER

          Property Name: Content-Type

          Value: text/xml

          Data Type: STRING

          Description: A descriptive text entry is optional.

          HTTPPROPERTY

          Property Name: Method

          Required: Enable this option.

          Value: POST

          Data Type: STRING

          Description: A descriptive text entry is optional.

          PRIMARYURL

          Property Name: URL

          Required: Enable this option.

          Value: The URL that points to the integration server. For example: https://IntegrationServer_Host:Port/ic/api/integration/v2/flows/rest/project/ORCL-R-PEOPLESOFT_IAM_USER_SYNC/PEOPLESOFT-IAM-USER-SYNC/1.0/persondetails

          Data Type: STRING

          Description: A descriptive text entry is optional.

          HEADER

          Property Name: Authorization

          Required: Enable this option.

          Value: The user name and password used as authorization to start the integration server. Use the following format, along with the encoding flow service listed below, to encode the user name and password: "Basic" (+ Base64Encode service using username + ":" + password)

          To encode the username and password, use the following utility flow service: wm.adapter.peoplesoft.outbound.utils.encoding where the input for the encoding service is a string constructed from the username and password, as follows: "username"+":"+"password". For example, if the username is "name" and the password is "pwd", the input for the encoding service would be "name:pwd". The result of encoding flow service for these values would be "bmFtZTpwd2Q". Thus, the value of the Authorization field would be "Basic bmFtZTpwd2Q".

          Data Type: Leave this field blank.

          Description: A descriptive text entry is optional.

        • Click Ping Node. Ensure the result is success.
        • Click Return.
        • Click Save.

      The specified node is created.

    2. Define messages.

      Message definitions provide the physical description of the data that is being sent, including fields, field types, and field lengths.

      1. Go to PeopleTools > Integration Broker > Integration Setup > Message Definitions.
      2. Search the existing messages. If no message satisfies your search criteria, click the Add A New Value link.
      3. In the Add New Message window:
        • From the Type drop-down list, select Rowset.
        • In the Message Name field, enter a name for the message. For example: COUNTRY_SYNC.
        • In the Message Version field, enter the version. For example: VERSION_1
        • Click Add.
      4. Click the Message Definition tab and define the message.
        • Enter the message's description in the Description field.
        • From the Owner ID dop-down list, select Enterprise Components.
        • Click the Add Record To Root link to add a level 0 record to the root node.
        • Click the record link, you can also add more records to the level 0 record or its child records.
        • Click Save.

      The specified message is created.

    3. Define message queues.
      A message queue isolates different groups of service operations from each other. It needs to be created exclusively to handle messages meant for the plug-in. You can also choose an existing message queue. If a message does not exist for a record from which data is to be exported, it needs to be created. Modifications to the existing messages might be required.
    4. Define services.
      PeopleSoft Integration Broker enables you to take an existing component interface and create a service which can be used to invoke the component interface.
      1. Go to PeopleTools > Integration Broker > Integration Setup > Service Definitions.
      2. Search the existing services. If no service satisfies your search criteria, click the Add A New Value link.
      3. Enter the service name, and then click the Add button.
      4. In the Services window, fill in the service information.
        • Enter a description for the service in the Description field.
        • From the Object Owner ID drop-down field, select Enterprise Components.
        • In the Service Operations area, define the service operation. Enter the Service Operation, select the type of operation from the Operation Type drop-down list, and then click Add.

          To define service operation, follow step 3e.

      5. Click Save.

      The specified service is created.

    5. Define service operations.

      A service operation definition consists of general information about an operation, such as its name, description, and so on. It also specifies an operation type, which determines how the operation is to be processed, synchronously or asynchronously. In addition, it contains routings which determine the direction, inbound or outbound, of the service operation. A service operation has one or more handlers, which contain and run the programming logic for sending or receiving the message, manipulating message content, and other functions.

      With Integration Broker (IB), you can define and customize service operations. The steps to define a service operation are the same for all IB activities. However, based on the IB activity to be used, you need to select the appropriate operation type from the following:

      Asynchronous - One Way: for IBRequest Activity.

      To define a service operation:

      1. Go to PeopleTools > Integration Broker > Integration Setup > Service Operation Definitions.
      2. Search the existing service operations. If no service operation satisfies your search criteria, click the Add A New Value link.
      3. In the Add New Service Operation pane, enter the following details:
        • Specify the service or click the button to look up the service you defined in step 3d.
        • Specify the Service Operation name.
        • Select the appropriate Operation Type from the drop-down list.
        • Click Add.
      4. Click the General tab and enter the following details:
        • Enter Operation Definition.
        • From the Object Owner ID drop-down list, select Enterprise Components.
        • Enter Version.
        • Select the Active checkbox.
        • Specify Message.Version or click the button to look up the message you defined in step 3b.
        • Specify Queue Name or click the button to look up the message queue you defined in step 3c.
      5. Click the Routings tab. Enter Routing Name and click Add.
      6. Define the routing by following step 3f.
      7. To choose the routing you defined and want to use, select the Selected check box.
      8. Click Save.

      The specified service operation is created.

    6. Define routings.

      Routing definitions determine the sender and receiver of an integration. With routing definitions, you can specify inbound and outbound transformations that enable you to transform data structures into those that the sending or receiving systems can understand.

      With Integration Broker, you can define and customize routings. The steps to define a routing are the same for all IB activities. However, based on the IB activity to be used, you need to select the appropriate sender node and receiver node.

      To define a routing:

      1. Go to PeopleTools > Integration Broker > Integration Setup > Routing Definitions.
      2. Search the existing routings. If no routing satisfies your search criteria, click the Add A New Value link.
      3. Enter Routing Name and click Add.
      4. Click the Routing Definitions tab and define the routing:
        • Specify Service Operation or click the button to look up the service you defined in step 3e.
        • Enter Version.
        • Enter Description.
        • Specify Sender Node or click the button to look up the node you defined in step 3a.
        • Specify Receiver Node or click the button to look up the node you defined in step 3a.
        • From the Object Owner ID drop-down list, select PeopleTools.
      5. Click the Connector Properties tab and enter the following information:
        • Specify Gateway ID or click the button to look up the gateway you defined in step 1.
        • Specify Connector ID or click the button to look up the connector you defined in step 2.
      6. Click Save.

      The specified routing is created.

Note:

You can get the schema payload from PeopleSoft Person Node. It should be similar to the XML payload in the following file: PersonBasicSync.xml. Ensure that the XML payload matches with the Oracle Integration REST Trigger request.