Peoplesoft View & Form 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 is 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 input group (see Connection Override). 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 at runtime a user name and password that is used by this builder 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 the connection 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. There are several combinations of TRUE and FALSE settings you can apply: "Get History Items" is TRUE and "Edit History Items" is TRUE The LJO accesses the data in the component interface in Correction mode. This means 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. This means 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: 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 the 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 Find 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.

Table 4. Input Page Options inputs

Input Name	Description
Create Input Page	Enable this input to cause the builder to create an input page. This page supplies the builder with inputs used to call either the Find or Get methods of the component interface. If the builder is configured to create a search results page, the input page contains one input field for each of the FindKeys supported by the component interface. If a details page has been created by the builder, the input page contains one input field for each of the component interface GetKeys.
Input Page HTML	Select an HTML page to be used as the basis for an input page. This page must contain certain named elements so that the builder knows where to place the page content. See the factory/pages/peoplesoft_inputform.html page for an example. Alternately, you can use the default HTML template named ps_inputform.html to create a generic looking input page. This page already contains the required elements named input_form, input_data, and submit_button.
HTML Template File	Select an HTML Page Automation template file that is used to generate the input page. Note: When an HTML Template file is in use, a number of inputs that have to do with HTML class name generation are not displayed.
Input Page Type	Specify the type of view page that is created. You can choose: Create fields from function schema To have page fields created automatically based on the PeopleSoft component interface schema. Use fields from imported HTML To base page fields on those present in the HTML of the page specified in the Edit Page input.

Table 5. Search Results Page Options inputs

Input Name	Description
Create Search Results Page	Enable this input to create a search results page. This page is used to display the results of invoking the Find method of the component interface. The content of the page is determined by the selection of the Find Behavior input. Note: The PeopleSoft server may limit the number of search results that are returned by a call of the Find method. If you do not see the expected set of search results, try specifying a more restrictive set of FindKeys that returns a smaller set of matching component interface instances.
Search Results Page HTML	Select an HTML page to be used as the basis for the search results page. This page must contain certain named elements so that the builder knows where to place the page content. See the factory/pages/ps_view.html page for an example. Alternately, you can use the default HTML page named ps_view.html to create a generic search results page. This page already contains the required elements named data and paging_buttons.
HTML Template File	Select an HTML Page Automation template file that is used to generate the results page. Note: When an HTML Template files is in use, a number of inputs that have to do with HTML class name generation are not displayed.
Search Results Page Type	Specify the type of input page that is created. You can choose: Create fields from function schema To have page fields created automatically based on the PeopleSoft component interface schema. Use fields from imported HTML To base page fields on those present in the HTML of the page specified in the Edit Page input above.
Search Results Link tag	This input is available when the builder is configured to create a search results page and a detail page. Select the search results page tag on which to place a link that, when pressed, displays the detail page for the associated component interface.
Paged Data Display	Whether or not to display a paged view of the search results. By default, a paged view is enabled.
Rows Per Page	Number of search results rows to display per page. If no value is given, each page contains five rows.

Table 6. Detail Page Options inputs

Input Name	Description
Create Detail Page	Enable this input to create a component interface detail page. This page is used to display the detailed content of a component interface instance.
Detail Page HTML	Select an HTML page to be used as the basis for the detail page. This page must contain certain named elements so that the builder knows where to place the page content. See the factory/pages/ps_view.html page for an example. Alternately, you can use the default HTML page named ps_view.html to create a generic detail page. This page already contains the required elements named data, edit_button, and cancel_button.
HTML Template File	Select an HTML Page Automation template file that is used to generate the detail page. Note: When an HTML Template files is in use, a number of inputs that have to do with HTML class name generation are not displayed.
Detail Page Type	Specify the type of detail page that is created. You can choose: Create fields from function schema To have page fields created automatically based on the PeopleSoft component interface schema. Use fields from imported HTML To base page fields on those present in the HTML of the page specified in the Edit Page input.

Table 7. Edit Page Options inputs

Input Name	Description
Create Edit Page	Enable this input to create a component interface edit page. This page is used to display the detailed content of a component interface instance and allow a user to edit the content.
Edit Page HTML	Select an HTML page to be used as the basis for the edit page. This page must contain certain named elements so that the builder knows where to place the page content. See the factory/pages/ps_inputform.html page for an example. Alternately, you can use the default HTML page named ps_inputform.html to create a generic Edit page. This page already contains the required elements named input_form, input_data, submit_button, and cancel_button.
HTML Template File	Select an HTML Page Automation template file that is used to generate the edit page. Note: When an HTML Template files is in use, a number of inputs that have to do with HTML class name generation are not displayed.
Edit Page Type	Specify the type of edit page that is created. You can choose: Create fields from function schema To have page fields created automatically based on the PeopleSoft component interface schema. Use fields from imported HTML To base page fields on those present in the HTML of the page specified in the Edit Page input.

Table 8. Label Translation and Sample HTML inputs

Input Name	Description
Create Sample Input Page	This input is available when the builder is configured to create an input page. Click this button to generate a sample HTML input page based on the builder inputs that you specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.
Create Sample Search Results Page	This input is available when the builder is configured to create a search results page. Click this button to generate a sample HTML search results page based on the builder inputs you specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.
Create Sample Detail Page	This input is available when the builder is configured to create a component interface detail page. Click this button to generate a sample HTML detail page based on the builder inputs you specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.
Create Sample Edit Page	This input is available when the builder is configured to create an edit page. Click this button to generate a sample HTML edit page based on the builder inputs you specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.

Table 9. 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 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 enter 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 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 to use different credentials than the ones specified in the properties file.

Table 10. Advanced input

Input Name	Description
Generate Main	Enable this input to allow this builder to automatically generate a Main action. This action displays one of several pages depending upon which pages this builder is configured to create. Disable this input to use a custom Main action of your own creation.