About the Adapter for PeopleSoft
Overview of the Adapter
The IBM webMethods Adapter for PeopleSoft is an add-on to the IBM webMethods Integration Server that allows you to exchange data with PeopleSoft systems. The adapter provides seamless and real-time communications to and from PeopleSoft systems without requiring changes to the existing security infrastructure.
Using the Adapter for PeopleSoft, Integration Server clients can configure and run services that perform operations to retrieve data from, and insert and update data in, PeopleSoft systems. For example, you can use the Adapter for PeopleSoft to add or modify employee records based on data from other resources such as Siebel or Oracle Applications.
The Adapter for PeopleSoft provides solutions for both webMethods-to-PeopleSoft (inbound) communications and PeopleSoft-to-webMethods (outbound) communications.
PeopleSoft Server version 8.x introduced PeopleSoft's Pure Internet Architecture (PIA). The PeopleSoft PIA includes PeopleSoft component interfaces (CIs), which enable external applications to access objects created using PeopleSoft's Application Designer.
For webMethods-to-PeopleSoft communications, the Adapter for PeopleSoft uses the PeopleSoft CI APIs to exchange data with PeopleSoft systems by invoking operations and methods on PeopleSoft Components via PeopleTools.
For PeopleSoft-to-webMethods communications, the Adapter for PeopleSoft offers some pre-defined flow services to make it easier to use PeopleSoft's Application Messaging capabilities.
For detailed installation instructions, see Installing and Uninstalling the Adapter for PeopleSoft. For a list of the PeopleSoft versions and platforms that the Adapter for PeopleSoft supports, see the IBM webMethods Adapters System Requirements.
Architecture and Components
This diagram illustrates how the Adapter for PeopleSoft interfaces with a PeopleSoft system using the PeopleSoft component interface Java APIs. Following the diagram are descriptions of the different architectural pieces involved in the integration process.
For a more detailed description of the run-time data flow for the different types of Adapter for PeopleSoft services, see Adapter Services.
- IBM webMethods Integration Server . The Adapter for PeopleSoft is installed and runs on the Integration Server.
- WmART Package. The WmART package provides a common framework for webMethods 6.0 and later adapters to use Integration Server functionality, making the Integration Server the run-time environment for the Adapter for PeopleSoft. The WmART package is installed with the Integration Server.
-
Adapter for PeopleSoft
. The Adapter for PeopleSoft is delivered as a
single package called WmPeopleSoftAdapter.
The Adapter for PeopleSoft provides Integration Server Administrator user interfaces that enable you to configure and manage adapter connections, and IBM webMethods Designer user interfaces that enable you to configure and manage adapter services.
-
Adapter Connection Templates. Adapter connections enable the Adapter for PeopleSoft to connect to PeopleSoft systems.
You must configure an adapter connection before you can configure adapter services.
The adapter provides a template for adapter connections in the Integration Server Administrator. For a detailed description of adapter connections, see Adapter Connections.
-
Adapter Service Templates. Adapter services enable the Adapter for PeopleSoft to implement component interface
methods to perform operations on PeopleSoft components. The Adapter for PeopleSoft provides adapter service templates
that enable you to configure services to find, get, insert, update, and delete component interface instances (or
records).
For example, a Get service could enable you to retrieve data records that are then passed to another resource such as a custom benefits application. Or you could use an Insert service within a flow service that takes data from another resource (for example, a database), and then insert that data into a PeopleSoft system.
The Adapter for PeopleSoft's adapter service templates are available in Designer. For a detailed description of adapter services, see Adapter Services.
-
PeopleSoft Libraries. The Adapter for PeopleSoft requires PeopleSoft-supplied files
to be able to interface with the PeopleSoft component interfaces.
For more information about the PeopleSoft libraries that the adapter requires, see Setting Up Your Adapter's Environment.
- PeopleSoft Components. In PeopleSoft, applications are built using PeopleSoft components, which are graphical user interface pages, business logic, and data, that are grouped together for specific business purposes.
-
Component Interfaces. Component interfaces (CIs) are PeopleTools
objects that expose PeopleSoft component business logic and data to external applications, enabling the external
applications to find, create, modify, or delete data (records) from the components synchronously, in real-time. The Adapter for PeopleSoft uses PeopleSoft's component
interface Java APIs to perform operations on PeopleSoft components. PeopleSoft applications provide predefined CIs; you
can also create custom CIs using PeopleSoft's Application Designer.
A component interface maps to one, and only one, PeopleSoft component. A component interface is created in the PeopleSoft Application Designer. Record fields on the PeopleSoft component are mapped to the keys and properties of the component interface. Methods are used to find, create, modify or delete data.
A CI instance is a CI object that is populated with a single group of data (called a record throughout this guide) that describes a unique business object. The Adapter for PeopleSoft enables you to perform operations on CI records.
Component interface keys, methods, properties, and collections are described as follows:
- Keys. Keys are properties containing values that uniquely identify an instance (or record) of a component interface. When you create a component interface, keys are automatically created based on the underlying component's search record. However, you can add or change certain keys if desired.
-
Methods. A method performs a specified task on a component interface at run time. There are two types of component interface methods: standard methods and user-defined methods.
The Adapter for PeopleSoft supports standard methods, which are automatically generated when you create a component interface.They provide basic data processing functions such as Create, Find, Get, Cancel, and Save. Data collection methods enable you to access an item by key, index, or effective date.
The Adapter for PeopleSoft does not support user-defined methods.
-
Properties and Collections. Properties provide access to
component data and CI settings and status. There are two types of properties: standard properties and user-defined
properties. Standard properties (such as InteractiveMode, GetHistoryItems, and EditHistoryItems) are assigned
automatically when a component interface is created. User-defined properties map to record fields in PeopleSoft
components. Both types of standard properties are available to the Adapter for PeopleSoft. Note: The properties that are available to the adapter are limited to the properties that are available for the version of PeopleSoft with which you are using the adapter.
A collection is a group of properties that corresponds to a scroll level, its fields, and its subordinate scrolls in the underlying component.
For more information about PeopleSoft components and component interfaces, see the PeopleBooks documentation.
This diagram shows a typical business integration where an adapter service is used to update the PeopleSoft system with employee data. The employee data could be provided by several different types of external Integration Server clients.
For more detailed descriptions of run-time data flow and processing, see the descriptions of the different types of services in Adapter Services.
Package Management
The Adapter for PeopleSoft is provided as a package called WmPeopleSoftAdapter. You manage the adapter package the same way you manage any package on the Integration Server. There are several considerations regarding how you set up and manage your packages on the Integration Server, such as those described in the following list.
- Create user-defined packages for your connections and adapter services. See Adapter for PeopleSoft Package Management for details.
- Understand how package dependencies work so you make the best decisions regarding how you manage your connections and adapter services. See Package Dependency Requirements and Guidelines for details.
- Control which development groups have access to which adapter services. SeeGroup Access Control for details.
- Understand how clustering, an advanced feature of the Integration Server, works to effectively manage your adapter services. See Adapter for PeopleSoft in a Clustered Environment for details.
- Enable and disable packages. See Enabling Packages and Disabling Packages for details.
Adapter Connections
The Adapter for PeopleSoft uses adapter connections to define how its adapter services connect to PeopleSoft systems. Each Adapter for PeopleSoft connection contains a set of connection parameters, including the release of the PeopleTools version to which the adapter will connect, and the logon parameters that the adapter requires to connect to the PeopleSoft system.
You configure Adapter for PeopleSoft connections for use with adapter services. You must configure an adapter connection before you can configure an adapter service.
You configure connections using the Integration Server Administrator. For instructions for configuring and managing Adapter for PeopleSoft connections, see Adapter Connections.
Connection Pooling
The Integration Server includes a connection management service that dynamically manages connections and connection pools based on configuration settings that you specify for the connection. All adapter services use connection pooling.
A connection pool is a collection of connections with the same set of attributes. The Integration Server maintains connection pools in memory. Connection pools improve performance by enabling adapter services to reuse open connections instead of opening new connections.
Run-Time Behavior of Connection Pools
When you enable a connection, the Integration Server initializes the connection pool, creating the number of connection instances you specified in the connection's Minimum Pool Size field. Whenever an adapter service needs a connection, the Integration Server provides a connection from the pool. If no connections are available in the pool, and the maximum pool size has not been reached, the server creates one or more new connections (according to the number specified in Pool Increment Size) and adds them to the connection pool. If the pool is full (as specified in Maximum Pool Size), the requesting service will wait for the Integration Server to obtain a connection, up to the length of time specified in the Block Timeout field, until a connection becomes available. Periodically, the Integration Server inspects the pool and removes inactive connections that have exceeded the expiration period that you specified in the connection's Expire Timeout field.
If the connection pool initialization fails, due to a network connection failure or some other type of exception, you can enable the system to retry the initialization any number of times, at specified intervals.
Changing the Connection Associated With an Adapter Service at Design Time
Integration Server provides a built-in service that you can use at design time to change the connection associated with an adapter service. This built-in service, named setAdapterServiceNodeConnection, is provided in the WmART package's pub.art.service folder. Using this service, you can change the specific connection associated with an adapter service at design time so that you do not need to create and maintain multiple adapter services.
For details, see the IBM webMethods Integration Server Built-In Services Reference for your release.
Changing the Connection Associated with an Adapter Service at Run Time
The Integration Server enables you to dynamically select the connection a service uses to interact with the adapter's resource. This feature enables one service to interact with multiple, similar backend resources.
For example, a service can be defined to use a default connection that interacts with your company's production database. However, at run time you can override the default connection and instead use another connection to interact with the company's test database.
For more information about overriding a service's default connection at run time, see Dynamically Changing a Service's Connection at Run Time.
Built-In Services For Connections
The Integration Server provides built-in services that enable you to programmatically control connections. You can use them to:
- Enable and disable a connection
- Return usage statistics and the current state (Enabled or Disabled) and error status for a connection
- Change the connection associated with an adapter service (for more information, see Changing the Connection Associated With an Adapter Service at Design Time).
These services are located in the WmART package, in the pub.art.connection folder. For details, see the IBM webMethods Integration Server Built-In Services Reference for your release.
Adapter Services
Adapter services enable the Adapter for PeopleSoft to perform operations on PeopleSoft systems through the use of PeopleSoft component interfaces. You configure adapter services using adapter service templates, which are provided with the Adapter for PeopleSoft. Each template represents a CI operation. For example, the Get service template enables you to configure an adapter service that uses the CI Get method to retrieve user-specified data from a PeopleSoft system. Adapter service templates contain all of the code that is necessary to perform an operation on a PeopleSoft system, but without the PeopleSoft CI data specifications. You provide these specifications when you configure an adapter service.
Configuring a new service from an adapter service template is straightforward. Using Designer, you assign a default adapter connection to the service, select the adapter service template, and supply the service's data specifications.
After you configure a service, you can incorporate it into a flow or Java service to interact with a PeopleSoft component interface. For example, you can create a flow service that collects employee information from another backend system and then call an Insert adapter service within the flow service to insert the employee information into your PeopleSoft system.
You can configure adapter services for PeopleSoft-supplied component interfaces or for custom component interfaces. Before configuring services for custom component interfaces, you must build the APIs for those component interfaces using PeopleSoft's Application Designer. See Setting Up Your Adapter's Environment for details.
The Adapter for PeopleSoft provides adapter service templates for the following adapter services:
| Service Type | Description | See page... |
|---|---|---|
| Get | The Get service retrieves a record from PeopleSoft matching the data specifications (keys) you specify. | Get Services |
| Find | The Find service retrieves a set of records that match the data specifications (keys) you specify. | Find Services |
| Insert | The Insert service inserts data records into a PeopleSoft system. | Insert Services |
| Update | The Update service identifies and then updates a record in PeopleSoft. | Update Services |
| Delete Row | The Delete Row service identifies a child-level record that matches user-specified key criteria, then deletes the record. | Delete Row Services |
Using Adapter Services
The following table lists the tasks required to use adapter services:
| Task | Use... | |
|---|---|---|
| 1 | Configure an adapter connection. See Adapter Connections for details. | Integration Server Administrator |
| 2 | Select the appropriate adapter service template and configure the
adapter service. See Adapter Services for more information about configuring adapter services. |
Designer |
| 3 | If you plan to use an Integration Server flow or Java service to invoke the adapter service, design the flow or Java service to use this adapter service. For details, see the IBM webMethods Service Development Help for your release. | Designer |
| 4 | Manage the adapter service. See Package Management, Adapter Services, and Logging and Exception Handling for details. | Designer and Integration Server Administrator |
Get Services
The Get service retrieves a record from PeopleSoft that matches the data specifications (keys) you specify. The Get service returns an entire CI record (all levels of the record). That is, the Get service retrieves a parent-level record plus any of that record's child-level records.
Get Service Run-Time Processing
This diagram illustrates the run-time data processing for the Adapter for PeopleSoft's Get service.
| Step | Description |
|---|---|
| 1 | A flow or Java service, typically invoked by an Integration Server client, initiates the
Get service on the Integration Server. You configure the Get service, and the wrapping flow or Java service, using Designer. |
| 2 | The Get service retrieves a connection from the service's associated
connection pool. You configure and enable the adapter connection using the Integration Server Administrator. For more information about connection pooling, including the run-time behavior of connection pools, see Connection Pooling. |
| 3 | The Get service uses the PeopleSoft component interface Java APIs
along with PeopleSoft libraries (which you installed in the Integration Server in Setting Up Your Adapter's Environment) to connect to the PeopleSoft system and
identify the record to retrieve. The service's input signature includes CI key fields that the service uses to
identify the record to retrieve. You define the Get service's input signature when you create the service. Fields that you select on the Key Fields tab in the adapter service template become the service's input signature. |
| 4 | The component interface returns the matching record, and any of that
record's child-level records, to the Integration Server pipeline in the form of an IData object. The IData object preserves the parent-child
structure of the CI and consists of the properties that are selected on the service's Output Fields tab. Note: If more than
one parent-level record matches the keys specified in the service's input, the adapter returns null and the
PeopleSoft server issues an error message.
|
Find Services
The Find service retrieves a set of records from PeopleSoft that match the data specifications (keys) you specify.
When specifying keys, you can specify a full name, a partial name, or you can leave the field empty. If you leave the field empty, the service will retrieve all records. You can also use the wildcard characters supported by PeopleSoft, which are the percent sign character (%) and the underscore character ( _ ).
- Using the percent sign (%) in a field will match a string of zero or more characters. For example: A% matches any string starting with A, including just A.
- Using the underscore character (_) in a field will match any single character. For example: _om matches a string that begins with any character followed by _om, such as Tom or Home.
To use one of the PeopleSoft wildcard characters as a literal character in a key field (for example, to include an underscore (_) in your string), precede the character with a backslash character (\). For example: \_.
Find Service Run-Time Processing
This diagram illustrates the run-time data processing for the Adapter for PeopleSoft's Find service.
| Step | Description |
|---|---|
| 1 | A flow or Java service, typically invoked by an Integration Server client, initiates the
Find service on the Integration Server.
You configure the Find service, and the wrapping flow or Java service, using Designer. |
| 2 | The Find service retrieves a connection from the service's associated
connection pool. You configure and enable the adapter connection using the Integration Server Administrator. For more information about connection pooling, including the run-time behavior of connection pools, see Connection Pooling. |
| 3 | The Find service uses the PeopleSoft component interface Java APIs
along with PeopleSoft libraries (which you installed in the Integration Server in Setting Up Your Adapter's Environment) to connect to the PeopleSoft system,
validate the service's input key fields (collection), and identify the records to retrieve. The service's
input signature includes CI key fields that the service uses to identify the records to retrieve. You define the Find service's input signature when you create the service. Fields that you select on the Key Fields tab in the adapter service template become the service's input signature. |
| 4 | The component interface returns a set of find keys for zero or more
parent-level CI records that match the criteria specified in the Find service's input signature. The service
returns the data to the Integration Server pipeline in the form of a document list (IData object). You define the Find service's output signature when you create the service. Fields that you select on the Output Fields tab in the adapter service template become the service's output signature. |
Insert Services
The Insert service inserts data records into a PeopleSoft system.
The following list contains guidelines for using Insert services:
- For the Insert service to run successfully, at least one non-key field must be specified in the service's input signature.
- To insert child-level records successfully, all key fields for the record must be specified in the input signature.
- If the record already exists in the PeopleSoft database, the service throws error message.
- The Insert service enables you to simultaneously insert multiple rows of records of level 1 and up.
Insert Service Run-Time Processing
The following diagram illustrates the run-time data processing for the Adapter for PeopleSoft's Insert service.
| Step | Description |
|---|---|
| 1 | A flow or Java service, typically invoked by an Integration Server client, initiates the
Insert service on the Integration Server.
You configure the Insert service, and the wrapping flow or Java service, using Designer. |
| 2 | The Insert service retrieves a connection from the service's
associated connection pool. You configure and enable the adapter connection using the Integration Server Administrator. For more information about connection pooling, including the run-time behavior of connection pools, see Connection Pooling. |
| 3 | The Insert service uses the PeopleSoft component interface Java APIs
along with PeopleSoft libraries (which you installed in the Integration Server in Setting Up Your Adapter's Environment) to connect to the PeopleSoft system,
initiate create keys, and insert the record (including all associated child-level records) into the PeopleSoft
system, assigning values to the fields specified in the service's input signature. If the service is successful, it executes the standard PeopleSoft Save method. The Save method commits any changes to the database. If the PeopleSoft server throws exceptions while creating or saving records, the adapter will throw those same exceptions. For information about how the adapter handles PeopleSoft errors, see Handling PeopleSoft Exceptions. The service's input signature includes key fields that the component interface requires to be able to insert a record into PeopleSoft, and input fields that the contain additional fields for the record. You define the Insert service's input signature when you create the service. All fields on the Key Fields tab in the adapter service template are included in the service's input signature, and fields that you select on the Input Fields tab, become the service's input signature. |
| 4 | The Insert service returns a status document indicating whether or not
the service was successful. You can optionally include this status message in the service's output signature.
This status is added to the pipeline of the Insert service. You define the Insert service's output signature when you create the service. Select the STATUS option on the Output Fields tab in the adapter service template to include the STATUS message in the service's output signature. |
Update Services
The Update service identifies a specific CI record and then updates all levels of that record in PeopleSoft, as specified in the service. The Update service enables you to simultaneously update multiple rows of child-level (level 1 and up) records.
The Update service supports effective date processing. See Effective Date Processing for more information about how Update services process operations with the Effective Date Processing option enabled.
Update Service Run-Time Processing
The following diagram illustrates the run-time data processing for the Adapter for PeopleSoft's Update service.
| Step | Description |
|---|---|
| 1 | A flow or Java service, typically invoked by an Integration Server client, initiates the
Update service on the Integration Server.
You configure the Update service, and the wrapping flow or Java service, using Designer. |
| 2 | The Update service retrieves a connection from the service's
associated connection pool. You configure and enable the adapter connection using the Integration Server Administrator. For more information about connection pooling, including the run-time behavior of connection pools, see Connection Pooling. |
| 3 | The Update service uses the PeopleSoft component interface Java APIs
along with PeopleSoft libraries (which you installed in the Integration Server in Setting Up Your Adapter's Environment) to connect to the PeopleSoft system and
then identify and update the specified record. The service allows you to update records at scroll levels 1 and up. Depending on the key values specified in the input signature, the child record is updated as follows:
If the service is successful, it executes the standard PeopleSoft Save method. The Save method commits any changes to the PeopleSoft database. If the PeopleSoft server throws exceptions while creating or saving records, the adapter will throw those same exceptions. For more information about how the adapter handles PeopleSoft errors, see Handling PeopleSoft Exceptions. You define the Update service's input signature when you create the service. Fields that you select on the Key Fields tab in the adapter service template become the service's input signature. |
| 4 | The Update service returns a status document (called STATUS)
indicating whether or not the service was successful. You can optionally include this status document in the
service's output signature. This status is added to the pipeline of the Update service. You define the Insert service's output signature when you create the service. Select the STATUS option on the Output Fields tab in the adapter service template to include the STATUS message in the service's output signature. |
Effective Date Processing
The Update services can access and update effective-dated child-level records according to the date of the record.
A record is defined as effective-dated if the EFFDT property exists in the record. The EFFDT property must be a key. A record does not have to have the EFFSEQ property for the operation to access an effective-dated record. If the EFFSEQ property does not exist, then the operation uses 0 as the sequence number.
The Adapter for PeopleSoft takes {EFFDT, Sequence Number} input values and passes them into PeopleSoft API getEffectiveItem(String date, long seqNum) to access a record.
The sequence number is equal to the EFFSEQ value or to 0. If a record with the specified EFFDT and sequence number already exists in the database, then the record will be updated. If a record with specified EFFDT and sequence number does not exist in the database, then a new record will be inserted into the database.
For example, if there are three records in the database containing the following dates:
| Row # | EFFDT | Sequence Number (EFFSEQ) | COMPRATE |
|---|---|---|---|
| 0 | 06/28/2005 | 0 | 15 |
| 1 | 06/17/2005 | 1 | 22 |
| 2 | 06/17/2005 | 0 | 25 |
The input parameters are {6/25/2005, 0}. The copy of row 1 will be created and the properties will be updated based on input values. The result of Update operation will be:
| Row # | EFFDT | Sequence Number (EFFSEQ) | COMPRATE |
|---|---|---|---|
| 0 | 06/28/2005 | 0 | 15 |
| 1 | 06/25/2005 | 0 | 22 |
| 2 | 06/17/2005 | 1 | 22 |
| 3 | 06/17/2005 | 0 | 25 |
Delete Row Services
The Delete Row service identifies a child-level record that matches user-specified key criteria, then deletes the record.
The following list contains guidelines for using Delete Row services:
- The Delete Row service does not support deleting parent-level records.
- The Delete Row service enables you to delete multiple child-level rows based on the keys specified in service's input signature.
- To delete a child-level row, you must specify key values for all of its parent levels. For example, to delete a level 3 record, you must specify key values for its level 1 and level 2 parent-level records.
- If the service's input signature only contains key
values for a level 1 record, then the whole level 1 record will be deleted, along with all of its children level
records (levels 2 and up). Note: The Adapter for PeopleSoft does not support scroll-level processing, which is the ability to access particular scroll-level items based on scroll keys, and then update or delete those items in PeopleSoft. To delete a child-level record (level 1 or higher), you must specify keys for all of the record's parent-level records in the service's input.
Delete Row Service Run-Time Processing
The following diagram illustrates the run-time data processing for the Adapter for PeopleSoft's Delete Row service.
| Step | Description |
|---|---|
| 1 | A flow or Java service, typically invoked by an Integration Server client, initiates the
Delete Row service on the Integration Server. You configure the Delete Row service, and the wrapping flow or Java service, using Designer. |
| 2 | The Delete Row service retrieves a connection from the service's
associated connection pool. You configure and enable the adapter connection using the Integration Server Administrator. For more information about connection pooling, including the run-time behavior of connection pools, see Connection Pooling. |
| 3 | The Delete Row service uses the PeopleSoft component interface Java
APIs along with PeopleSoft libraries (which you installed in the Integration Server in Setting Up Your Adapter's Environment) to connect to the PeopleSoft system and
identify the parent-level record containing the child-level row to delete. The service's input signature includes CI lookup key fields that the service uses to identify the parent-level record, and delete key fields that the service uses to identify and delete the child-level record. You define the Delete Row service's input signature when you create the service. Fields that you select on the Lookup Key Fields tab in the adapter service template, and fields you select on the Delete Key Fields tab, become the service's input signature. |
| 4 | The Delete Row service returns a status document indicating whether or
not the service was successful. You can optionally include this status message in the service's output
signature. This status is added to the pipeline of the Delete Row service. You define the Delete Row service's output signature when you create the service. Select the STATUS option on the Output Fields tab in the adapter service template to include the STATUS message in the service's output signature. You define the Delete Row service's output signature when you create the service. Fields that you select on the Output Fields tab in the adapter service template become the service's output signature. |
PeopleSoft-to-webMethods Communications
This section provides an overview of the adapter's PeopleSoft-to-webMethods (outbound) communications.
For PeopleSoft-to-webMethods communications, the Adapter for PeopleSoft takes advantage of PeopleSoft's Application Messaging (Integration Gateway) capabilities to invoke a service or post data on the Integration Server by publishing the appropriate message to the PeopleSoft Integration Broker.
You configure the PeopleSoft Integration Broker's Integration Gateway and define a node to communicate with the Integration Server. When you configure your connector and define the node, you specify an HTTPTARGET connector to post data to the Integration Server.
You specify a message in the PeopleCode program to be executed on a component's savePreChange or savePostChange event. PeopleSoft calls a savePreChange event before any database updates; PeopleSoft calls a savePostChange event after any database updates. You write a PeopleCode program so that it converts the modified record into an XML String. The XML string is sent to the HTTPTARGET connector you configured earlier. The HTTPTARGET connector then posts the XML string to the Integration Server.
A receive service on the specified Integration Server is invoked when data inside a PeopleSoft system is modified, added, deleted, or when any other kind of event occurs that requires invoking a service. The adapter provides a sample flow service that receives the XML data, parses the XML file, interprets the information, and then calls the appropriate service to perform the specified operation. If the PeopleSoft system expects a reply, then a reply XML document can be returned to the PeopleCode program. The PeopleCode program then interprets the returned XML string.
For a description of how PeopleSoft-to-webMethods transactions are processed, see PeopleSoft-to-webMethods Run-Time Processing.
For instructions for creating and using PeopleSoft-to-webMethods operations, see PeopleSoft-to-webMethods Communications.
For more information about Application Messaging and the Integration Broker, see the PeopleBooks documentation.
PeopleSoft-to-webMethods Run-Time Processing
The Adapter for PeopleSoft processes PeopleSoft-to-webMethods transactions at run time as follows:
| Step | Description |
|---|---|
| 1 | When data inside the PeopleSoft system is added, deleted, or modified, or when any other kind of event occurs that you want to have trigger PeopleSoft-to-webMethods communications, an HTTPTARGET Connector on the PeopleSoft system posts an XML document to the IBM webMethods Integration Server. |
| 2 | A Adapter for PeopleSoft receive service (such as receiveXML) receives the XML data, parses the XML file, interprets the information, and calls the appropriate service to perform the specified operation. |
| 3 | The result is returned as a message to the PeopleCode program. |
| 4 | The PeopleCode program that receives the XML string then interprets the returned XML string. |
Using Version Control Systems to Manage Adapter Elements
The adapter supports the Version Control System (VCS) Integration feature provided by Designer. When you enable the feature in Integration Server, you can check adapter packages or elements into and out of your version control system from Designer. For more information about the VCS Integration feature, see the Administering the VCS Integration Feature.
Beginning with Integration Server 8.2 SP3, the adapter supports the local service development feature in Designer. This feature extends the functionality of the VCS Integration feature to check package elements and their supporting files into and out of a VCS directly from Designer. For more information about local service development and how it compares to the VCS Integration feature, see the IBM webMethods Service Development Help.
Infrastructure Data Collector Support for the Adapter for PeopleSoft
Infrastructure Data Collector monitors the system and operational data associated with webMethods run-time components such as Integration Servers, Broker Servers, Brokers, and adapters, and reports the status of these components on Optimize for Infrastructure or other external tools. When you start monitoring an Integration Server, Infrastructure Data Collector automatically starts monitoring all ART-based adapters that are installed on the Integration Server.
For information about monitored key performance indicators (KPIs) collected for the monitored adapter components, see the Administering IBM webMethods Optimize and IBM webMethods Optimize User’s Guide for your release.
Viewing the Adapter's Update Level
You can view the list of updates that have been applied to the adapter. The list of updates appears in the Updates field on the adapter's About page in the Integration Server Administrator.
Controlling Pagination
About this task
When using the adapter on Integration Server 8.0 and later, you can control the number of items that are displayed on the adapter Connections screen and Notifications screen. By default, 10 items are displayed per page. Click Next and Previous to move through the pages, or click a page number to go directly to a page.
To change the number of items displayed per page, set the watt.art.page.size property and specify a different number of items.
To set the number of items per page