Portlet Adapter builder inputs - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Portlet Adapter builder inputs

This topic describes the inputs for the Portlet Adapter builder.

General inputs
Profile sets
Composite Application Parameters
Edit and Configure Settings
Public Render Parameters
Rich Client Platform
Advanced

General inputs

Table 1. General inputs
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 identifies 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 Short Title Enter a name to be used as the short title when the model is added as a portlet.
Portlet Keywords Enter keywords, separated by commas (,), that are associated with this portlet.
Portlet Description Enter a short description for the portlet. This description is used to describe the portlet when it is added to a page in a portal.
Default Locale Enter the Default Locale (for example, en_US) for this portlet. Defaults to en if not set. For Java™ Portlet Standard 1.0 (JSR 168) portlets, used to set the initial supported-localeportlet.xml element. Also used as the suffix on the resource bundle generated for JSR 168 portlets (for example, WEB-INF/classes/nls/myportlet_en.properties).
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.

Note: If you change the Portlet Title, Portlet Description, or Portlet Keywords inputs and rebuild, you do not see the changes reflected in the deployed portlet. You can see the changes in the portlet.xml file, but not in the IBM® WebSphere Portal server. Even if you manually update the portlet WAR, the server does not pickup any of these portlet changes. To make the changes, change the Name input of the Portlet Adapter builder. Changing the name removes the old portlet and adds the new portlet during the rebuilding of the portlet WAR. If you do not change the name and want to change the Portlet Title, Portlet Description, or Portlet Keywords inputs, remove and reinstall the portlet WAR.

Profile sets

These inputs are available for each profile set that is used in the model.

Table 2. Profile sets inputs
Input Name Description
profile_set_name For each profile set, you can determine how the profile set and profile entries get exposed in Edit and Edit Defaults modes, Configure mode, and Edit Defaults mode 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 the following options.

Do not expose in Portal tools

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

Show individual profile values in Edit and Edit Defaults

Allows the user to specify values for each entry in the profile set when in the Edit mode (Personalize) or Edit Defaults mode (Shared Settings) 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, and background color.

Show profile names in Edit and Edit Defaults

Allows the user to specify values for each entry in the profile set when in the Edit Defaults mode (Shared Settings) 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, and background color.

Show individual profile values in Configure

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.

Note: Some portal servers do not support the configure mode for JSR 168 portlets. For this reason, do not select Show individual profile values in Configure or Show profile names in Configure when creating JSR 168 portlets intended to run on Oracle Portal Servers. Portlet deployment fails under these conditions.

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.
Note: Some portal servers do not support the configure mode for JSR 168 portlets. For this reason, do not select Show individual profile values in Configure or Show profile names in Configure when creating JSR 168 portlets intended to run on Oracle Portal Servers. Portlet deployment fails under these conditions.

Show individual profile values in Edit Defaults

Allows the user to specify values for each entry in the profile set when in the Edit Defaults mode (Shared Settings) for the portlet. Use this setting to allow the user to set portlet parameters at execution time.

Show profile names in Edit Defaults

Allows the user to specify values for each entry in the profile set when in the Edit Defaults mode (Shared Settings) for the portlet. Use this setting to allow the user to set portlet parameters at execution time.

Composite Application Parameters

This input group is available if the option Build a Rich Client Platform Web Application Bundle for this project is set in the project Rich Client Platform properties.

Table 3. Composite Application Parameters inputs
Input Name Description
profile_set_name For each profile set that is used in the model, you can specify whether it is exposed as an IBM WebSphere Portal Points of Visibility setting. The default is to not be exposed.

Edit and Configure Settings

Table 4. Edit and Configure Settings inputs
Input Name Description
Custom Edit Type Overrides the look and feel of the portlet edit mode; select one of the following options.

None

Use the edit page of this portlet.

Imported Page

Adds content to the default edit page with a base HTML page.

Custom Model

