View & Form builder inputs - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

View & Form builder inputs

This topic describes the inputs for the View & Form builder.

General input
View Page Options
Input Page Options
Row Details Support
Update Page Support
Label Translation and Sample HTML
Advanced

General input

Table 1. View & Form builder General inputs
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
View Data Operation Name of the method or data service that is responsible for producing the data to be displayed on the view page.
The builder invokes this method before it displays the view page.
View Variable This input is available if you specify a method in the View Data Operation input.
Specify the name of the variable that is populated with data when the builder invokes the specified view method. After invoking the view method, the builder displays the content of this variable.
Use Theme Set this input to use the properties specified in the default WebApp theme where applicable. Setting this input also overrides any related base page, HTML template, and style sheet inputs with values from the default WebApp theme. The related builder inputs are not available if this input is set.

View Page Options

Table 2. View & Form builder View Page Options inputs
Input Name Description
View Page HTML

Specify an HTML page to be used as the basis for the view page.This page must have the following:

A data element that defines where the view data is to be displayed.
An element named paging_buttons that defines where paging buttons are to appear.

See the default factory/pages/view_and_form_view.html page for an example.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
HTML Template File

Select an HTML page automation template file that is used to generate the view page.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Style Sheet Override

File to be used to override the default style sheet from the HTML template.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
View Page Type Indicate the way that the fields on the view page are to be created.

Create fields from view variable schema

Page fields are created automatically from the schema.

Use fields from imported HTML

Page fields are taken from the file specified in the View Page HTML input.

Paged Data Display When this input is set, the builder adds paging buttons to the view. See the Add Paging Buttons input in Advanced.
Rows Per Page This input is available if the Paged Data Display input is set.
Enter the number of rows to display per page.

Input Page Options

If you enable the Create Input Page input, the remaining inputs in the group are available.

Table 3. View & Form builder Input Page Options inputs
Input Name Description
Create Input Page Causes the builder to create an input page for the view data operation.
The page is used to supply input parameters to the view method being called by the builder.
Input Variable This input is available if you specify a method in the View Data Operation input.
Name of the variable used by the view method to specify its input parameters. When the input page is submitted, the given values are placed in this variable before the builder invokes the specified view method.
Input Page HTML

Select an HTML page to be used as the basis for the input page.
This page must have several named elements that define where the builder is to place page items related to collecting the view method inputs. See the default factory/pages/view_and_form_inputform.html page for an example of the required elements and their names.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
HTML Template File

Select an HTML page automation template file that is used to generate the input page.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Style Sheet Override File to be used to override the default style sheet from the HTML template.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Input Page Type Indicate the way that the fields on the input page are to be created.

Create fields from variable schema

Page fields are created automatically from the schema.

Use fields from imported HTML

Page fields are taken from the file specified in the Input Page HTML input.

Enable Input Validation Enable to activate schema-based validation on the input page. Schemas can contain details about field input requirements, including data type restriction.
See the details about how validation works by reading the help for a Data Page builder. This help also links to the document about Techniques for Data Entry Validation.
Post-Save Method

Specify the action to be invoked after the data is saved.
Post-Save Method Behavior

Select what happens if validation errors occur.

Always call the Post-Save method

Call the method specified in the Post-Save Method input regardless of validation errors.

Call the Post-Save method only if all fields were valid

If no validation errors occur, call the method specified in the Post-Save Method input.

Input Submit Text Enter a text string for the button that submits the input page.
If none is specified, uses the INPUT value from the imported HTML file (Submit by default).
Back Button Text Enter a text string for a button to be created on the view page to return the user to the input page from the view page.
If blank, no back navigation is provided on the view page.
Insert Input Form In View Page Enable to place the input form at the top of the view results page.
You can do this to facilitate repeated searching based on new inputs.

Row Details Support

If you enable the Create Link To Details input, the remaining inputs in the group are available.

Table 4. View & Form builder Row Details Support inputs
Input Name Description
Create Link To Details Enable this input to create a link from a column in the view page to a details page.
This allows a user to drill down to the data returned by the view method or to call another method in the model that is responsible for returning detailed data corresponding to the selected row.
Note: When a user clicks on a link, all the data from the selected row is put into the builder-name_SelectedRowData variable. Other builders can refer to that variable to access the data.
Details Link Column Select a column on the view page that serves as the link column. The content of this column becomes a link that, when clicked, displays detailed data for the selected row.
Details Link Text Select the text to be used for the link in cases where the row does not contain any data.
Details Action Type Specify the type of action to be taken when a link is clicked.

