PeopleSoft Component Interface builder inputs

Table 1. General input

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.

Table 2. Connection inputs

Input Name	Description
Properties File	Enter the name of the properties file to be used to establish a connection with the backend PeopleSoft server. Example: my_psoft.properties Note: This file must be located in the WEB-INF/config/peoplesoft_config directory
Test Connection Button	Click this button to test the builder connection to the PeopleSoft server. If the connection is successful, a connection confirmation dialog is displayed. If the connection is unsuccessful, an error dialog is displayed with information about why the builder was unable to contact the PeopleSoft server. The connection properties are taken from the properties file defined for the builder and any overrides you specified in the Connection Override group. If you have connection problems, remember to review both inputs for correctness.
Runtime Credentials	Select the type of credentials to use at runtime to access the PeopleSoft server. You can choose: Use same credentials properties for all users To use the user name and password credentials specified in the .properties file regardless of which user is running the PeopleSoft builder. Specify execution credentials To specify a user name and password that is used by this builder at runtime to access the PeopleSoft server.
Execution User Name	This input is available when Specify execution credentials is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the PeopleSoft user name. This location might be a variable or method result.
Execution Password	This input is available when Specify execution credentials is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the password.

Table 3. Component Interface Selection inputs

Input Name	Description
Get Component Interface Names Button	Click this button to get a list of Component Interfaces that are available on the PeopleSoft server. If successful, the component interface input picker lists the available component interfaces. If the operation was unsuccessful, an error dialog is displayed with information about why the builder was unable to get the list of component interfaces. Note: If the picker does not list any component interfaces or you do not see the expected list of names, the user name provided by the properties file may not have permission to access any component interfaces.
Component Interface	Select the name of the PeopleSoft component interface that is to be accessed by this builder.
Get History Items	This input and the Edit History Items input define how the component interface (and by extension the helper LJO) handles history rows when fetching and saving data. The following combinations of settings apply. Get History Items is TRUE and Edit History Items is TRUE The LJO accesses the data in the component interface in correction mode. All history rows are returned and you can edit and save all of these rows. Get History Items is TRUE and Edit History Items is FALSE The LJO accesses data in the component interface in update/display all mode. All history rows are returned when data is fetched. However, you can only edit rows with an effective date set in the future. Get History Items is FALSE The LJO accesses component interface data in update mode. The Edit History Items input has no effect when Get History Items is FALSE and therefore is not displayed. Note: The Get History Items and Edit History Items inputs are standard component interface properties, but they may not be available across all versions of the PeopleSoft access library (psjoa.jar). In some versions of the library, these properties are missing. The PeopleSoft builders detect when either of these properties are not supported by the library in use and issue warnings in IBM® WebSphere Portlet Factory Designer to alert the user of the potential problems getting and saving history rows.
Edit History Items	See the description of the Get History Items input. This input works in conjunction with the Get History Items input.
Find Behavior	This input allows you to customize the return data of the Find method and easily create search results pages based upon those results. Select the type of data to be returned by the builder when the Find method of the component interface is invoked through the builder. You can choose: Return key properties The builder returns only a collection of FindKeys that matches the partial FindKeys that were provided to the Find method of the component interface. Each member of the collection can be used to get the details for a specific component interface instance. Return all properties The builder returns a collection of component interface instances that contain the complete detail for each instance. This is equivalent to invoking the Get method for each component interface instance that matches the partial FindKeys provided to the Find method of the component interface. Return only top-level properties This builder returns a collection of component interface instances that contain only the top-level properties of each instance. This is equivalent to invoking the Get method for each component interface instance that matches the partial FindKeys but omitting any collection type properties of the instances.
Enable Schema Caching	Use this input to enable the caching of the schema for the specified PeopleSoft component interface. When this input is enabled, the builder regeneration phase uses a cached version of the component interface schema. If a different component is selected, a new version of the schema is cached. Selecting this option provides two benefits: Enhanced performance This helps during editing models containing this builder. Enhanced security A cached schema avoids exposing model generation time credentials once an initial regeneration is performed. To leverage this benefit, select Specify execution credentials in the Runtime Credentials input. Note: If the schema for the data on the PeopleSoft server changes, disable this input, regenerate the model, and enable this input again. Note: If you have the Generate Label Resources input checked, uncheck this input to generate the resource files for the labels. Once the resource bundles are generated, you can enable schema caching again, and disable the Generate Label Resources input.

Table 4. Connection Override inputs

Input Name	Description
Host Server	Use this input to override the HostServer property specified in the connection properties file. You typically do this if you need to use a different PeopleSoft server than the one specified in the properties file (or you need to profile the selection of the PeopleSoft server). Note: This input is a selectable list but is initially unpopulated. The only items that appear in this list are those you entered manually. To use this input, manually enter the name of the host server. Once entered, that name remains in the list for the duration of the current user's session.
User name	Use this input to override the UserName property specified in the connection properties file. You typically do this if you need to use different credentials than the ones specified in the properties file
Password	Use this input to override the Password property specified in the connection properties file. You typically do this if you need to use different credentials than the ones specified in the properties file

Table 5. Resource Bundle Generation input

Input Name

Description

Generate Label Resources

Enable this input to have the builder query a component interface for its property label metadata and construct resource bundles that can be used by other builders, such as Data Page, to create presentable web pages. One resource bundle contains long labels while the other contains short labels. The resource bundles are written to WEB-INF/source/nls and WEB-INF/classes/nls directories when the model is regenerated. The bundle names are created from a combination of the model path name, file name, builder name, and component interface name to ensure uniqueness. For example a model located in WEB-INF/models/a/b/c/Dee.model with a PeopleSoft Component Interface builder call named PSFT to a component named PERSONELL, generates a resource bundle with a name in the following format. WEB-INF/work/source/nls/a/b/c/Dee_PSFT_CI_PERSONELL_long.properties Note: The builder writes the resource bundles only if they do not already exist. Thus, you can manually customize the content of the bundles if you need to change one or more of the PeopleSoft provided labels for some reason. Note: To generate the resource files for the labels, disable the Enable Schema Caching input. If the resource bundles are generated, you can enable the Enable Schema Caching input again, and disable the Generate Resource Labels input.