Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Preparing PeopleSoft : Preparing PeopleSoft Component Interfaces

Preparing PeopleSoft Component Interfaces
TIBCO ActiveMatrix Adapter Service Engine for PeopleSoft uses PeopleSoft Component Interfaces as schemas and as APIs for formatting and processing data between a PeopleSoft application and the TIBCO environment. PeopleSoft Component Interfaces must be prepared so the design-time adapter can download them to the adapter’s configuration tool, TIBCO Designer.
You should use the Test Component Interface tool in the PeopleTools Application Designer to determine which fields are required and what values are valid for sending into PeopleSoft.
Eliminate any unnecessary records and fields from a Component Interface. The simpler the Component Interface, the easier it is to set up and test the adapter. Component interfaces containing fields from derived records are likely to cause errors.
The preparation steps given under Procedure assume you know PeopleSoft procedures. For complete information about creating Component Interfaces and making them available, go to the PeopleSoft website and follow the Peoplebook-PeopleTools link to “Integration Tools: PeopleSoft Component Interfaces.”
Procedure
Before configuring the adapter, do the following in your PeopleSoft system:
1.
2.
a.
Make sure the Component Interfaces have all the records and fields you need for the type of data the adapter will be processing.
b.
c.
On Microsoft Windows, from the menu, select Build > PeopleSoft APIs to generate the Java classes. Make sure the destination for the Java files points to %PS_HOME%\web\extapi.
Select the Build Java Classes check box. Select the PeopleSoft API’s CompIntfc.CompIntfcPropertyInfo and CompIntfc.CompIntfcPropertyInfoCollection along with the required CI’s, as shown in Figure 2.
Figure 2 Build PeopleSoft API Bindings
On UNIX, FTP the generated Java source files to the TIBCO_HOME/adapter/adpsft8/version_number/psoftapi/PeopleSoft/Generated/CompIntfc directory.
d.
On Microsoft Windows, compile the Java classes by running BUILDCI.bat from the TIBCO_HOME\adapter\adpsft8\version_number\bin directory.
On UNIX, compile the Java source by running BUILDCI.sh from the TIBCO_HOME/adapter/adpsft8/version_number/bin directory.
e.
On Microsoft Windows, verify that the built java classes are available in TIBCO_HOME\adapter\adpsft8\version_number\lib\ext\PeopleSoft\Generated\CompIntfc.
On UNIX, verify that the built java class files are in $TIBCO_ADPSFT8_HOME/lib/ext/PeopleSoft/Generated/CompIntfc.
f.
Use the PeopleSoft Maintain Security screen to grant full access permission to the Component Interface operator class that the adapter will use. For more information on granting permissions to CIs, refer to PeopleBooks.
If you are applying a PeopleSoft Component Interface to a Subscription Service or a Request-Response Service in the adapter, set up the fields in the CREATEKEYS, GETKEYS, and FINDKEYS folders in every Component Interface as shown in the following table. Remember, PeopleSoft Component Interfaces become schemas in the adapter.
To insert data into the PeopleSoft system make sure that both the CREATEKEYS and GETKEYS fields are filled in, regardless of whether it is new or recently updated.
The maximum number of records returned by the adapter's Request-Response Service is limited to 300. This is due to a limitation built into PeopleSoft which restricts the number of records resulting from a FIND query on a Component Interface.
The adapter provides the FINDKEYS functionality of PeopleSoft Component Interface technology as a feature which can be used with the adapter's Request-Response Service. The adapter fetches the schema for a particular Component Interface at design-time. In addition to the CREATEKEYS and GETKEYS schemas, the adapter now fetches the FINDKEYS schema as well. Hence, at runtime, if the FINDKEYS values are specified in the incoming request, they take precedence over any GETKEYS or CREATEKEYS values specified. The adapter's Request-Response Service uses the same FINDKEYS values to query PeopleSoft and returns, as a reply, a sequence of FINDKEY values, which satisfy the query criterion.
CI Publication Service
Every PeopleSoft component to be processed by a CI Publication Service of the adapter must have a shadow page (formerly “panel”) embedded in the component. Embedding is done in the PeopleTools Application Designer after you have configured the adapter in TIBCO Designer but before starting the adapter.
The shadow work page, TIB_CI_ADAPTER_WRK, is shipped with the adapter. It contains configuration-driven PeopleCode that extracts data from the component based on the adapter configuration settings.
To embed the shadow work page into a component:
1.
2.
Select File > Open. The Open Definition dialog appears.
3.
Select Component from the Definition drop-down list. In the Selection Criteria group, enter the name of the component in the Name box.
4.
Click the Open button, all components matching the specified selection criteria are shown in the lower part of the dialog, as shown in Figure 3.
Figure 3 The Open Definition Dialog
5.
Select the specified component matching the selection criteria and click the OK button again. The component information appears on the right upper pane in the Application Designer window.
6.
Select Insert > Page Into Component.... The Insert Page dialog appears.
7.
Enter TIB_CI_ADAPTER_WRK in the Name field, and then click the Insert button to add the TIB_CI_ADAPTER_WRK page into the component.
8.
Click File > Save to save the component.
9.
10.
Navigate to PeopleTools > Security > Permissions & Roles > Permission Lists on the Menu navigation frame. The Permission Lists pane appears on the right.
11.
12.
Click the Component Interfaces tab. If the CI you used is not listed in the Component Interface list, add it to the Component Interface list. Click Edit and give the Full Access (All) permission to your CI.
13.
Click the Pages tab, and then select the suitable Menu. Click Edit Components to find your CI in the Component list. Click Edit Pages and then check the Authorized? checkbox for the TIB_CI_ADAPTER_WRK page.
14.

Copyright © TIBCO Software Inc. All Rights Reserved