Portlet Adapter builder - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Portlet Adapter builder

The Portlet Adapter builder allows you to expose profile values for customization when the model is used as a portlet running on a portal server. It takes the inputs described in this table.

Table 1. Portlet Adapter builder
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Portlet Title Enter a name that will identify this portlet when it gets added to a page in the portal. This name is also used when other portlets communicate directly to this portlet.
Portlet Description Enter a short description for the portlet. This description is used to describe the portlet when it is getting added to a page in a portal.
User Help File Enter the URL (absolute or relative) to an HTML file that displays help for all of the editable aspects of the portlet.
Advanced

Custom Edit Type To override the look and feel of the portlet's Edit mode, choose one of the following options:

Imported Page

To add content to the default Edit page, select this option.

Custom Model

Select this option if you want control over the UI elements used to set values or some other functionality not provided by simply creating a different HTML page.

Depending on the option you choose, the builder call editor displays either the Portlet Edit Page to Import or the Custom Edit Model input.
Custom Configure Type To override the look and feel of the portlet's Configure mode, choose one of the following options:

Imported Page

To add content to the default Configure page, select this option.

Custom Model

Select this option if you want control over the UI elements used to set values or some other functionality not provided by simply creating a different HTML page.

Depending on the option you choose, the builder call editor displays either the Portlet Configure Page to Import or the Custom Configure Model input.
Portlet Edit Page to Import Enter the URL to the HTML file that defines the look and feel for the Edit page that is displayed when the user clicks on the Edit icon in the portlet's toolbar.
Note: On this page there must be an HTML form with code that looks exactly like the following:
<form> <table cellpadding="3" cellspacing="0" border="0" align="left"> <tr name="repeat"> <td> <span name="entry_prompt" ></span> </td><td> <span name="entry_value"></span> </td> </tr> <tr> <td colspan="2"><input name="submitbutton" ></td> </tr> </table> </form>

The display elements (cellpadding, border, and so on) may be altered but the name of the elements (entry_prompt, entry_value, and so on) cannot.
Portlet Configure Page to Import Enter the URL to the HTML file that defines the look and feel for the Edit page that is displayed when the user clicks on the Edit icon in the portlet's toolbar.
Note: On this page there must be an HTML form with code that looks exactly like the following:
<form> <table cellpadding="3" cellspacing="0" border="0" align="left"> <tr name="repeat"> <td> <span name="entry_prompt" ></span> </td><td> <span name="entry_value"></span> </td> </tr> <tr> <td colspan="2"><input name="submitbutton" ></td> </tr> </table> </form>

The display elements (cellpadding, border, and so on) may be altered but the name of the elements (entry_prompt, entry_value, and so on) cannot.
Custom Edit Model Enter the path and name of the model that implements the portlet's Edit mode.
This model replaces the default edit page model. By replacing the default edit model for this portlet, this custom model is required for the presentation of and processing of values presented during the configure phase.
Note: You can use the Portlet Customizer builder to create a configure and edit page model for your portlet.
Custom Configure Model Enter the path and name of the model that implements the portlet's Configure mode.
This model replaces the default configure page model. By replacing the default configure model for this portlet, this custom model is required for the presentation of and processing of values presented during the configure phase.
Note: You can use the Portlet Customizer builder to create a configure and edit page model for your portlet.
Requires Configuration Enable this checkbox if the user must configure the model before using it in a portal.
Profile sets

Profile Sets Determines how profile sets and profile entries get exposed in the Edit and Configure modes of the portlet.
For each profile set associated with the portlet model, the builder call editor for the Portlet Adapter builder displays its name as the prompt for a selectable input with five options:

Do not expose in Portal tools

Prevents any exposure of its name or profile values in the Configure and Edit modes of the portlet. Use this setting when you want IBM® WebSphere Portlet Factory's profile selection handler to determine the profile to apply to the portlet s underlying model.

Show individual profile values in Edit

Allows the user to specify values for each entry in the profile set when in the Edit mode for the portlet. Use this setting to allow the user to set portlet parameters at execution time. For example, a stock-symbol list, zip-code for weather, background color, and so on.

Show profile names in Edit

Allows the user to specify a profile to apply to the portlet. Use this setting to allow the user to apply all the values determined by the selected profile to the portlet. For example, a profile set could contain profiles oriented towards the user's region. Using this setting on such a profile set allows the user to determine the regional profile to use, but the developer retains control over the individual values in that profile.

Show individual profile values in Configure

Allows the portal administrator to specify values for each entry in the profile set when in the Configure mode for the portlet. Use this setting to allow the portal administrator to set portlet parameters when they add the portlet to a page. These settings apply to all the users of the portal.

Show profile names in Configure

Allows the portal administrator to specify a profile to apply to the portlet. Use this setting to allow the portal administrator to apply all the values determined by the selected profile to the portlet. These settings apply to all the users of the portal.

