Connect for PeopleSoft User's Guide

APPENDIX B

Using Component Interfaces

This appendix describes how to create new component interfaces—and how to modify existing component interfaces—for use with PeopleSoft 8 and Novell exteNd Composer.

After generating and securing a component interface as described in this Appendix, you must generate its API, as described in Building PeopleSoft Component Interface API Classes in this guide.

NOTE:   This appendix is not a substitute for PeopleSoft documentation. For complete and up-to-date information about PeopleSoft integration APIs, see the PeopleSoft Online Library for your PeopleSoft system.

How to Create a New Component Interface

To create a component interface:

1. Launch the PeopleSoft Application Designer.

2. Choose New from the File menu.

   The New dialog box opens.

   

3. Select Component Interface and click OK. The Select Source Component for Component Interface dialog opens.

   

4. Select the component to use as a basis for a Component Interface.

5. Click the Select button.The Application Designer dialog opens.

   

6. To create the component interface without displaying individual properties for one-by-one selection, click No. Otherwise, to expose component properties manually, click No and drag the relevant fields from the left pane to the right pane.

   NOTE:   If the component interface is large, it is recommended that you expose the component properties manually as just described.

   See your PeopleBooks documentation for additional options and their meanings.

   

7. Designate the methods you wish to use in this Component Interface as described in the next procedure.

Methods

The standard methods created for a component interface are:

• Create

• Find

• Get

• Save

Only those methods actually implemented in the underlying component are available. For example, if the underlying component does not contain Add capabilities, Create is not available.

To designate Methods to use in the Component Interface

1. Open the Component Interface Properties dialog box (continuing from the procedure described previously).

   

2. Select the desired methods.

Properties

You may add properties from the records in the component view. You can also delete a property in the component interface that you do not want to expose. You can rename properties by clicking the property and then, clicking again until you can type a new name. If you rename a property, it can be referenced in the component interface only by the new name, not by the underlying component name.

Properties may have various icons adjacent to them. For example, EMPLID has an icon indicating that it is a key field from the underlying record. NAME has an icon indicating that it is an alternate key field from the underlying record. For a complete list of property icons, see the PeopleBooks documentation.

You can right-click both panes to select various functions to perform depending on which pane is active. For a complete list of functions, see the PeopleBooks documentation.

Securing a Component Interface

You must set up security for the component interface before you can begin testing.

Configuring Component Interface Security for PeopleSoft Version 8.1x

The following procedure describes how to configure component interface security for PeopleSoft Version 8.1 in 2- and 3-tier mode.

To configure component interface security:

1. From the Use menu, select Permission Lists, Component Interface, and then click Update/Display.

   Before Security can be set, the Permission List(s) must be identified.

   

2. Select the relevant Permission list.

   NOTE:   For more information on Permission Lists, see the PeopleBooks documentation.

   The following pane opens.

   

3. Insert the new component interface that you created.

4. Click Edit.

   NOTE:   When you select the component interface, all available methods appear, including user-defined methods. This enables you to specify whether this particular Permission List must have Full or Partial Access.

5. Select the desired level of access.

6. Click OK.

In the following example, the ALLPORTL Permission List has Full Access to all methods.

Configuring Component Interface Security for PeopleSoft Version 8.4+

The following sample procedure describes how to configure component interface security for PeopleSoft Version 8.4 or higher.

To configure interface security:

1. Expand PeopleTools, Security, User Profiles, and Permissions & Roles and then, click Permission Lists.

2. Click Search.

   The Permissions List search window opens.

   

3. Select the relevant Permission List.

   The Permissions List window opens.

   

4. Click the right arrow next to the Sign-on Times tab.

   The Component Interfaces tab becomes available.

   

5. Click the Component Interfaces tab.

6. Click the + button to add a new row to the Component Interfaces list.

   

7. Type the component interface name and click Edit.

   This example uses component interface AR_ITEM_AGENT.

   

8. Select the desired access from the drop-down lists.

9. Click OK.

   

10. Scroll down to the bottom of the Component Interface Permissions window and click Save.

Testing a Component Interface

The iWay Adapter for PeopleSoft 8 uses PeopleSoft metadata and component interfaces, therefore, it can accommodate new or modified component interfaces. The adapter makes no assumptions about component interfaces except that they are logical and valid. Therefore, each component interface must be tested before being used as a source for the adapter.

If changes are made to the underlying application by the user or by means of a PeopleSoft upgrade, and these changes invalidate a component interface, the user must repair the invalid component interface before the adapter uses it.

To test a component interface:

1. In Application Designer, select Test Component Interface from the Tools menu.

   The Component Interface Tester dialog box opens.

   

2. Click the Component Interface Tester dialog box to bring it to the foreground, if required.

3. To test the component interface using the Find method, click Find.

   The Component Interface Tester - Find Results window opens, displaying all of the possible entries for the underlying component. If there are more than 300 entries, a message appears.

   

4. Select a field in the left pane of the Find Results window.

5. To display the relevant data for that particular key, click Get Selected.

   

   If the security settings permit, you can change the values in the individual fields.

   

6. To test the component interface using the Get method, enter the existing key(s).

7. Click Get Existing.

   This returns the exposed properties for the key that you entered.

   You can change values if Update access has been specified.

   

8. To test the component interface using the Create method, enter all required key values.

9. Click Create New.

   When you enter valid values in `Create' keys, the JOBCODE Data Display window opens after the Table name is expanded with default data in place.

   

   You can change fields at this point. Changes are validated against the component's underlying business logic.

10. After you finish making changes, right-click the top item in the pane.

11. Click Save to save your changes.

The keys used to create the record can be used with the Get method for viewing data.

The data that were added can be viewed in the PeopleSoft Component as shown in the following example.

Notice the Effective Date as one of the default values.

You have finished testing the component interface. Before using the component interface, you must generate its API, as described at Building PeopleSoft Component Interface API Classes.

Copyright © 2004-2005 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved.  more ...