Configuring Web Services for Person Data

This section provides a summary of Person Data FullSync and Sync Service Operations and Handlers, and discusses how to:

  • Configure Integration Broker Gateway and Nodes.

  • Configure PERSON_BASIC_SYNC Service.

Note:

These instructions describe the setup of CS 9.2 and HCM 9.1/9.2 databases.

Configuring the Integration Broker Gateway and Nodes

To configure the Integration Broker Gateways and Nodes in your CS and HCM databases:

  1. Set the Service Configuration in the HCM database.

  2. Configure the Gateway in the HCM database.

  3. Configure the default local node in the HCM database.

  4. Configure the HCM Gateway in the CS database.

  5. Configure the CS node in the HCM database.

  6. Configure the default LOCAL node in the CS database.

  7. Configure the HCM node in the CS database.

  8. Update the HCM Gateway nodes in the HCM database.

  9. Update the HCM Gateway nodes in the CS database.

  10. Update the Single Sign-on nodes.

  11. Test Nodes.

  1. Setting the Service Configuration in the HCM database.

    Navigate toPeopleTools, and then Integration Broker, and then Configuration , and then Service Configuration,and set up the following:

    Field or Control Description

    Service Namespace

    http://xmlns.oracle.com/Enterprise/HCM/services

    Schema Namespace

    http://xmlns.oracle.com/Enterprise/Tools/schemas

    Target Location

    http://machinename:port/PSIGW/PeopleSoftServiceListeningConnector

    Service System Status

    Production

  2. Configuring the Gateway in the HCM database.

    1. Navigate: PeopleTools, and then Integration Broker, and then Configuration , and then Gateways.

    2. Select Integration Gateway ID = LOCAL.

    3. Set URL = http://machinename:port/PSIGW/PeopleSoftServiceListeningConnector/databasename.

    4. Click the Load Gateway Connectors button. Save after it loads 9 connectors

    5. Click the Ping Gateway button. If successful, it displays an Active status.

  3. Configuring the default local node in the HCM database.

    1. Navigate toPeopleTools, and then Integration Broker, and then Integration Setup, and then Nodes.

    2. Select the default local node and set up the following:

      Field or Control Description

      Set Descr

      HCM Instance

      Authentication Option

      Password

      Node Password

      PS

      Default User ID

      PS

    3. Click the Connectors tab and set the following:

      Field or Control Description

      Gateway ID

      LOCAL

      Connector ID

      PSFTTARGET

    4. Click the Portal tab and set up the following:

      Field or Control Description

      Tools Release

      8.54.xx

      Set Application Release

      HCM

      Content URI Text

      http://machinename:port/psc/databasename

      Portal URI Text

      http://machinename:port/psp/databasename

      Note:

      Use <CTRL>+J keys to see the tools release string.

    5. Click the WS Security tab and set the following:

      Field or Control Description

      Authentication Token Type

      None

      Encrypted

      Disable the check box.

    6. Save.

  4. Configuring the HCM Gateway in the CS database.

    1. Navigate to PeopleTools, and then Integration Broker, and then Configuration, and then Gateways, and select .Add a New Value.

    2. Set the following:

      Field or Control Description

      Integration Gateway ID

      <Gateway Name for HCM>

      URL

      http://machinename:port/PSIGW/PeopleSoftListeningConnector/databasename

    3. Click the Load Gateway Connectors button. It should load 9 connectors. Save.

    4. Click the Ping Gateway button.

      If successful, it displays an Active status.

  5. Configuring the CS node in the HCM database.

    1. Navigate toPeopleTools, and then Integration Broker, and then Integration Setup, and then Nodes, and set up the following:

      Field or Control Description

      Add Node

      Name of CS Node

      Set Descr

      CS Instance

      Set Authentication Option

      Password

      Node Password

      PS

      Default User ID

      PS

    2. Click the Connectors tab and set up the following:

      Field or Control Description

      Gateway ID

      LOCAL

      Connector ID

      PSFTTARGET

    3. Click the Portal tab and set up the following:

      Field or Control Description

      Tools Release

      8.54.xx

      Set Application Release

      CS release version

      Content URI Text

      http://machinename:port/psc/databasename

      Portal URI Text

      http://machinename:port/psp/databasename

    4. Click the WS Security tab and set the following:

      Field or Control Description

      Authentication Token Type

      None

      Encrypted

      Disable the check box.

    5. Click Save.

  6. Configuring the default LOCAL node in the CS database.

    Note:

    The gateway used by this node is the HCM gateway. Node passwords must be consistent between the CS and the HCM databases.

    1. Navigate: PeopleTools, and then Integration Broker, and then Integration Setup, and then Nodes.

    2. Select the default local node and set up the following:

      Field or Control Description

      Description

      Set Descr = CS Instance

      Authentication Option

      Password

      Node Password

      PS

      Default User ID

      PS

    3. Click the Connectors tab and set up the following:

      Field or Control Description

      Gateway ID

      Gateway Name for HCM instance

      Note: This is not the local gateway.

      Set Connector Id

      PSFTTARGET

    4. Click the Portal tab and set up the following:

      Field or Control Description

      Tools Release

      8.54.xx

      Set Application Release

      CS release version

      Content URI Text

      http://machinename:port/psc/databasename

      Portal URI Text

      http://machinename:port/psp/databasename

    5. Click the WS Security tab and set the following:

      Field or Control Description

      Authentication Token Type

      None

      Encrypted

      Disable the check box.

    6. Click Save.

  7. Configuring the HCM node in the CS database.

    Note:

    Each node is defined twice – once in each database. They should each use the same gateway.

    1. Navigate to PeopleTools, and then Integration Broker, and then Integration Setup, and then Nodes, and set up the following:

      Field or Control Description

      Add Node

      Name of HCM Node

      Set Descr

      HCM Instance

      Set Authentication Option

      Password

      Node Password

      PS

      Default User ID

      PS

    2. Click the Connectors tab and set up the following:

      Field or Control Description

      Gateway ID

      Gateway Name for HCM instance

      Note: This is not the local gateway.

      Set Connector Id

      PSFTTARGET

    3. Click the Portal tab and set the following:

      Field or Control Description

      Tools Release

      8.54.xx

      Set Application Release

      HCM release version

      Content URI Text

      http://machinename:port/psc/databasename

      Portal URI Text

      http://machinename:port/psp/databasename

    4. Click the WS Security tab and set the following:

      Field or Control Description

      Authentication Token Type

      None

      Encrypted

      Disable the check box.

    5. Click Save. A Node Saved message box appears. Click OK.

  8. Updating the HCM Gateway nodes in the HCM database.

    Both CS and HCM database nodes should point to the same Gateway. The specific Gateway should also have both nodes listed in the Gateway Advanced Properties.

    1. Navigate: PeopleTools, and then Integration Broker, and then Configuration , and then Gateways.

    2. Select gateway LOCAL.

    3. Click the Gateway Setup Properties link and set the following:

      Field or Control Description

      User ID

      administrator

      Password

      Enter a password.

      Click OK.

    4. In the Gateway Default App. Server frame, set the App Server URL to ' //machinename:port.

      Note:

      Your port must match the one specified in your HCM application server.

    5. Enter the appropriate User ID and password.

    6. Set the tools release to 8.54.xx.

    7. Make sure both the HCM and CS nodes are in the PeopleSoft Nodes tab. Ping the HCM node. It should be successful.

    8. Click Return.

  9. Updating HCM Gateway nodes in the CS database.

    Follow the process outlined in Step 8 to update the HCM Gateway node in the CS database.

  10. Updating the Single Sign-on nodes in both CS and HCM databases.

    Single Sign-on is used in this recommended configuration.

    1. Navigate: PeopleTools, and then Security, and then Security Objects, and then Single Signon.

    2. Ensure that both the default local node and the other node you are using are listed.

  11. Testing Nodes.

    Both nodes must be 'pingable' from each database. On each database,

    1. Navigate: PeopleTools, and then Integration Broker, and then Service Operations Monitor, and then Administration, and then Node Status.

    2. Enter the node name and click the Ping Node button. It should respond successfully.