Display data from another Data Service or method

To specify a data service operation or method for retrieving details data. If selected, a Details Method input is available.

Specify an action to call for showing details

To call an action (for example, a method or page) when a details link is clicked. This is used when you want to invoke an arbitrary action as a response to the link. This approach provides complete control over the behavior of details processing. For example, you could call the ShowResults method of another View & Form builder and pass as inputs values from the selected row.

Get Details data directly from selected row

To create a details page and return data directly to it when details link is clicked. In this case, details data is taken directly from the selected table row and displayed on the details page. In many cases, the data displayed on the view page is a small subset of the data produced by the view method. This approach provides the ability to display those items that were omitted from the view page.

Details Method This input is available when the Details Action Type is Display data from another Data Service or method.
Select a data service operation or method for retrieving details data.
Link Action This input is available when an action is specified as the Details Action Type input.
Use the picker to select a method or page action to invoke.
Details Page HTML This input is available if you specify the Details Action Type input, do not specify Specify an action to call for showing details, and the Use Theme is not enabled.

Specify an HTML page to be used as the basis for the details page. This page must have a data element that defines where the detailed data is to be displayed.
See the default factory/pages/view_and_form_view.html page for an example.
HTML Template File This input is available if you specify the Details Action Type input, do not specify Specify an action to call for showing details, and the Use Theme is not enabled.

Select an HTML page automation template file that is used to generate the details page.
Style Sheet Override File to be used to override the default style sheet from the HTML template.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Back Button Text Enter a text string for the button that returns to the view page from the details page.
If blank, no back navigation is provided.
Details Page Type Indicate the way that the fields on the details page are to be created.

Create fields from variable schema

Page fields are created automatically from the schema.

Use fields from imported HTML

Page fields are taken from the file specified in the Details Page HTML input.

Update Page Support

Use the inputs in this group to create a page (an update page) for editing details or results data. If you enable the Create Update Page input, the remaining inputs in the group are available.

Table 5. View & Form builder Update Page Support inputs
Input Name Description
Create Update Page Enable to create an update form page.
This page can be used to update retrieved data.
Update Method Specify a data service operation or a method to update data.
Update Variable If the Update Method input is not a data service, specify the variable that holds inputs to the update method.
Update Next Action Specify an optional action or page to execute after calling the update operation.
If no value is specified, user is returned to the page navigated from.
Data Initialization Used to control how to get the data for pre-populating the update form. You can choose:

Use result data to populate form fields
Specify data to populate form fields

Initial Data For Update Form This input is available when Data Initialization input is Specify data to populate form fields.
Use the value picker to select data to use to populate update form.
Update Page HTML

Specify an HTML page to be used as the basis for the update page.
This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Enable Update Validation Select this input to enable schema-based validation on the update page. Schemas can contain details about field input requirements, including data type restriction. See the details about how validation works by reading the help for a Data Page builder. This help also links to the help about techniques for data entry validation.
Post-Save Method Specify the action to be invoked after the data is saved.
Post-Save Method Behavior Select what happens if validation errors occur.

Always call the Post-Save method

Call the method specified in the Post-Save Method input regardless of validation errors.

Call the Post-Save method only if all fields were valid

If no validation errors occur, call the method specified in the Post-Save Method input.

Update Navigation Text Enter a text string for the button that navigates to the update page.
Example: Update, Edit
Update Submit Text Enter a text string for the button that submits the update page.
If this input is left blank, the INPUT value from the imported HTML file (Submit by default) is used as text.
Example: Submit, Go
Update Cancel Text Enter a text string for the cancel button displayed on the update page.
Example: Cancel

Label Translation and Sample HTML

Table 6. View & Form builder Label Translation and Sample HTML inputs
Input Name Description
Resource Bundle Name Use this input to specify a Java™ resource bundle to use for all labels for form fields and view columns. This input supports the internationalization of a model and provides a way to generate user-friendly labels for displayed fields.
Use the picker to select the fully-qualified name of the property file or Java class to serve as the form resource bundle.
For example: com.acme.FormResources
Create Sample View Page Click this button to generate a sample HTML view 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 Input Page Click this button to generate a sample HTML input 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 Details Page Click this button to generate a sample HTML details 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.

Advanced

