Using Enterprise Integration Points

This chapter provides an overview of enterprise integration points (EIPs) and discusses how to:

Click to jump to parent topicUnderstanding Enterprise Integration Points

EIPs use a variety of PeopleSoft integration tools to integrate data across your enterprise.

Among the PeopleSoft integration tools used in the design of Pay/Bill Management, you will want to have a firm understanding of:

Click to jump to top of pageClick to jump to parent topicPeopleSoft Integration Broker

Integration Broker is a middleware technology that facilitates synchronous and asynchronous messaging among internal systems and trading partners, while managing message structure, message format, and transport disparities. Using a publish and subscribe protocol, dynamic data external to Pay/Bill Management is published by the application, such as PeopleSoft Human Resources Management (HRMS), to be picked up by other PeopleSoft applications such as Pay/Bill Management, the subscriber to the changes in data. Integration Broker provides integration that is close to real-time, which means that the publisher need not be connected to the subscriber when publishing data. This is similar to the way that email works.

Note. You must activate the Publication/Subscription feature on the Financials and HCM application servers.

See Also

PeopleTools PeopleBook: PeopleSoft Integration Broker

Click to jump to top of pageClick to jump to parent topicPeopleSoft Component Interfaces

Every organization depends on real-world business objects, such as assignments in Pay/Bill Management or invoices in Receivables, to conduct its business. In PeopleSoft applications, components represent real-world business objects. For example, an invoice component is a way to capture, store, and display all the essential information related to any given invoice—the general billing and shipping information, plus details about each line item. While online, a user can view, enter, and manipulate data about a business object through the use of a component and its associated pages.

Components have keys that enable navigation to a specific instance of a business object, and also include the essential information that describes the object (the fields in the component). Additionally, a component includes an organization's business rules associated with whatever type of business object the component represents.

The PeopleSoft Component Interfaces integration tool exposes the rich functionality delivered in the hundreds of components that make up PeopleSoft applications. A component is a transaction that implements a business process or function. A component interface provides real-time synchronous access to the PeopleSoft business rules and data associated with a business component. A component interface is a PeopleTools object created in PeopleSoft Application Designer. It exposes a PeopleSoft component for synchronous access from another application.

Pay/Bill Management primarily uses the component interfaces technology within the framework of the order, assignment, and employees pages.

See Also

PeopleTools PeopleBook: PeopleSoft Component Interfaces

Click to jump to parent topicSetting Up Integration Broker Message Subscriptions

PeopleSoft delivers all Pay/Bill Management enterprise integration points with settings enabled for full functionality, with the exception of PeopleSoft Integration Broker messages. When you integrate Pay/Bill Management with PeopleSoft HRMS, you must activate Integration Broker messages.

This section describes how to:

Note. PeopleSoft recommends that you not change the delivered values for Create Message Header and Create Message Trailers. Special logic on the PeopleSoft full message subscription to delete the existing application records occurs when a header message is encountered. Some applications use the trailer message to indicate that all data messages have been received and that it is time to start the validation process. The documentation for the individual message should note if headers and trailers are not supported. Please check that the subscribing process does not need the header or trailer process before clearing those check boxes on a Full Sync message publish.

See Also

PeopleTools PeopleBook: PeopleSoft Integration Broker

PeopleTools PeopleBook: PeopleSoft Integration Tools and Utilities

Click to jump to top of pageClick to jump to parent topicSetting Up Messages: Incremental Synchronization

Pay/Bill Management uses the PeopleSoft Integration Broker tool to integrate Pay/Bill Management tables with PeopleSoft HRMS and PeopleSoft Financials (FSCM) application tables. The messages are delivered with a default status of Inactive. You must activate each message before you attempt to publish messages or subscribe to messages between databases.

Note. You must activate these messages in the HRMS and FSCM databases.

To begin using Integration Broker, you need to enable publishing of several messages in HRMS and subscribing to those messages in Pay/Bill Management. For some PeopleSoft systems, the direction of the publish/subscribe rule for messages may be bi-directional or uni-directional; however, in Pay/Bill Management, the model is uni-directional so that data can be synchronized. For a given set of data there is only one source for add and one source for update. The publish and subscribe rules may also be incremental or full table synchronization for each message.