Configuring the PERSON_BASIC_SYNC Service

The PERSON_BASIC_SYNC service is the primary integration point for syncing core personal data between your CS and HCM systems. The settings on the Biographic Fields page control the data that's included in and processed from PERS_DATA_EFFDT. For information, see Campus Community Fundamentals: Reviewing or Defining Installation Settings For Biographic Fields.

The following tasks detail how to configure the PERSON_BASIC_SYNC service to publish from your CS system and subscribe in the target HCM system.

  • Owner/Subscriber: If you implement the owner/subscriber model, you can configure your PERSON_BASIC_SYNC service to publish from your primary CS system to your target HCM system.

  • Subscriber Only: If you implement the subscriber–only model, you can configure the PERSON_BASIC_SYNC service in both your CS and HCM systems to publish and subscribe.

    Note:

    The source and target database configuration tasks described are for CS 9.2 (source) and HCM 9.1/9.2 (target) databases on PeopleTools 8.54.xx.

Configuring Campus Solutions as the Source Database

  1. Update security by adding the Service Operation(s) to your primary permission list.

    1. Navigate to PeopleTools, and then Security, and then Permissions & Roles, and then Permission Lists.

    2. Select the relevant permission list from the search dialog box.

    3. Select the Web Services tab.

    4. Enter the corresponding Service(s) for the Service Operation(s) you want to use.

    5. Click the Edit link and select Full Access to provide access to the relevant Service Operation(s) listed on the Web Service Permissions secondary page.

    This graphic provides an example of the Web Service Access page for the PERSON_BASIC_SYNC operation.

    Web Service Access page

  2. Activate Service Operations and Create Routings in CS.

    1. Navigate to PeopleTools, and then Integration Broker, and then Integration Setup, and then Service Operation Definitions.

    2. Select PERSON_BASIC_SYNC from the search dialog box.

      This example illustrates the fields and controls on the PERSON_BASIC_SYNC service operation page. You can find definitions for the fields and controls later on this page.

      PERSON_BASIC_SYNC service operation page

    3. Check the Active check box on the General tab.

    4. Make note of the Queue Name field, as you need to verify that the PERSON_DATA Queue is in Running status later.

    5. Click the Handlers tab. Set the SCC_HR_PERSON handler to Active.

      This example illustrates the fields and controls on the PERSON_BASIC_SYNC Handlers page.

      PERSON_BASIC_SYNC Handlers page_asynchronous

    6. Click the Routings tab and add a new routing for the Service Operation by entering a value in the Routing Name field and clicking the Add button.

      This example illustrates the fields and controls on the Routings page for PERSON_BASIC_SYNC.

      PERSON_BASIC_SYNC routings

    7. Define a Sender Node and a Receiver Node on the Routings Definition page of the Routings component.

      This example illustrates the fields and controls on the PERSON_BASIC_SYNC routing definition page. You can find definitions for the fields and controls later on this page.

      PERSON_BASIC_SYNC routing definition page

    8. Verify that the Active check box is checked.

    9. Click the Parameters tab and set up the following:

      This example illustrates the fields and controls on the PERSON_BASIC_SYNC Routing Parameters page. You can find definitions for the fields and controls later on this page.

      PERSON_BASIC_SYNC routing parameters page_outbound
      Field or Control Description

      External Alias

      Enter the external alias; for example, PERSON_BASIC_SYNC.VERSION_9.

      Message.Ver into Transform 1

      For example, PERSON_BASIC_SYNC.INTERNAL.

      Transform Program

      For example, HCM_MSG_XFRM.

      Message.Ver out of Transforms

      For example, PERSON_BASIC_SYNC.VERSION_9.

    10. Click Save at the bottom of the Parameters page to save the routing.

    11. Click Return at the bottom of the Parameters page to return to the Service Operation setup page.

    12. Click Save at the bottom of any page in the Service Operations component to save the Service Operation.

  3. Activate Message Queue.

    1. Navigate to PeopleTools, and then Integration Broker, and then Service Operations Monitor,, and then Administration, and then Queue Status.

    2. Scroll down the page until you find the relevant PERSON_DATA Queue Name.

    3. Review the queue Status and activate the queue by clicking Run, if needed. The queue status should be set to Running before leaving this page.

      This example illustrates queue status for PERSON_DATA.

      PERSON_DATA queue status