Table 7. View & Form builder Advanced inputs
Input Name Description
Generate Main Enable this input to allow this builder to automatically generate a main action. This action starts the model execution and causes the display of either the input page (when an input page is requested) or view page.
Disable this input to use a custom main action of your own creation.
Add Paging Buttons If the Paged Data Display input is enabled (see View Page Options), this input is automatically enabled and adds default paging buttons to the view and form.
Disable the input to add your own Button builder or Paging Links builder. You can fully customize the Button builder or Paging Links builder, because the View & Form builder has limited control over paging button features.

Parent topic: View & Form builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
View Data Operation	Name of the method or data service that is responsible for producing the data to be displayed on the view page. The builder invokes this method before it displays the view page.
View Variable	This input is available if you specify a method in the View Data Operation input. Specify the name of the variable that is populated with data when the builder invokes the specified view method. After invoking the view method, the builder displays the content of this variable.
Use Theme	Set this input to use the properties specified in the default WebApp theme where applicable. Setting this input also overrides any related base page, HTML template, and style sheet inputs with values from the default WebApp theme. The related builder inputs are not available if this input is set.

Input Name	Description
View Page HTML	Specify an HTML page to be used as the basis for the view page.This page must have the following: A data element that defines where the view data is to be displayed. An element named paging_buttons that defines where paging buttons are to appear. See the default factory/pages/view_and_form_view.html page for an example. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
HTML Template File	Select an HTML page automation template file that is used to generate the view page. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Style Sheet Override	File to be used to override the default style sheet from the HTML template. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
View Page Type	Indicate the way that the fields on the view page are to be created. Create fields from view variable schema Page fields are created automatically from the schema. Use fields from imported HTML Page fields are taken from the file specified in the View Page HTML input.
Paged Data Display	When this input is set, the builder adds paging buttons to the view. See the Add Paging Buttons input in Advanced.
Rows Per Page	This input is available if the Paged Data Display input is set. Enter the number of rows to display per page.

Input Name	Description
Create Input Page	Causes the builder to create an input page for the view data operation. The page is used to supply input parameters to the view method being called by the builder.
Input Variable	This input is available if you specify a method in the View Data Operation input. Name of the variable used by the view method to specify its input parameters. When the input page is submitted, the given values are placed in this variable before the builder invokes the specified view method.
Input Page HTML	Select an HTML page to be used as the basis for the input page. This page must have several named elements that define where the builder is to place page items related to collecting the view method inputs. See the default factory/pages/view_and_form_inputform.html page for an example of the required elements and their names. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
HTML Template File	Select an HTML page automation template file that is used to generate the input page. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Style Sheet Override	File to be used to override the default style sheet from the HTML template. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Input Page Type	Indicate the way that the fields on the input page are to be created. Create fields from variable schema Page fields are created automatically from the schema. Use fields from imported HTML Page fields are taken from the file specified in the Input Page HTML input.
Enable Input Validation	Enable to activate schema-based validation on the input page. Schemas can contain details about field input requirements, including data type restriction. See the details about how validation works by reading the help for a Data Page builder. This help also links to the document about Techniques for Data Entry Validation.
Post-Save Method	Specify the action to be invoked after the data is saved.
Post-Save Method Behavior	Select what happens if validation errors occur. Always call the Post-Save method Call the method specified in the Post-Save Method input regardless of validation errors. Call the Post-Save method only if all fields were valid If no validation errors occur, call the method specified in the Post-Save Method input.
Input Submit Text	Enter a text string for the button that submits the input page. If none is specified, uses the INPUT value from the imported HTML file (Submit by default).
Back Button Text	Enter a text string for a button to be created on the view page to return the user to the input page from the view page. If blank, no back navigation is provided on the view page.
Insert Input Form In View Page	Enable to place the input form at the top of the view results page. You can do this to facilitate repeated searching based on new inputs.