Note. The source for publishing departments must be HRMS because Pay/Bill Management requires that the Company and Location fields are populated.

This table contains the incremental synchronization messages that update the Pay/Bill Management, HRMS, and Financials applications every time a user changes data that is relevant to Pay/Bill Management. These messages are published from Pay/Bill Management or HRMS and subscribe to some or all of the same databases.

Message

Message Channel

COMPETENCY_SYNC1

PERSON_SETUP

COUNTRY_SYNC

ENTERPRISE_SETUP

CURR_QUOTE_MTHD_SYNC

MARKET_RATES

CURRENCY_SYNC

ENTERPRISE_SETUP

CUSTOMER_SYNC

CUSTOMER

DEPT_ SYNC

ENTERPRISE_SETUP

FO_APP_HIRE

FO_APP_HIRE

FO_ASGN_CONFIRM

FO_ASSIGNMENTS

FO_ASGN_CREATE

FO_ASSIGNMENTS

FO_ASGN_RATES_SYNC

FO_ASSIGNMENTS

FO_ASGN_UPD

FO_ASSIGNMENTS

FO_EMPL_DATA_SYNC

FO_SETUP

FO_RATE_ELEM_SYNC

FO_SETUP

FO_WC_CO_MOD_ SYNC

FO_SETUP

FO_WC_CO_STATE_SYNC

FO_SETUP

FO_WC_STATE_ SYNC

FO_SETUP

JOBCODE_ SYNC

PERSON_SETUP

LOCATION_SYNC

ENTERPRISE_SETUP

MARKET_RATE_DEFN_SYNC

MARKET_RATES

MARKET_RATE_INDEX_SYNC

MARKET_RATES

MARKET_RATE_LOAD

MARKET_RATES

MARKET_RATE_SYNC

MARKET_RATES

MARKET_RATE_TYPE_SYNC

MARKET_RATES

PERSON_ACCOMP_SYNC

PERSON_DATA

PERSON_BASIC_SYNC

PERSON_DATA

PERSON_COMPETENCY_SYNC

PERSON_DATA

PERSON_EDUCATION_SYNC

PERSON_DATA

PROJ_ACTIVITY_STATUS_SYNC

PROJECTS_SETUP

PROJECT_ACTIVITY_SYNC

PROJECTS_SETUP

PROJECT_ACTIVITY_TEAM_SYNC

PROJECTS_SETUP

PROJECT_STATUS_SYNC

PROJECTS_SETUP

PROJECT_SYNC

PROJECTS_SETUP

PROJECT_TEAM_SYNC

PROJECTS_SETUP

STATE_SYNC

ENTERPRISE_SETUP

TIME_REPORTING_CODE_SYNC

TIME_AND_LABOR_SETUP

UOM_SYNC

ENTERPRISE_SETUP

WORKFORCE_ SYNC

PERSON_DATA

After you activate these messages, every subsequent change to data in any of the records associated with these messages triggers the publication and subscription of the new or deleted data. The result is that Pay/Bill Management reflects the change within a few seconds.

If you use Pay/Bill Management with Staffing Front Office, you must also activate these incremental synchronization messages:

Message

Message Channel

ACTION_REASON_SYNC

ACTION_REASON

COMPANY_SYNC

PERSON_SETUP

FREQUENCY_SYNC

PERSON_SETUP

Click to jump to top of pageClick to jump to parent topicSetting Up Messages: Full Table Synchronization

Full synchronization is a much more data-destructive activity than incremental synchronization. Incremental synchronization messages modify, delete, or add only the data that a user has affected in performing an individual transaction. Full synchronization messages first delete all of the data in the target record and then load a copy of the source record.

When using full synchronization messages, your primary concern is that you do not inadvertently overwrite valid data. To prevent this problem from occurring, you generally should not activate full synchronization messages for any record that receives input from multiple databases.

The messages in the following table are full synchronization messages. Carefully consider the effect of activating any of these messages.

Warning! You should not activate any of the messages identified as FULL_SYNC or FULLSYNC unless you are absolutely certain that you want to overwrite all of the data in the records associated with the message in the database. Understanding how full synchronization messages work is especially important if the list of values in the Pay/Bill Management database differs from the values in the HRMS database. For example, synchronizing the locations from HRMS using a FULLSYNC message would overwrite all of the Financials locations with the HRMS locations.

