Skip to Main Content
Return to Navigation

Testing Component Interfaces

After setting the security for a component interface, you can test the contents and behavior using the component interface tester. You should test the component interface before using it in your external system. This proactive tool helps you discover problems with the underlying component or the component interface itself, including user-defined methods. When you are testing a component interface, real data from the database is used. Therefore, if you save the information that you change by calling the Save method, the information is changed in the database.

With the component interface tester, you can:

Searching Component Interfaces to Test

To test the component interface, you search for the component interface to test, and then you test it.

Access the Component Interface Tester search dialog box:

Image: Component Interface Tester – Enter key values, choose function dialog box

This example illustrates the fields and controls on the Component Interface Tester – Enter key values, choose function dialog box . You can find definitions for the fields and controls later on this page.

Component Interface Tester - Enter key values, choose function dialog box

To search for a component interface to test:

  1. Open the component interface in PeopleSoft Application Designer.

  2. Select select Tools, then select Test Component Interface from the PeopleSoft Application Designer menu.

    The Component Interface Tester search dialog box appears. This dialog box displays the keys (in the left-hand columns) for getting, creating, or finding an instance of the component interface. The right-hand columns provide a place for you to enter sample key values for testing.

  3. Enter key values.

    1. Double-click the column to the right of any displayed keys.

    2. Enter the value in the right-hand column.

      The data that is used for the test corresponds to the key values that you enter here. In the preceding example, we have entered an employee ID of 6602.

Getting Existing Records by Using Partial Keys

If you want to retrieve a partial key, click the Find button on the Component Interface Tester page. The Find Results dialog box appears:

Image: Component Interface Tester — Find Results dialog box

This example illustrates the Component Interface Tester – Find Results dialog box. Use the page to get existing records by using partial keys.

Component Interface Tester - Find Results dialog box

You can choose the specific instance by selecting and clicking the Get Selected button. If you do not enter a partial key before clicking Find, all key values in the database are returned (subject to the maximum count of 300, just as when online). This is the same as calling the Find method through the component interface API, followed by selecting a value from the Find results, setting the Get key, and calling the Get method. After you click the Get Selected button, the Component Interface Tester dialog box appears.

Testing Component Interfaces

After you have searched for and retrieved the component interface, the Component Interface Tester dialog box appears.

Image: Component Interface Tester dialog box

This example illustrates the Component Interface Tester dialog box. Use the page to test component interface properties and methods.

Component Interface Tester dialog box

Testing Component Interface Properties

From the Component Interface Tester dialog box, change the value of a property, double-click a value, and enter a new value. Some basic validation is done when you leave the field, which is equivalent to leaving a field using the Tab key in the online case. This validation includes system edit, FieldChange PeopleCode events, and FieldEdit PeopleCode events. Further validation can be done when the Save method is called (SaveEdit, SavePreChange, Workflow, and SavePostChange). If errors occur or warnings are encountered, messages are displayed in the Error Message Log area at the bottom of the window. The error message log displays the same text that would appear in the PSMessages collection of the Session object if you accessed the component through the Component Interface API.

Testing Component Interface Methods

Test component interface methods by right-clicking the component interface name.

A menu appears that shows the Save and Cancel standard methods and any user-defined methods that exist for the component interface. The Find, Create, and Get standard methods are not valid for an instantiated component, and therefore are not shown.

If a component interface method requires one or more parameters, a dialog box in which you can enter the parameters appears. After the method is executed, the same dialog box appears again, displaying changes to the parameters that were caused by the method. The return value of the function appears in the title of the dialog box. If a component interface requires no parameters, you do not see the initial dialog box, but you do see the return value dialog box following the function call.

Image: Enter parameters dialog box

This example illustrates the Enter parameters dialog box. Use the page to enter required parameters for component interface methods.

Enter parameters: dialog box

Note: Because running a component interface method can result in a change to the component interface structure, PeopleSoft Application Designer always redraws the component interface tree in its collapsed form following a method call.

Testing Collection Methods

Test collection methods by right-clicking the collection name.

A menu appears that shows the standard collection methods. Select the collection method that you want to test for this component interface. After you select a collection method to test, the Enter parameters dialog box prompts you to enter an item number for the collection method that you are testing. The value that you enter for index [Number] is used to retrieve, insert, or delete an item, according to the following rules.

After you enter an index number, the result appears in the dialog box. If a return value is sent, it is displayed in the title bar. Otherwise, the message No value is displayed. Click OK or Cancel to dismiss the dialog box.

Collection Method Rules

This table describes the collection method rules:

Collection Method

Purpose

Item(index)

Returns the row at the specified index. Only the success or failure of this routine is of interest from inside the test component.

InsertItem(index)

Inserts a new row either before the index that you specify if the collection is effective-dated or following the index if it isn’t effective-dated.

DeleteItem(index)

Deletes the row that is designated by the index number that you specified in the Enter parameters dialog box.

ItemByKeys(key1, key2, …)

Returns the row corresponding to the specified keys. Only the success or failure of this routine is of interest from inside the test component.

CurrentItem

This method returns the effective row in an effective-dated record. Only the success or failure of this routine is of interest from inside the test component.

GetEffectiveItem(DateString, SeqNum)

Returns the data row that would be effective for the specified date and sequence number. This is a more general case of the GetCurrentItem function, which returns the definition that is effective at this moment. This method works with effective-dated records only.

GetEffectiveItemNum(DateString, SeqNum)

Returns the item number inside the collection of the data row that would be effective for the specified date and sequence number. This is a more general case of the GetCurrentItemNum function, which returns the number of the definition that is effective at this moment. This method works with effective-dated records only.

Note: Component interface classes contain information about collection methods.

Determining ItemByKeys Parameters

You can get the signature for the ItemByKeys method (or any other method) when testing a component interface. This is helpful for the ItemByKeys method, because its signature is different for each component interface.

Image: Enter parameters dialog box

This example illustrates the Enter parameters dialog box for the ItemByKeys method. Use the page to get the signature for any component interface.

Enter parameters: dialog box

To determine ItemByKeys parameters:

  1. Open the definition.

  2. Select select Tools, then select Test Component Interface.

  3. Find or get an appropriate populated component interface.

  4. Navigate to the appropriate collection.

  5. Right-click, and select ItemByKeys from the menu.

    A dialog box appears, showing the specific parameters and types and the order in which you should call ItemByKeys.

    In the preceding example, the keys for the SDK_BUS_EXP_PER ItemByKeys method are SDK_EMPID (String) and SDK_EXP_PER_DT (String).