You are on page 1of 28

A way for external applications, internal message handling, and other application environments to access PeopleSoft logic and

data without using the PeopleSoft pages.

It enables synchronous access to a PeopleSoft component from another application (PeopleCode, Java, C/C++, or Component Object Model [COM]).

A Component Interface is mapped to one and only a single Component but multiple Component Interfaces can be created for a single component.

Component interface architecture consists of three fundamental elements - Components - One or more pages performing a business
transaction that a component interface is associated with.

Component Interfaces - Unlike Components, Component Interfaces are

readily accessible by internal and external applications.

Component interface API - Application Programming Interface for a Microsoft COM application and Peoplecode.

Following are the 4 Main attributes of Component Interface

Name Unique name of the Component Interface. This is used by the calling functions to access its properties and methods.


Keys are automatically added when a new component interface is created. However they can be added, changed or removed. Get Keys These are mapped to the search key fields of the underlying component.
Find Keys These map to both search key and alternate search key fields of the underlying component.

Create Keys
-- Create keys are created for components that have

the Add action enabled.

Properties and Collections:

Provides access to record fields and scroll of the underlying component. CI include 2 types of Properties & Collections. -- Standard - Assigned automatically when a new
component interface is created. Standard properties can be set to true or False. Examples of Standard properties are InteractiveMode, GetHistoryItems and EditHistoryItems -- User Defined User Defined Properties & Collections are derived from the Component Interfaces associated Component and must be added manually.

Method is used to perform a specific task on component interface at runtime. Like Component Interface properties, there are two types of Methods - Standard - User Defined Standard methods are Find(), Get(), Save() and cancel() and these are generated automatically when a new component interface is created. However, runtime access to each method is determined by the security provided.

Select File, New from the Application Designer Menu.

Select source component for the Component Interface.

In the dialog box, select Yes to default the properties of the component to the Component Interface else No if properties need not be created initially.

Save the Component Interface.

The Component Interface object, instantiated from a session object, is created at runtime to access the data specified by the Component Interface. Component Interfaces are declared as type ApiObject. For example,
Local ApiObject &MYCI;

A Component Interface can be instantiated from peoplecode, Visual Basic, JAVA, COM and C++. Component variables are always local to its component or its Component Interface. In order to share the data between component and Component Interface then Global variables can be used.

Navigate to PeopleTools -> Security -> Permission lists & Roles -> Permission Lists Select the Permission list to which the security has to be set up. Add the newly developed Component Interface to this Permission list. Select the security access against each method. Atleast one method should be provided with Full access to make the component available for testing.

Component Interface tester is used to test the contents and behaviour of the CI.

WinMessage cannot be used in a component that will be used to build a Component Interface. Instead MsgGet() function can be used. SearchInit, SearchSave and RowInit Peoplecode events are not fired in CI. SendMail function cannot be used to send mails from CI. Instead TriggerBusinessEvent Peoplecode event can be used. Related display fields are not available for use in a CI.

Menu Peoplecode and Pop-up menus are not supported. DoSave (Save in the middle of a transaction) cannot be used. Any Peoplecode associated with the push buttons used on the page to add rows will not be invoked by the component Interface when an insert is made.

Maintain Business logic Validate the data using Component Interface tester. Excel to Component Interface tool for mass upload of the data into the PeopleSoft System. Access to all business logic. Maintain Data Integrity.