Message

Message Channel

BEN_DEFN_PGM_FULLSYNC

FO_SYNC

COUNTRY_FULLSYNC

ENTERPRISE_SETUP

CURR_QUOTE_MTHD_FULLSYNC

MARKET_RATES

CURRENCY_FULLSYNC

ENTERPRISE_SETUP

CUSTOMER_FULLSYNC

CUSTOMER

DEPT_FULLSYNC

ENTERPRISE_SETUP

DEPT_FULLSYNC_EFF

ENTERPRISE_SETUP

FO_CO_LOCALTAX_FULLSYNC

FO_SYNC

FO_CO_STATETAX_FULLSYNC

FO_SYNC

FO_GP_PYGRP_FULLSYNC

FO_SYNC

FO_RATE_ELEM_FULLSYNC

FO_SETUP

FO_TL_EMPL_DATA_FULLSYNC

FO_SYNC

FO_WC_CO_MOD_FULLSYNC

FO_SETUP

FO_WC_CO_STATE_FULLSYNC

FO_SETUP

FO_WC_STATE_FULLSYNC

FO_SETUP

JOBCODE_FULLSYNC

PERSON_SETUP

LOCATION_FULLSYNC

ENTERPRISE_SETUP

LOCATION_FULLSYNC_EFF

ENTERPRISE_SETUP

MARKET_RATE_DEFN_FULLSYNC

MARKET_RATES

MARKET_RATE_FULLSYNC

MARKET_RATES

MARKET_RATE_INDEX_FULLSYNC

MARKET_RATES

MARKET_RATE_TYPE_FULLSYNC

MARKET_RATES

PAYGROUP_FULLSYNC

PAYGROUP_SETUP

PAYGROUP_TBL_FULLSYNC

FO_SYNC

PERSON_BASIC_FULLSYNC

PERSON_SETUP

PROJECT_ACTIVITY_FULLSYNC

PROJECTS_SETUP

PROJECT_ACTIVITY_STATUS_FULLSYNC

PROJECTS_SETUP

PROJECT_ACTIVITY_TEAM_FULLSYNC

PROJECTS_SETUP

PROJECT_FULLSYNC

PROJECTS_SETUP

PROJECT_STATUS_FULLSYNC

PROJECTS_SETUP

PROJECT_TEAM_FULLSYNC

PROJECTS_SETUP

REGULATORY_REGION_FULLSYNC

PERSON_SETUP

SCHOOL_TYPE_FULLSYNC

PERSON_SETUP

STATE_FULLSYNC

ENTERPRISE_SETUP

TAX_LOCATION1_FULLSYNC

FO_SYNC

TIME_REPORTING_CODE_FULLSYNC

TIME_AND_LABOR_SETUP

TL_TASKGRP_TBL_FULLSYNC

FO_SYNC

TL_WRKGRP_TBL_FULLSYNC

FO_SYNC

UOM_FULLSYNC

ENTERPRISE_SETUP

WORKFORCE_FULLSYNC

PERSON_DATA

If you use Pay/Bill Management with Staffing Front Office, you can also activate these full synchronization messages:

Message

Message Channel

ACTION_REASON_FULLSYNC

ACTION_REASON

COMPANY_FULLSYNC

PERSON_SETUP

FO_BEN_DEFN_PGM_FULLSYNC

FO_SYNC_HRTOFO

FO_COMP_RATECD_FULLSYNC

FO_SYNC_HRTOFO

FO_EMPL_CTG_FULLSYNC

FO_SYNC_HRTOFO

FO_NID_TYPE_TBL_FULLSYNC

FO_SYNC_HRTOFO

FREQUENCY_FULLSYNC

PERSON_SETUP

Click to jump to top of pageClick to jump to parent topicActivating Full Table Publish Rules

The Integration Broker full table messages are delivered with a status of Inactive. The publishing rules must be activated. Information shared by the FSCM and the HRMS databases for Pay/Bill Management is updated properly when the appropriate messages are activated.