Lets you have control over the user interface (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 Custom Edit Model input.
Portlet Edit Page to Import Enter the path or 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 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 (for example, cellpadding and border) can be altered, but the name of the elements (for example, entry_prompt and entry_value) cannot.
This input is available if the Custom Edit Type input is set to Imported Page.
Custom Edit Model Enter the path and name of the model that implements the portlet 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.
Use the Portlet Customizer builder to create a configure and edit page model for your portlet.
This input is available if the Custom Edit Type input is set to Custom Model.
Custom Edit Defaults Type Overrides the look and feel of the portlet edit mode; select one of the following options:

None

Do not override the look and feel.

Imported Page

Adds content to the default edit page with a base HTML page.

Custom Model

Lets you have control over the user interface (UI) elements used to set values or some other functionality not provided by simply creating a different HTML page.

Depending on the option you select, the builder call editor displays either the Portlet Edit Default Page to Import or Custom Edit Defaults Model input.
Portlet Edit Defaults Page to Import Path or URL of the HTML page to use.
This input is available if the Custom Edit Defaults Type input is set to Imported Page.
Custom Edit Defaults Model Name of the model that is the custom edit page.
This input is available if the Custom Edit Defaults Type input is set to Custom Model.
Custom Configure Type Overrides the look and feel of the portlet configure mode; select one of the following options.

None

Do not override the look and feel.

Imported Page

Adds content to the default configure page with a base HTML page.

Custom Model

Lets you have 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 Custom Configure Model input.
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 (for example, cellpadding and border) can be altered, but the name of the elements (for example, entry_prompt and entry_value) cannot.
This input is available if the Custom Configure Type input is set to Imported Page.
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.
Portlet Customizer builder to create a configure and edit page model for your portlet.
This input is available if the Custom Configure Type input is set to Custom Model.
Requires Configuration Enable this checkbox if the user must configure the model before using it in a portal.

Public Render Parameters

This input group is available in the builder call editor if the project deployment configuration supports Java Standard 2.0 (JSR 286) as the portlet API.

Table 5. Public Render Parameters input
Input Name Description
Public Render Parameters Adds to the portlet deployment descriptor (portlet.xml) a public render parameter element. This element allows you to publish your support for retrieving or setting a named public render parameter. This parameter can be sent to and received from other portlets if they declare the same support for that same named public render parameter. Following arguments.

Parameter name

The identifier argument in the XML element. This is the name that your portlet uses when it sets the parameter on the action response or retrieves the parameter from a render request.

Qualified name

The qname argument in the XML element.

Namespace

The URL for the namespace on the xmlns:qns part of the XML element.

The following code shows an example of the XML structure that Java Portlet Standard 2.0 expects in the portlet deployment descriptor.
<public-render-parameter> <identifier>searchQuery</identifier> <qname xmlns:qns="http://www.ibm.com/lotus/search">qns:query</qname> </public-render-parameter>
The arguments in the XML structure relate to the Public Render Parameters builder input arguments as follows.

Parameter name

Used as the identifier (searchQuery) in the portlet deployment descriptor, and used by code to set a render parameter or get the value as a render request parameter.

Qualified name

Used as the qname element (query) in the portlet deployment descriptor. The name is the qualified name that the portal server uses when it determines whether two portlets are specifying the same public render parameter for sharing purposes.

Namespace

Used to qualify the qname element in the portlet deployment descriptor, for this render parameter. This value (http://www.ibm.com/lotus/search in the example) helps make the qualified name of this render parameter unique to that namespace when it is used by the portal in comparisons with other public render parameters of other portlet applications. For example, two render parameters with the qualified name query are equivalent for parameter sharing between portlet applications only if the namespace associated with that qualified name matches across both deployment descriptors.

Rich Client Platform

This input group is available in the builder call editor only if the project is configured to build a Rich Client Platform Web Application Bundle (WAB).

Table 6. Rich Client Platform inputs
Input Name Description
Launch Menu Select whether the item is to be added to the Launch Menu.

None

Do not add a launch menu item for this individual portlet to the rich client platform Open/Launch menu. This is the default.
If you are building a composite application on WebSphere Portal, using this portlet, that is to be provisioned as an application down to IBM Lotus® Expeditor or IBM Lotus Notes® 8, the application would have its own launch menu item, and this individual portlet should not have its own menu item.

Add portlet to launch menu

If you are testing an individual portlet standalone in IBM Lotus Expeditor, you may want a launch menu item, so that you can launch this portlet on its own on that platform.

Title Bar Select whether to show the title bar.

Show the portlet title bar in rich client composite applications

If this portlet is used in a on a platform, such as IBM Lotus Expeditor or Lotus Notes 8, and you want a portal look and feel or you want to be able to get to the minimize, maximize or help links from the portlet title bar, you typically want to show the title bar in the rich client platform.

Do not show the portlet title bar in rich client composite applications

Select not to show the title bar in the rich client platforms if you want your portlet to have more of a Lotus Notes component look and feel when used in a composite application in Lotus Notes 8.

View Type Select the web application run-time appearance, either to run locally or replace with an SWT view.

Run locally as a portlet on the rich client platform

For most IBM WebSphere Portlet Factory portlets, you will likely choose to run them locally on the rich client platform, if you are building an application for that platform.

Replace with an SWT view on rich client platform

Select the option if you have a SWT View that you want to run in place of this portlet in Lotus Notes. There may be some portlets where you have a more rich component built with Eclipse SWT Java APIs that you wish to run in place of a portlet, when a composite application is provisioned from WebSphere Portal down to the rich client. (For instance, if you had a Lotus Notes view which had more features than were available in your Domino® IBM WebSphere Portlet Factory portlet).

Eclipse SWT view id Enter the desired Eclipse SWT view identification.This input is used if you select, in the View Type input, to replace this portlet with an SWT view on the rich client platform. The input specifies the Eclipse SWT view id. For example:
com.mycompany.myproject.myEclipseSWTView
Otherwise, leave this input blank.
Feature ID Override Enter the desired alternate feature identification.
By default, the Feature ID specified in this project Rich Client Platform properties dialog is added to the portlet preferences in the portlet.xml deployment descriptor. Therefore, rich client platform provisioning knows what Eclipse feature contains this portlet when provisioning a composite application from WebSphere Portal to a rich client platform. If you have an alternate Eclipse feature for this individual portlet (which is typical if you specify an Eclipse SWT view id input), you can specify that alternate feature id here. Otherwise, leave this field blank.
Feature Version Override Enter the desired alternate feature version.
By default, the feature version specified in the project Rich Client Platform properties dialog is added to this portlet preferences in the portlet.xml deployment descriptor. Therefore, rich client platform provisioning knows what Eclipse feature contains this portlet when provisioning a composite application from WebSphere Portal to a rich client platform. If you have an alternate Eclipse feature for this individual portlet (which is typical if you specify an Eclipse SWT view id), you can specify that alternate feature version here. Otherwise, leave this field blank.
Optional Update Site URL Enter the desired URL.
This optional input can be used if you need to explicitly specify where the update site for the feature containing this portlet or the alternate SWT view can be downloaded from to a rich client platform. If a value is entered here, it is included with this portlet preferences in portlet.xml and the plugin.xml for the rich client web application bundle, and used by the rich client platform when provisioning an application with this portlet or alternate SWT view. Most of the time, you do not want to associate a portlet WAR and its related web application bundle (WAB) to a single update site, because you want to be able to use the same portlet WAR and WAB for development, testing, staging and deployment server environments. You typically leave this input blank.

Advanced

Table 7. Advanced inputs
Input Name Description
Preferences Specify additional optional Java Standard Portlet preferences.
Initialization Parameters Specify optional Java Standard Portlet initialization parameters.

Parent topic: Portlet Adapter 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.
Portlet Title	Enter a name that identifies 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 Short Title	Enter a name to be used as the short title when the model is added as a portlet.
Portlet Keywords	Enter keywords, separated by commas (,), that are associated with this portlet.
Portlet Description	Enter a short description for the portlet. This description is used to describe the portlet when it is added to a page in a portal.
Default Locale	Enter the Default Locale (for example, en_US) for this portlet. Defaults to en if not set. For Java™ Portlet Standard 1.0 (JSR 168) portlets, used to set the initial supported-localeportlet.xml element. Also used as the suffix on the resource bundle generated for JSR 168 portlets (for example, WEB-INF/classes/nls/myportlet_en.properties).
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.

Input Name	Description
Custom Edit Type	Overrides the look and feel of the portlet edit mode; select one of the following options. None Use the edit page of this portlet. Imported Page Adds content to the default edit page with a base HTML page. Custom Model Lets you have control over the user interface (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 Custom Edit Model input.
Portlet Edit Page to Import	Enter the path or 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 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 (for example, cellpadding and border) can be altered, but the name of the elements (for example, entry_prompt and entry_value) cannot. This input is available if the Custom Edit Type input is set to Imported Page.
Custom Edit Model	Enter the path and name of the model that implements the portlet 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. Use the Portlet Customizer builder to create a configure and edit page model for your portlet. This input is available if the Custom Edit Type input is set to Custom Model.
Custom Edit Defaults Type	Overrides the look and feel of the portlet edit mode; select one of the following options: None Do not override the look and feel. Imported Page Adds content to the default edit page with a base HTML page. Custom Model Lets you have control over the user interface (UI) elements used to set values or some other functionality not provided by simply creating a different HTML page. Depending on the option you select, the builder call editor displays either the Portlet Edit Default Page to Import or Custom Edit Defaults Model input.
Portlet Edit Defaults Page to Import	Path or URL of the HTML page to use. This input is available if the Custom Edit Defaults Type input is set to Imported Page.
Custom Edit Defaults Model	Name of the model that is the custom edit page. This input is available if the Custom Edit Defaults Type input is set to Custom Model.
Custom Configure Type	Overrides the look and feel of the portlet configure mode; select one of the following options. None Do not override the look and feel. Imported Page Adds content to the default configure page with a base HTML page. Custom Model Lets you have 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 Custom Configure Model input.
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 (for example, cellpadding and border) can be altered, but the name of the elements (for example, entry_prompt and entry_value) cannot. This input is available if the Custom Configure Type input is set to Imported Page.
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. Portlet Customizer builder to create a configure and edit page model for your portlet. This input is available if the Custom Configure Type input is set to Custom Model.
Requires Configuration	Enable this checkbox if the user must configure the model before using it in a portal.

Input Name	Description
Launch Menu	Select whether the item is to be added to the Launch Menu. None Do not add a launch menu item for this individual portlet to the rich client platform Open/Launch menu. This is the default. If you are building a composite application on WebSphere Portal, using this portlet, that is to be provisioned as an application down to IBM Lotus® Expeditor or IBM Lotus Notes® 8, the application would have its own launch menu item, and this individual portlet should not have its own menu item. Add portlet to launch menu If you are testing an individual portlet standalone in IBM Lotus Expeditor, you may want a launch menu item, so that you can launch this portlet on its own on that platform.
Title Bar	Select whether to show the title bar. Show the portlet title bar in rich client composite applications If this portlet is used in a on a platform, such as IBM Lotus Expeditor or Lotus Notes 8, and you want a portal look and feel or you want to be able to get to the minimize, maximize or help links from the portlet title bar, you typically want to show the title bar in the rich client platform. Do not show the portlet title bar in rich client composite applications Select not to show the title bar in the rich client platforms if you want your portlet to have more of a Lotus Notes component look and feel when used in a composite application in Lotus Notes 8.
View Type	Select the web application run-time appearance, either to run locally or replace with an SWT view. Run locally as a portlet on the rich client platform For most IBM WebSphere Portlet Factory portlets, you will likely choose to run them locally on the rich client platform, if you are building an application for that platform. Replace with an SWT view on rich client platform Select the option if you have a SWT View that you want to run in place of this portlet in Lotus Notes. There may be some portlets where you have a more rich component built with Eclipse SWT Java APIs that you wish to run in place of a portlet, when a composite application is provisioned from WebSphere Portal down to the rich client. (For instance, if you had a Lotus Notes view which had more features than were available in your Domino® IBM WebSphere Portlet Factory portlet).
Eclipse SWT view id	Enter the desired Eclipse SWT view identification.This input is used if you select, in the View Type input, to replace this portlet with an SWT view on the rich client platform. The input specifies the Eclipse SWT view id. For example: com.mycompany.myproject.myEclipseSWTView Otherwise, leave this input blank.
Feature ID Override	Enter the desired alternate feature identification. By default, the Feature ID specified in this project Rich Client Platform properties dialog is added to the portlet preferences in the portlet.xml deployment descriptor. Therefore, rich client platform provisioning knows what Eclipse feature contains this portlet when provisioning a composite application from WebSphere Portal to a rich client platform. If you have an alternate Eclipse feature for this individual portlet (which is typical if you specify an Eclipse SWT view id input), you can specify that alternate feature id here. Otherwise, leave this field blank.
Feature Version Override	Enter the desired alternate feature version. By default, the feature version specified in the project Rich Client Platform properties dialog is added to this portlet preferences in the portlet.xml deployment descriptor. Therefore, rich client platform provisioning knows what Eclipse feature contains this portlet when provisioning a composite application from WebSphere Portal to a rich client platform. If you have an alternate Eclipse feature for this individual portlet (which is typical if you specify an Eclipse SWT view id), you can specify that alternate feature version here. Otherwise, leave this field blank.
Optional Update Site URL	Enter the desired URL. This optional input can be used if you need to explicitly specify where the update site for the feature containing this portlet or the alternate SWT view can be downloaded from to a rich client platform. If a value is entered here, it is included with this portlet preferences in portlet.xml and the plugin.xml for the rich client web application bundle, and used by the rich client platform when provisioning an application with this portlet or alternate SWT view. Most of the time, you do not want to associate a portlet WAR and its related web application bundle (WAB) to a single update site, because you want to be able to use the same portlet WAR and WAB for development, testing, staging and deployment server environments. You typically leave this input blank.

Input Name	Description
Preferences	Specify additional optional Java Standard Portlet preferences.
Initialization Parameters	Specify optional Java Standard Portlet initialization parameters.