Configuring HCM as the Target Database

  1. Update security by adding the service operation to the required user’s permission list.

    This example illustrates the fields and controls on the Web Service Permissions page for the PERSON_BASIC_SYNC service.

    Web Service Permissions page PERSON_BASIC_SYNC

    1. Navigate to PeopleTools, and then Security, and then Permissions & Roles, and then Permission Lists.

    2. Select the relevant permission list from the search dialog box (primary permission list for the user).

    3. Click the Web Services tab.

    4. Enter the corresponding Service(s) for the Service Operation(s) you want to leverage.

    5. Click the Edit link and add access to the relevant Service Operation(s) listed on the Web Service Permissions secondary page.

    6. Click OK to return to the Web Services page.

    7. Click Save to save the updated Permission List.

  2. Activate Service Operation(s) and Create Routing(s) and Subscription Handler in HCM:

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

    2. Select PERSON_BASIC_SYNC from the search dialog box.

    3. Check the Active check box on the General tab.

    4. Make note of the Queue Name field, as you need to verify that the PERSON_DATA Queue is in Running status later.

      This example illustrates the fields and controls on the General page for the PERSON_BASIC_SYNC service operation in HCM.

      HCM PERSON_BASIC_SYNC service operation

    5. Click the Handlers tab. Set the SCC_HR_PERSON handler to Active.

      This example illustrates the fields and controls on the Handlers page for the PERSON_BASIC_SYNC service operation in HCM.

      HCM PERSON_BASIC_SYNC handlers

      This example illustrates the fields and controls on the Handler Details page for the SCC_HR_PERSON handler in HCM.

      HCM SCC_HR_PERSON handler details

    6. Select the Routings tab and add a new routing for the Service Operation by entering a value in the Routing Name field and clicking the Add button.

      This example illustrates the fields and controls on the Routings page for the PERSON_BASIC_SYNC service operation in HCM.

      HCM PERSON_BASIC_SYNC routings page

    7. Enter the CS Sender Node and an HCM Receiver Node on the Routings Definition page of the Routings component.

    8. Verify that the Active check box is checked.

      This example illustrates the fields and controls on the Routing Definitions page for the PERSON_BASIC_SYNC service operation in HCM.

      HCM PERSON_BASIC_SYNC routing definitions

    9. Select the Parameters tab and set the following:

      This example illustrates the fields and controls on the routing Parameters page for the PERSON_BASIC_SYNC service operation in HCM.

      PERSON_BASIC_SYNC routing parameters page_outbound
      Field or Control Description

      External Alias

      Enter the external alias; for example, PERSON_BASIC_SYNC.VERSION_4.

      Message.Ver into Transform 1

      For example, PERSON_BASIC_SYNC.INTERNAL.

      Transform Program

      For example, HCM_MSG_XFRM.

      Message.Ver out of Transforms

      For example, PERSON_BASIC_SYNC.VERSION_4.

    10. Click Save at the bottom of the Parameters page to save the routing.

    11. Click Return at the bottom of the Parameters page to return to the Service Operation setup page.

    12. Click Save at the bottom of any page in the Service Operations component to save the Service Operation.

    This example illustrates Integration Broker inbound request routing for PERSON_BASIC_SYNC.

    HCM 9.1 PERSON_BASIC_SYNC routing graphic

CS/SFP Integration: When PERSON_BASIC_SYNC is subscribed (local-to-local routing), it runs a subscription handler that invokes a POST FasStudentUpdateEvent to SFP. The Notification Handler SCC_SFP must be set to Active.

Notification handler for biographic or demographic updates

notification handler for PERSON_BASIC_SYNC