About using the builder call editor
The builder call editor allows you to specify all the input values to a builder call.
Introduction to portlets
IBM WebSphere Portlet Factory enables you to rapidly deliver dynamic, highly customizable, and adaptive portlets.

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Portlet Title	Enter a name that will identify this portlet when it gets added to a page in the portal. This name is also used when other portlets communicate directly to this portlet.
Portlet Description	Enter a short description for the portlet. This description is used to describe the portlet when it is getting added to a page in a portal.
User Help File	Enter the URL (absolute or relative) to an HTML file that displays help for all of the editable aspects of the portlet.
Advanced
Custom Edit Type	To override the look and feel of the portlet's Edit mode, choose one of the following options: Imported Page To add content to the default Edit page, select this option. Custom Model Select this option if you want control over the UI elements used to set values or some other functionality not provided by simply creating a different HTML page. Depending on the option you choose, the builder call editor displays either the Portlet Edit Page to Import or the Custom Edit Model input.
Custom Configure Type	To override the look and feel of the portlet's Configure mode, choose one of the following options: Imported Page To add content to the default Configure page, select this option. Custom Model Select this option if you want control over the UI elements used to set values or some other functionality not provided by simply creating a different HTML page. Depending on the option you choose, the builder call editor displays either the Portlet Configure Page to Import or the Custom Configure Model input.
Portlet Edit Page to Import	Enter the URL to the HTML file that defines the look and feel for the Edit page that is displayed when the user clicks on the Edit icon in the portlet's toolbar. Note: On this page there must be an HTML form with code that looks exactly like the following: <form> <table cellpadding="3" cellspacing="0" border="0" align="left"> <tr name="repeat"> <td> <span name="entry_prompt" ></span> </td><td> <span name="entry_value"></span> </td> </tr> <tr> <td colspan="2"><input name="submitbutton" ></td> </tr> </table> </form> The display elements (cellpadding, border, and so on) may be altered but the name of the elements (entry_prompt, entry_value, and so on) cannot.
Portlet Configure Page to Import	Enter the URL to the HTML file that defines the look and feel for the Edit page that is displayed when the user clicks on the Edit icon in the portlet's toolbar. Note: On this page there must be an HTML form with code that looks exactly like the following: <form> <table cellpadding="3" cellspacing="0" border="0" align="left"> <tr name="repeat"> <td> <span name="entry_prompt" ></span> </td><td> <span name="entry_value"></span> </td> </tr> <tr> <td colspan="2"><input name="submitbutton" ></td> </tr> </table> </form> The display elements (cellpadding, border, and so on) may be altered but the name of the elements (entry_prompt, entry_value, and so on) cannot.
Custom Edit Model	Enter the path and name of the model that implements the portlet's Edit mode. This model replaces the default edit page model. By replacing the default edit model for this portlet, this custom model is required for the presentation of and processing of values presented during the configure phase. Note: You can use the Portlet Customizer builder to create a configure and edit page model for your portlet.
Custom Configure Model	Enter the path and name of the model that implements the portlet's Configure mode. This model replaces the default configure page model. By replacing the default configure model for this portlet, this custom model is required for the presentation of and processing of values presented during the configure phase. Note: You can use the Portlet Customizer builder to create a configure and edit page model for your portlet.
Requires Configuration	Enable this checkbox if the user must configure the model before using it in a portal.
Profile sets
Profile Sets	Determines how profile sets and profile entries get exposed in the Edit and Configure modes of the portlet. For each profile set associated with the portlet model, the builder call editor for the Portlet Adapter builder displays its name as the prompt for a selectable input with five options: Do not expose in Portal tools Prevents any exposure of its name or profile values in the Configure and Edit modes of the portlet. Use this setting when you want IBM® WebSphere Portlet Factory's profile selection handler to determine the profile to apply to the portlet s underlying model. Show individual profile values in Edit Allows the user to specify values for each entry in the profile set when in the Edit mode for the portlet. Use this setting to allow the user to set portlet parameters at execution time. For example, a stock-symbol list, zip-code for weather, background color, and so on. Show profile names in Edit Allows the user to specify a profile to apply to the portlet. Use this setting to allow the user to apply all the values determined by the selected profile to the portlet. For example, a profile set could contain profiles oriented towards the user's region. Using this setting on such a profile set allows the user to determine the regional profile to use, but the developer retains control over the individual values in that profile. Show individual profile values in Configure Allows the portal administrator to specify values for each entry in the profile set when in the Configure mode for the portlet. Use this setting to allow the portal administrator to set portlet parameters when they add the portlet to a page. These settings apply to all the users of the portal. Show profile names in Configure Allows the portal administrator to specify a profile to apply to the portlet. Use this setting to allow the portal administrator to apply all the values determined by the selected profile to the portlet. These settings apply to all the users of the portal.