Return to Navigation

Setting Up Integration Broker For Research Administrator Profile Affiliations

The configuration steps outlined here are specific to administrators created using the Administrator Profile Management component used for Research Tracking (or Student Academic Projects) and cannot be extended for any other Campus Solutions feature.

It is assumed that basic Integration Broker setup is complete and working. For example, you have already set up your Integration Gateway.

See the product documentation for PeopleTools: Integration Broker

Note: Setting up Integration Broker is a technical task. Functional users should not perform this task.

Complete the following Integration Broker steps to ensure that Research Supervisor functionality works as expected.

Note: This setup is a requirement for the Student Academic Projects feature.

  1. Integration Broker Message:

    select PeopleTools, then select Integration Broker, then select Integration Setup, then select Messages, then select Message Definition

    Image: Message Definition page

    A Message Definition is delivered for processing affiliations created through the Administrative Profile Management component. This is a rowset-based message. Verify that the message SSR_ADMN_AFFL_DATA_SYNC is available in your database and that schema exists for the message. Refer to the following example:

    Message Definition page

    Note: If the Schema does not exist, generate the schema using the Message Schema Builder.

  2. Integration Broker Service:

    select PeopleTools, then select Integration Broker, then select Integration Setup, then select Services

    Image: Services page

    An Integration Broker Service definition is created to communicate with the Affiliation framework. Verify that the Service definition SSR_ADMN_AFFL_DATA_SYNC is available in your database.

    Services page
  3. Integration Broker Service Operation:

    select PeopleTools, then select Integration Broker, then select Integration Setup, then select Service Operations, then select General

    Image: General (SSR_ADMN_AFFL_DATA_SYNC) page

    An Integration Broker Service Operation is created to communicate with the Affiliation framework. Verify that the Service Operation definition SSR_ADMN_AFFL_DATA_SYNC is available in your database.

    Select the Active check box.

    General (SSR_ADMN_AFFL_DATA_SYNC) page

    After the Service Operation is Active, perform the following steps:

    1. Generate Local-to-Local routing.

    When you select the Generate Local-to-Local check box the Local-to-Local value appears. Additionally, system generated Routing information is populated on the Routings page.

    2. Set up Security.

    Click the Service Operation Security link to access the Web Service Access page and assign one or more permission lists to the service operation.

    Image: Web Service Access page

    This example illustrates the Web Service Access page as explained above.

    Web Service Access page

    Image: General (SCC_CONSTITUENT_SYNC) page

    Additionally, ensure that the following Service Operation which is available in your database (SCC_CONSTITUENT_SYNC) is also Active and Service Operation Security has been set up.

    General (SCC_CONSTITUENT_SYNC) page
  4. Integration Broker Service Operation Handler

    select PeopleTools, then select Integration Broker, then select Integration Setup, then select Service Operations, then select Handlers

    Image: Handlers (SSR_ADMN_AFFL_DATA_SYNC) page

    An Integration Broker Service Operation Handler is delivered to support integration with the Affiliation framework. Verify that the following handler definition is available in your database.

    Set the status to Active.

    Handlers (SSR_ADMN_AFFL_DATA_SYNC) page

    Image: Handlers (SCC_CONSTITUENT_SYNC) page

    Additionally, set the following Integration Broker Service Operation Handler to Active:

    Handlers (SCC_CONSTITUENT_SYNC) page
  5. Service Operation Routing

    Image: Routings (SSR_ADMN_AFFL_DATA_SYNC) page

    Review the Service operation routing and note the local routing that was automatically generated when you saved the operation.

    Routings (SSR_ADMN_AFFL_DATA_SYNC) page

    Image: Routings (SCC_CONSTITUENT_SYNC) page

    Additionally, review the Service operation routing and note the local routing that was automatically generated when you saved the operation for SCC_CONSTITUENT_SYNC.

    Routings (SCC_CONSTITUENT_SYNC) page
  6. Service Operation Queue Definition

    Image: Queue Definition (SSR_ADMN_AFFL_DATA_SYNC) page

    A queue definition is delivered to support integration with the Affiliation framework. Verify that the following handler definition is available in your database.

    Set the Queue Status to Run.

    Queue Definition (SSR_ADMN_AFFL_DATA_SYNC) page

    Image: Queue Definition (PERSON_DATA) page

    Additionally, set the Queue Status to Run for the following queue definition (PERSON_DATA):

    Queue Definition (PERSON_DATA) page
  7. Constituent Event Registry

    select Setup SACR, then select System Administration, then select Utilities, then select Constituent Management, then select Constituent Event Registration

    Image: Constituent Event Registration page

    A Constituent Event (SSR_ADMN_AFFL_DATA_SYNC) is registered to support integration with the Affiliation framework. Verify that following entry is available in your database.

    Constituent Event Registration page
  8. SOA Framework Event Registry

    select Setup SACR, then select System Administration, then select Integrations, then select Event Register

    Image: Event Registry page

    An event is registered in Campus Solutions SOA Framework to support integration with the Affiliation framework. Verify that following entry is available in your database and is Active.

    Event Registry page

See Understanding Constituent Web Services

See Outbound and Inbound Services

See Configuring Constituent Event Triggers

See Configuring Notification Handlers

See Defining Affiliations

See Setting Up Enrollment and Course Batch Processing