This section lists the main help topics for the supported builders.
The builder picker lists all of the builders that are available to be added to your IBM® WebSphere® Portlet Factory models. Some of these builders provide access to content from backend services, for example, a database, or from enterprise resource planning applications, for example, SAP, Siebel, or IBM Lotus® Domino®. Other builders focus on the user interface with these applications, such as submitting forms or displaying tabular data.
Choosing builders for common tasks
This topic lists common tasks and describes the builders you can use to accomplish each task.
Action List builder
The Action List builder adds a set of one or more actions to the WebApp.
Active Text builder
The Active Text builder extends the Text builder and facilitates rendering text on a page as an active link that is prefixed with a specified URI scheme.
Ajax Region builder
The Ajax Region builder converts the actions in a specified region of the page.
Ajax Type-Ahead builder
This builder attaches to an HTML text input field, and provides "type ahead" functionality for that input.
Use the Applet builder to call a Java applet from within a model.
Attribute Sequencer builder
The Attribute Sequencer builder modifies existing elements in a repeated region on a page by replacing or adding to any HTML attribute values that those elements support.
Attribute Setter builder
The Attribute Setter builder modifies existing elements on a page by replacing or adding to any HTML attribute values that those elements support.
Use this builder to add a bordered rectangle to a specified target page location.
The Breadcrumbs builder places a list of links to visited pages on a page in your model. Each link is called a breadcrumb.
Builder Skeleton builder
The Builder Skeleton builder provides an automated starting point for making new builders.
The Button builder adds a button input control to one or more pages in your model.
Cache Control builder
The Cache Control builder allows you to cache the output of a specific action within a model.
Calendar Picker builder
Category View builder
Use the Category View builder to enhance the display of data in which at least one column is both sorted and contains repeated values.
Use this builder to add charts and graphs to a page.
Check Box builder
Use the Check Box builder to create a single check box on a page.
Checkbox Group builder
Use the Checkbox Group builder to create a group of check boxes.
Client Event Handler builder
The Client Event Handler builder lets you specify a handler for a factory event that has been marked for client-side delivery.
Collapsible Section builder
The Collapsible Section builder arranges for an additional information section to be displayed (or hidden) when the user clicks a specified area on the page.
Use the Comment builder to add a comment to the builder call list.
Content Launch Action builder
The Content Launch Action builder adds a control (button or link) to a page in your model to open a file or resource that might require an additional plug-in to view or handle the content.
Contextual Menu builder
The Contextual Menu builder adds a pop-up menu to one or more pages in your model.
Cooperative Portlet Source builder
With the Cooperative Portlet Source and the Cooperative Portlet Target builders, you create portlets that can interact with each other to share information. One or more target portlets on a portal page can automatically react to changes from a source portlet when the source portlet triggers an event.
Cooperative Portlet Target builder
Use the Cooperative Portlet Target builder to define a Property Broker or C2A (Click to Action) event.
Data Column Modifier builder
Use the Data Column Modifier builder to modify a table column created by the Data Page builder.
Data Field Merge builder
This builder lets you merge fields so that they are presented as a single field and lets you merge columns so that they are presented as a single column.
Data Field Modifier builder
Use the Data Field Modifier builder to modify one or more fields created by a Data Page builder call.
Data Field Settings builder
The Data Field Settings builder lets you control all the page automation fields in a model.
Data Hierarchy Modifier builder
Use Data Hierarchy Modifier builder to group data fields generated by a Data Page builder or one of the builders that rely on Data Page builder.
Data Layout builder
The Data Layout builder uses a specified data layout template and layout field mapping to modify a layout generated by a Data Page builder.
Data Page builder
Use the Data Page builder to create forms that either display data, prompt the user to enter data, or are a combination of the two operations.
Data Services User Interface builder
This builder creates a complete application based on a well-defined service.
Date / Time Formatter builder
Use the Date / Time Formatter builder to control the display of fields in a form that contain a date, time, or date-time value.
Debug Tracing builder
Use the Debug Tracing builder to trace a variable or a specific action in a model.
Directory Search builder
The Directory Search builder provides a way for application users to search for and select people or groups.
Discardable Variable builder
The Discardable Variable builder lets you modify an existing variable so that it is not stored in session.
Display Manager builder
The Display Manager builder records changes made to the page automation layout by drag and drop operations in the Design panel.
Dojo Accordion Container builder
Use this builder to place a Dojo AccordionContainer widget on a page that you specify.
Dojo Animation builder
The Dojo Animation builder arranges for a visual animation effect to be applied to a specified element on a page when some triggering event fires.
Dojo Border Container builder
The Dojo Border Container builder adds a Dojo BorderContainer widget to a page location that you specify.
Dojo Check Box builder
The Dojo Check Box builder creates a single Dojo Dijit check box on a page.
Dojo Data Grid builder
The Dojo Data Grid and Dojo Data Store builders work together to provide the ability for a client page to directly fetch remote data and render it on a page.
Dojo Data Store builder
The Dojo Data Grid and Dojo Data Store builders work together to provide the ability for a client page to directly fetch remote data and render it on a page.
Dojo Date/Time Picker builder
This builder adds a Dojo date or time picker to an existing text input at a specified page location.
Dojo Drag Source builder
Use the Dojo Drag Source builder with the Dojo Drop Target builder to provide drag and drop features on a page.
Dojo Drop Down Button builder
This builder adds to a page in your model a button that displays a drop-down menu when the user clicks the button.
Dojo Drop Target builder
Use the Dojo Drop Target builder with the Dojo Drag Source builder to provide drag and drop features on a page.
Dojo Enable builder
The Dojo Enable builder allows you to add Dojo capabilities to a page in your model.
Dojo Enhanced Table Modifier builder
The Dojo Enhanced Table Modifier builder lets your HTML table be modified at runtime.
Dojo Form Dialog builder
The Dojo Form Dialog builder lets you display a model page from within a popup dialog style window.
Dojo Hover Tab Container builder
The Dojo Hover Tab Container builder adds a dojox.layout.RadioGroup widget to a page element that you specify.
Dojo Inline Edit builder
The Dojo Inline Edit builder allows you to add editing capabilities to a Data Page field so that it initially appears as read-only text.
Dojo Lightbox builder
The Dojo Lightbox builder adds a Dojo Lightbox widget to a specified page element.
Dojo Page Element builder
Use this builder to apply a Dojo widget to an existing input field.
Dojo Progress Indicator builder
The Dojo Progress Indicator builder arranges for an image to be displayed during either an Ajax or a partial-page refresh operation.
Dojo Radio Button Group builder
This builder creates a set of radio buttons in a Dojo Radio Button Group at a named tag or other location on a page or pages.
Dojo Rich Text Editor builder
The Dojo Rich Text Editor builder adds a Dojo dijit.Editor
control to a specified location on an HTML page.
Dojo Select builder
This builder creates a Dojo Select input at a named tag or other location on a page or pages.
Dojo Slider builder
Use the Dojo Slider builder to add either a dijit.form.HorizontalSlider or a dijit.form.VerticalSlider widget to a page location that you specify.
Dojo Tab Container builder
The Dojo Tab Container builder adds a Dojo TabContainer widget to a page element that you specify.
Dojo Title Pane builder
The Dojo Title Pane builder makes the specified section of a page collapsible and adds an associated title pane above the specified area to describe the collapsible section.
Dojo Tooltip builder
The Dojo Tooltip Builder allows the application to display a popup text box when the user's pointing device hovers over a specified target on a page.
Dojo Tree builder
Use this builder to add a tree control to a specified page location in your model and display elements described in XML data.
Domino Attachment builder
Use the Domino Attachment builder to give a user the ability to launch or view file attachments for a Domino document.
Domino Data Access builder
Use the Domino Data Access builder to connect to and access information stored on a Lotus Domino server.
Domino Formula builder
Use the Domino Formula builder to display Domino information on a page, but that information is not readily available in a view or as a field in a document.
Domino Keyword Lookup builder
Use the Domino Keyword Lookup builder to display or handle Domino data that is structured as value and label pairs.
Dynamic Table builder
The Dynamic Table builder adds a table to a named tag or other location on a page or pages.
Dynamic Table Column builder
Use the Dynamic Table Column builder to modify the look and content of an existing column in a table.
Dynamic Validation builder
The Dynamic Validation builder implements checking of fields on a form as the user enters data in the form.
EJB Call builder
Use the EJB Call builder to create a link to an Enterprise Java Bean (EJB).
Error Handler builder
Use the Error Handler builder to catch errors that occur in a model.
Event Declaration builder
The Event Declaration builder adds a <declaration />
element to the _EventDeclarations
variable and adds a fireEventName
method to the WebApp.
Event Handler builder
The Event Handler builder lets you specify an action to perform when a specified event occurs.
Field Mapper builder
The Field Mapper builder maps page automation fields to elements on a page that you specify.
File Dependency builder
The File Dependency builder is useful when you export a collection of project files to share with another developer in the form of an archive file.
File Upload builder
The File Upload builder allows users to copy files from their client computer to a specific directory on the machine hosting the IBM WebSphere Portlet Factory servlet.
The Flash builder arranges for an Adobe® Flash SWF file to be displayed at the specified page location.
Formatted Text builder
Use the Formatted Text builder to format values for data that is not used by page automation but is to be displayed on a page.
Form Layout builder
Use this builder to create a newspaper-style column display of the fields generated by Page Automation builders, such as the Data Page builder.
Form Submit Action builder
The Form Submit Action builder sets a form action attribute to the model action you specify as the Action
The Geolocation builder can fetch the geographic location information from a supported device.
Hidden Input builder
Use the Hidden Input builder to pass in form data that the user does not specify.
Use the Highlighter builder to highlight a row in a table (or a field in a form) as the user's mouse moves over it.
Use the HTML builder to incorporate an entire block of HTML into a model.
HTML Data Layout builder
Use this builder to modify the layout of items that are created by the Data Page builder, for example, pages, tables, groups, and fields.
HTML Event Action builder
Use the HTML event action builder to associate a function with an HTML behavioral attribute.
Use the Image builder to insert an image in an HTML page.
Image Button builder
Use an Image Button builder to create a more visually appealing application.
Imported Directory builder
Use the Imported Directory builder to place in a model a set of local HTML content.
Imported Model builder
Use the Imported Model builder to import into one model the complete builder call set of a second model.
Imported Page builder
The Imported Page builder adds an existing HTML or JSP page to the current model.
Import to XML builder
The Import to XML builder adds to the model a variable that contains the contents of a Java properties file or of an XML file.
Input Form builder
The Input Form builder creates an input page for a data service operation or a method and is suitable for operations that do not have result data to display.
Inserted Page builder
Use the Inserted Page builder to insert the contents of an imported page into a named location in the specified pages.
Java/XML Converter builder
Use the Java/XML converter to transform the public fields of one or more Java objects into an XML variable.
JMS Message builder
The JMS Message builder allows you to create and send messages to the Java Message Service (JMS) topic or queue specified by a JMS Session builder call.
JMS Session builder
The JMS Session builder and the JMS Message builder enable IBM WebSphere Portlet Factory to act as a Java Message Service (JMS) client with which you can establish a logical connection to a JMS provider.
JSP Directive builder
Use the JSP Directive builder to insert a Java Server Page directive in the top of a page.
JSP Tag builder
Use the JSP Tag builder to automate the process of using Java Server Page tags from a existing tag library you want to leverage in an application.
Lazy Load builder
The Lazy Load builder arranges for the contents of a given page location to be loaded when the area in which the location resides becomes visible.
The Link builder adds an HTML link element to one or more pages in your model.
Linked Java Object builder
The Linked Java Object builder adds the public methods of a Java class to the web application.
Linked Model builder
Use the Linked Model builder to create and include modular functional units in an application.
Use the List builder to create a composite control that allows a user to build a list from a set of available items.
Localized Resource builder
The Localized Resource builder imports the contents of a resource bundle into a variable in the model.
Lookup Table builder
Use the Lookup Table builder to perform a database query that returns results you can include in a page control, for example, a select control or a radio button group.
Lotus Forms Embed builder
The Lotus Forms Embed builder lets you embed a Lotus Form in a IBM WebSphere Portlet Factory page and control some aspects of how that form looks.
Lotus Forms Launch builder
The Lotus Forms Launch builder adds a control (button or link) to a page in your model to open a Lotus Form.
Lotus Web Content Management Access builder
The Lotus Web Content Management Access builder retrieves content and components from IBM Lotus Web Content Management and processes the retrieved items.
Lotus Web Content Management Authoring builder
This builder creates and modifies content from an IBM Lotus Web Content Management repository.
The Method builder adds a Java method to the WebApp.
Method Call builder
The Method Call builder allows you to construct a call to a method and to define inputs to the method, if any inputs exist.
Model Action Access builder
Use the Model Action Access builder to manually add action names to the list of public actions in a model.
Model Container builder
Use the Model Container builder to reserve a place on a page at which a model is to be placed.
Use the Page builder to create a page that contains HTML or JSP code.
Page Automation Labels builder
Use this builder to define labels for any or all of the page automation elements in a model.
Page Loading Indicator builder
This builder arranges for a wait page to be displayed while a lengthy action runs.
Page Navigation builder
The Page Navigation builder renders a navigation structure at a specified page location in a model.
Page Tabs builder
Use the Page Tabs builder to automate the addition of tabbed navigation with content area to the existing pages in a model.
Paging Assistant builder
The Paging Assistant builder provides the ability to navigate through a data set.
Paging Buttons builder
The Paging Buttons builder adds a set of buttons to a page in the model for navigating through a data set specified in a Paging Assistant builder call.
Paging Links builder
The Paging Links builder adds a set of links to a page in the model for navigating through a data set specified in a Paging Assistant builder call.
People Awareness builder
Use the People Awareness builder to add a presence function or Sametime® chat capabilities into your portlet.
PeopleSoft Component Interface builder
Use the PeopleSoft Component Interface builder to access a PeopleSoft backend system.
Person Menu Extension builder
The Person Menu Extension builder adds an extension to the Person Menu.
Portal Document Manager Access builder
Use the Portal Document Manager Access builder to quickly create web applications that operate on data in IBM WebSphere Portal Document Manager.
Portlet Adapter builder
The Portlet Adapter builder allows you to enable a model to be used as a portlet, to set a portlet title and description, and to expose profile values for customization when the model is used as a portlet.
Portlet Customizer builder
Use the Portlet Customizer builder to create a configure or edit model for an existing portlet.
Print Page Contents builder
Use the Print Page Contents builder to specify an area of a page that you want to print when a button or link is clicked.
Profiled Service Call builder
Use the Profiled Service Call builder to create a service call in which the service URL can be run based on a profile.
Radio Button builder
The Radio Button builder allows you to reuse an existing group of radio buttons on an imported page or to control the layout of a group of radio buttons.
Radio Button Group builder
Use the Radio Button Group builder to create a set of radio buttons on a page.
Repeated Region builder
Use the Repeated Region builder to repeat part of an HTML page.
REST Service Call builder
Use the REST Service Call builder in models in which you want to call a Representational State Transfer (REST) style service.
REST Service Enable builder
This builder makes all the operations from a data service available as REST service calls.
Rich Data Definition builder
The Rich Data Definition builder associates rich user interface (UI) descriptions with fields that are defined in a schema.
SAP Batch Input builder
Use the SAP Batch Input builder to execute an exported SAP batch input.
SAP BW Column Headers builder
Use the SAP BW Column Headers builder to set the column headings on a table when using a Dynamic Table builder to display the results of a SAP Business Warehouse Data query.
SAP BW Data Access builder
Use the SAP BW Data Access builder to access to a SAP Business Warehouse using the XMLA protocol. Use this builder when you want to get access to a data store.
SAP Function Call builder
Use the SAP Function Call builder to access functions in SAP.
SAP Help Values builder
The SAP Help Values builder provides access to the help values associated with the fields present in an SAP function.
SAP Properties builder
Use the SAP Properties builder to set SAP connection properties.
SAP Transaction builder
This builder allows you to call multiple SAP functions within the context of a single SAP connection or transaction.
The Schema builder adds a property that contains a schema path to the model.
The Select builder adds a <input type=select/>
tag to one or more pages in the model.
Service Consumer builder
The Service Consumer builder works with the Service Definition and Service Operation builders and is used to provide access to a public service created by those builders in a service provider model.
Service Definition builder
Use the Service Definition builder and the Service Operation builder to create a IBM WebSphere Portlet Factory data service.
Service Documentation builder
The Service Documentation builder generates a report on services published or used by a specified model or models.
Service Operation builder
The Service Operation builder adds an operation to a service created with the Service Definition builder.
Service Stub builder
The Service Stub builder creates a separate, self-contained model that implements a version of a selected service.
Service Test builder
The Service Test builder generates the code necessary to execute and display the results of a service.
Shared Variable builder
Use this builder to share data between model or application instances, or between IBM WebSphere Portlet Factory and non- WebSphere Portlet Factory code.
Siebel Business Component builder
Use the Siebel Business Component builder to add a SiebelDataHelper
linked Java object (LJO) to your model that can access a Siebel backend system and call a Siebel Business Component.
Simple Schema Generator builder
Use the Simple Schema Generator builder to add a schema to the model based on an XML structure.
Use the Sort builder to add the ability for the user to sort the columns displayed on a page in the model.
Split Pager builder
The Split Pager builder surrounds a data display area with links to enable paged navigation.
Spreadsheet Export builder
This builder lets you export table-like XML data as a spreadsheet file.
Spreadsheet Import builder
With the Spreadsheet Import builder, you can import into a model the content of a spreadsheet.
SQL Call builder
Use the SQL Call builder to access a relational database using SQL statements and stored procedures.
SQL Data Services builder
This builder automatically generates basic search, create, retrieve, update, and delete operations for a relational database.
SQL DataSource builder
The SQL DataSource builder allows your model (and the other SQL builders) to obtain database connections from a local or remote JNDI-based DataSource.
SQL Statement builder
Use the SQL Statement builder to create Prepared or Callable SQL statements that are ready for execution.
SQL Table Create builder
This builder lets you create a database table, either from IBM WebSphere Portlet Factory Designer or at runtime during the regeneration phase on the server.
SQL Transaction builder
Use the SQL Transaction builder to define a sequence of SQL DataSources, Statements, and Transforms that are to be executed as part of a transaction.
SQL Transform to XML builder
Use the SQL Transform to XML builder to convert the result set of an executed SQL query into XML.
SQL Transform to XML Schema builder
Use the SQL Transform to XML Schema builder to generate an XML schema that describes the XML data that is generated by an SQL Transform to XML builder.
Style Sheet builder
Use the Style Sheet builder to apply Cascading Style Sheets (CSS) to a specified page in a model.
Style Setter builder
The Style Setter builder adds classes or styles to any named element on a specified page.
Submit Form Event builder
The Submit Form Event builder adds a form submitted event declaration to the web application.
Use the Tab builder to place a set of tabs on a page and perform special processing.
Use the Text builder to create a span of HTML text to display to a user.
Text Area builder
The Text Area builder adds a text area to one or more pages in the model.
Text Input builder
The Text Input builder adds an input element of type text to one or more pages in the model.
The Theme builder changes the theme and therefore the HTML base pages, HTML templates, and styles just within a model.
Timed Action builder
The Timed Action builder is used to start a timer when the page loads.
Transform Aggregate builder
The Transform Aggregate builder provides data aggregation capabilities through a set of functions similar to some of the SQL aggregate functions.
Transform Combine builder
This builder combines elements from two or more schema-typed XML data sources.
Transform Filter builder
The Transform Filter builder takes an XML source structure, performs a comparison algorithm on the source elements in the structure, and produces a transformed XML output file.
Transform Group builder
This builder groups elements in schema-typed XML data.
Transform Map builder
This builder maps elements between schemas in schema-type XML data.
Transform Merge builder
The Transform Merge builder uses standard ANSI SQL join operations to merge elements in schema-typed XML data.
Transform Modify builder
This builder modifies elements in schema-typed XML data.
Transform Sort builder
Use this builder to sort elements in a schema typed XML variable.
Unique Client-side ID builder
The Unique Client-side ID builder creates a method to compute a unique ID value, and attaches to the id
attribute of a specified element a call to this method.
Use a Variable builder call to store temporary or persistent data in a model.
Variable Input Control builder
Use the Variable Input Control builder to create variable forms where the text, layout, and styles of the controls are stored in a database or in files.
View and Form builder
The View and Form builder provides support to call a method and display its results on a page.
Visibility Setter builder
Use the Visibility Setter builder to control what is displayed in an application.
Visibility Setter builder, Client-side
The Client-side Visibility Setter builder provides you with the capability to manage the visibility of page automation elements in your model.
Web Service Call builder
This builder can be used to call a web service defined with WSDL (Web Services Definition Language), using either Axis 1 or the Java API for XML Web Services implementation (JAX-WS) if your deployment platform supports JAX-WS.
Web Service Multiple Operations builder
Use the Web Service Multiple Operations builder to add to your model all the operations defined in a WSDL service.
Web Service Properties builder
Use the Web Service Properties builder to specify a description for the services that your model provides.
WebSphere Portal Analytics builder
Use this builder to annotate your page with the asa.portlet.screen.title
, the localized title of the screen or view that is displayed in a portlet and asa.portlet.screen.id
, the unique identifier of the screen or view that is displayed in portlet microformat tags defined by WebSphere Portal Active Site Analytics (ASA).
WebSphere Portal Credential builder
Use the WebSphere Portal Credential builder to access credentials (for example, user names and passwords) stored in the IBM WebSphere Portal server credential vault.
WebSphere Portal Link builder
Use the WebSphere Portal Link builder to create links on a portlet page that point to other portlet pages in the application.
Widget Adapter builder
The Widget Adapter builder allows you to set a widget title and description, and to expose profile values for customization when the model is used as a widget.
Widget Customizer builder
Use the Widget Customizer builder to create a configure model for an existing widget.
Widget Event builder
The Widget Event builder adds a form submitted event declaration to the widget.
XML to JSON Converter builder