Choosing builders that create an initial user interface

Portlet Factory, Version 6.1.2

Choosing builders that create an initial user interface

The builders described in this topic are used to create an initial user interface for your application.

Table 1. Builders to create an initial user interface
Task Builder you should use
Access a service created in a service provider model. The Service Consumer builder makes a service available for use. The service must be defined in a service provider model, which is a model that uses Service Definition and Service Operation to create a service. You can also access a web service using Web Service Call builder, but you may want to consider putting the web service access in a provider model so that you can use features such as the automatic test harness and the stub service model support.
Create view and form pages based on data from a data service. The view page will display a table or single record of data from the service results. You can also create associated pages such as:

An input page for the specified operation, with optional validation.
A detail page that displays either data from the selected row in the view page or data from another data service or method.
An update page for editing details or results data
The View and Form builder can be used to generate several common UI page patterns.
Implement a details page triggered by clicking on a row in a table. Use the View and Form builder to create your table and select the choice for “Create link to details”. You then have three choices for how to handle the link action:

The details page can show the data already retrieved in that table row
The details page can show data from another operation, such as a service operation that retrieves details data. In this case, you will need to use the Input Overrides feature of the Service Consumer builder to specify the service inputs needed to retrieve the details data. These inputs can typically come from the SelectedRowData variable created by the View and Form builder.
The link can be used to execute any action you specify, such as an Action List or a page.
With any of these link types, the View and Form builder automatically creates a <name>_SelectedRowData variable that is populated with all the contents of the row that was clicked. Typically you will select values from this variable when choosing the inputs you need for your row action.
Create an input page for my data service operation, which does not return result data. The Input Form builder creates an input page for a data service operation or a method. It is much like View and Form input page support, but the next action after submitting the input form is a user-specified action. This builder is suitable for operations that do not have result data to display.
You have some existing HTML (or JSP) to use in an application. The Imported Page builder adds an existing HTML or JSP page to the current model. By using Imported Page builders, you can develop your HTML or JSP code in your favorite editor and then import the results into the Designer. After you import a page into the Designer, you can use builders to modify those pages.

Create a chart.

The Greenpoint WebCharts builder adds a chart to a page at a specified location. The data for the chart can come from a variable, a service operation, or any other data source in the model.

Use Lotus® Forms.

Use the Lotus Form Embed builder to embed a Lotus Form on a page. The form is retrieved from the forms repository and rendered to the user using the Lotus Forms Viewer. Use the Lotus Form Launch builder to add a control (button or link) to a page in your model to open a Lotus Form. The form is opened in a separate browser window.
Add some structured data to a page for input or viewing and have fields automatically generated based on the data's schema. The Data Page builder creates a structure based on the XML data in a variable and renders this structure as a form (both input and display) on a page. The structure created by the data page describes the data to be displayed as well as how to render the data on the form. A schema associated with the data on which the data page operates can determine how the data gets displayed as can the HTML page associated with the data page. The Data Page builder is used indirectly by high-level builders such as View & Form.
Quickly create a simple HTML page for use with other IBM WebSphere Portlet Factory builders. The Page builder is used to create a simple user interface using HTML or JSP markup. You can enter or paste markup directly into the builder.
Create view and form pages based on data from a specific back end system.
Note: Use for rapid prototyping only.
Domino View and Form
SAP View and Form
PeopleSoft View and Form
Siebel View and Form
Back end specific builders are used to create the initial user interface. However, with these types of builders, you do not get the benefits of a service provider and consumer architecture.

Library | Support |

Task	Builder you should use
Access a service created in a service provider model.	The Service Consumer builder makes a service available for use. The service must be defined in a service provider model, which is a model that uses Service Definition and Service Operation to create a service. You can also access a web service using Web Service Call builder, but you may want to consider putting the web service access in a provider model so that you can use features such as the automatic test harness and the stub service model support.
Create view and form pages based on data from a data service. The view page will display a table or single record of data from the service results. You can also create associated pages such as: An input page for the specified operation, with optional validation. A detail page that displays either data from the selected row in the view page or data from another data service or method. An update page for editing details or results data	The View and Form builder can be used to generate several common UI page patterns.
Implement a details page triggered by clicking on a row in a table.	Use the View and Form builder to create your table and select the choice for “Create link to details”. You then have three choices for how to handle the link action: The details page can show the data already retrieved in that table row The details page can show data from another operation, such as a service operation that retrieves details data. In this case, you will need to use the Input Overrides feature of the Service Consumer builder to specify the service inputs needed to retrieve the details data. These inputs can typically come from the SelectedRowData variable created by the View and Form builder. The link can be used to execute any action you specify, such as an Action List or a page. With any of these link types, the View and Form builder automatically creates a <name>_SelectedRowData variable that is populated with all the contents of the row that was clicked. Typically you will select values from this variable when choosing the inputs you need for your row action.
Create an input page for my data service operation, which does not return result data.	The Input Form builder creates an input page for a data service operation or a method. It is much like View and Form input page support, but the next action after submitting the input form is a user-specified action. This builder is suitable for operations that do not have result data to display.
You have some existing HTML (or JSP) to use in an application.	The Imported Page builder adds an existing HTML or JSP page to the current model. By using Imported Page builders, you can develop your HTML or JSP code in your favorite editor and then import the results into the Designer. After you import a page into the Designer, you can use builders to modify those pages.
Create a chart.	The Greenpoint WebCharts builder adds a chart to a page at a specified location. The data for the chart can come from a variable, a service operation, or any other data source in the model.
Use Lotus® Forms.	Use the Lotus Form Embed builder to embed a Lotus Form on a page. The form is retrieved from the forms repository and rendered to the user using the Lotus Forms Viewer. Use the Lotus Form Launch builder to add a control (button or link) to a page in your model to open a Lotus Form. The form is opened in a separate browser window.
Add some structured data to a page for input or viewing and have fields automatically generated based on the data's schema.	The Data Page builder creates a structure based on the XML data in a variable and renders this structure as a form (both input and display) on a page. The structure created by the data page describes the data to be displayed as well as how to render the data on the form. A schema associated with the data on which the data page operates can determine how the data gets displayed as can the HTML page associated with the data page. The Data Page builder is used indirectly by high-level builders such as View & Form.
Quickly create a simple HTML page for use with other IBM WebSphere Portlet Factory builders.	The Page builder is used to create a simple user interface using HTML or JSP markup. You can enter or paste markup directly into the builder.
Create view and form pages based on data from a specific back end system. Note: Use for rapid prototyping only.	Domino View and Form SAP View and Form PeopleSoft View and Form Siebel View and Form Back end specific builders are used to create the initial user interface. However, with these types of builders, you do not get the benefits of a service provider and consumer architecture.