Input Name	Description
Create Link To Details	Enable this input to create a link from a column in the view page to a details page. This allows a user to drill down to the data returned by the view method or to call another method in the model that is responsible for returning detailed data corresponding to the selected row. Note: When a user clicks on a link, all the data from the selected row is put into the builder-name_SelectedRowData variable. Other builders can refer to that variable to access the data.
Details Link Column	Select a column on the view page that serves as the link column. The content of this column becomes a link that, when clicked, displays detailed data for the selected row.
Details Link Text	Select the text to be used for the link in cases where the row does not contain any data.
Details Action Type	Specify the type of action to be taken when a link is clicked. Display data from another Data Service or method To specify a data service operation or method for retrieving details data. If selected, a Details Method input is available. Specify an action to call for showing details To call an action (for example, a method or page) when a details link is clicked. This is used when you want to invoke an arbitrary action as a response to the link. This approach provides complete control over the behavior of details processing. For example, you could call the ShowResults method of another View & Form builder and pass as inputs values from the selected row. Get Details data directly from selected row To create a details page and return data directly to it when details link is clicked. In this case, details data is taken directly from the selected table row and displayed on the details page. In many cases, the data displayed on the view page is a small subset of the data produced by the view method. This approach provides the ability to display those items that were omitted from the view page.
Details Method	This input is available when the Details Action Type is Display data from another Data Service or method. Select a data service operation or method for retrieving details data.
Link Action	This input is available when an action is specified as the Details Action Type input. Use the picker to select a method or page action to invoke.
Details Page HTML	This input is available if you specify the Details Action Type input, do not specify Specify an action to call for showing details, and the Use Theme is not enabled. Specify an HTML page to be used as the basis for the details page. This page must have a data element that defines where the detailed data is to be displayed. See the default factory/pages/view_and_form_view.html page for an example.
HTML Template File	This input is available if you specify the Details Action Type input, do not specify Specify an action to call for showing details, and the Use Theme is not enabled. Select an HTML page automation template file that is used to generate the details page.
Style Sheet Override	File to be used to override the default style sheet from the HTML template. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Back Button Text	Enter a text string for the button that returns to the view page from the details page. If blank, no back navigation is provided.
Details Page Type	Indicate the way that the fields on the details page are to be created. Create fields from variable schema Page fields are created automatically from the schema. Use fields from imported HTML Page fields are taken from the file specified in the Details Page HTML input.

Input Name	Description
Create Update Page	Enable to create an update form page. This page can be used to update retrieved data.
Update Method	Specify a data service operation or a method to update data.
Update Variable	If the Update Method input is not a data service, specify the variable that holds inputs to the update method.
Update Next Action	Specify an optional action or page to execute after calling the update operation. If no value is specified, user is returned to the page navigated from.
Data Initialization	Used to control how to get the data for pre-populating the update form. You can choose: Use result data to populate form fields Specify data to populate form fields
Initial Data For Update Form	This input is available when Data Initialization input is Specify data to populate form fields. Use the value picker to select data to use to populate update form.
Update Page HTML	Specify an HTML page to be used as the basis for the update page. This input is available if the Use Theme input is clear. Any value specified here is overridden if the Use Theme input is set.
Enable Update Validation	Select this input to enable schema-based validation on the update page. Schemas can contain details about field input requirements, including data type restriction. See the details about how validation works by reading the help for a Data Page builder. This help also links to the help about techniques for data entry validation.
Post-Save Method	Specify the action to be invoked after the data is saved.
Post-Save Method Behavior	Select what happens if validation errors occur. Always call the Post-Save method Call the method specified in the Post-Save Method input regardless of validation errors. Call the Post-Save method only if all fields were valid If no validation errors occur, call the method specified in the Post-Save Method input.
Update Navigation Text	Enter a text string for the button that navigates to the update page. Example: Update, Edit
Update Submit Text	Enter a text string for the button that submits the update page. If this input is left blank, the INPUT value from the imported HTML file (Submit by default) is used as text. Example: Submit, Go
Update Cancel Text	Enter a text string for the cancel button displayed on the update page. Example: Cancel

Input Name	Description
Resource Bundle Name	Use this input to specify a Java™ resource bundle to use for all labels for form fields and view columns. This input supports the internationalization of a model and provides a way to generate user-friendly labels for displayed fields. Use the picker to select the fully-qualified name of the property file or Java class to serve as the form resource bundle. For example: com.acme.FormResources
Create Sample View Page	Click this button to generate a sample HTML view 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 Input Page	Click this button to generate a sample HTML input 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 Details Page	Click this button to generate a sample HTML details 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.

Input Name	Description
Generate Main	Enable this input to allow this builder to automatically generate a main action. This action starts the model execution and causes the display of either the input page (when an input page is requested) or view page. Disable this input to use a custom main action of your own creation.
Add Paging Buttons	If the Paged Data Display input is enabled (see View Page Options), this input is automatically enabled and adds default paging buttons to the view and form. Disable the input to add your own Button builder or Paging Links builder. You can fully customize the Button builder or Paging Links builder, because the View & Form builder has limited control over paging button features.