For example, PeopleSoft publishes data from the HRMS table CM_CLUSTER_ACMP. This table is populated with new data from PeopleSoft HRMS, and old data is deleted. The data from this table is published into a CLUSTER_ACCOMP_FULLSYNC message.

Click to jump to parent topicReviewing Component Interfaces

Pay/Bill Management uses the Business Component Interface tool to share data within Pay/Bill Management tables or between Pay/Bill Management tables and other application tables, such as HRMS and Financials. The component interfaces used by Pay/Bill Management are:

Component Interface

Description

Database

Function

CA_ACCTPLAN_CI

Review recognition plans.

FSCM

Creates revenue recognition plans in Contracts from assignments when assignments are created.

CA_AMEND_PRICE_CI

Amendment pricing.

FSCM

Creates a contract amendment in Contracts each time an assignment is created (starting with the second assignment; the first assignment does not trigger amendment creation).

CA_BILLPLAN_CI

Billing plans.

FSCM

Creates billing plans in Contracts when assignments are created.

CA_CHG_HDR_CI

Contract amendments.

FSCM

Changes the contract header status when the first assignment is created.

CA_DETAIL_PROJ_CI

Related projects and rates.

FSCM

Creates a contract line and associates it with a project activity when an assignment is created.

CA_HDR_CI

Contract header.

FSCM

Creates a contract header when an order is created.

CA_PRICING_CI

Contract pricing.

FSCM

Creates contract pricing for career orders from assignments.

CA_RATE_CI

Contract rates.

FSCM

Used for temporary assignments only. This CI creates the rate set in Contracts to allow billing for time received from Time and Labor into Project Costing.

CI_COMPETENCIES

Component interface for COMPETENCIES.

HRMS

Adds competency data for employees.

CI_JOB_DATA_CONCUR

Component interface for CI_JOB_DATA_CONCUR.

HRMS

Creates additional jobs for employees.

CI_JOB_DATA_CWR

Component interface for JOB_DATA_CWR.

HRMS

Creates additional jobs for non-employees.

CI_JOB_DATA_EMP

Component interface for JOB_DATA_EMP.

HRMS

Creates additional jobs for employees.

CI_PERSONAL_DATA

Component interface for PERSONAL_DATA.

HRMS

Creates a person record in HCM.

FO_AGENDA_CI

Agenda item.

FSCM

Creates an agenda item.

FO_BI_ENTRY

Fall off credit bills.

FSCM

Creates a credit in Billing when the user creates a fall off for a career assignment.

FO_ORDERS_CI

Status changes and copying orders.

FSCM

Status change and copy order.

FO_PSA_DEFN

Project owning organization.

FSCM

Creates a project-owning organization in Project Costing when the user creates an order with a status other than Draft and when Project Costing is configured to use organizations.

FO_RATE_CI

Project Costing rate template component interface.

FSCM

Creates, updates, or both, a Project Costing rate set.

HHR_EDUCATION_SRV

Education component interface.

HRMS

Adds education data for employees.

HHR_HONORS_AWARDS_SRV

Honors and awards component interface.

HRMS

Adds honor and award data for employees.

HHR_LANGUAGES_SRV

Languages component interface.

HRMS

Adds language data for employees.

HHR_LICENSES_CERTIFS_SRV

Licenses and certifications component interface.

HRMS

Adds license and certificate data for employees.

HHR_MEMBERSHIPS_SRV

Memberships component interface.

HRMS

Adds membership data for employees.

HHR_TEST_RESULTS_SRV

Test results component interface.

HRMS

Adds test result data for employees.

PGM_RESOURCE

Project team for Program Management component interface.

FSCM

Creates a project team for Program Management.

PROJ_TEAM

Project team for Project Costing component interface.

FSCM

Creates a project team for Project Costing.

PROJECT_ACTIVITY

Activity data.

FSCM

Creates a project activity in Project Costing when an assignment is created.

PROJECT_GENERAL

Project data.

FSCM

Creates a project in Project Costing when an order with a status other than Draft is created.

PROJECT_STATUS1

Project status.

FSCM

Creates a project status record when an order is saved.

TL_EMPL_DATA1

Create time reporter data.

HRMS

Creates new effective dated rows in TL_EMPL_DATA.