Inserting Click-to-Action encodeProperty

Rational® tools enable you to add a Click-to-Action menu to a JSP file to publish an output property.

This capability is not supported for JSR 168 API portlets.

The WebSphere® Portal cooperative runtime environment supports multiple ways to trigger the publishing of an output property. It can be implicit, by programmatically providing the output property to the declared location while processing a portlet action, using wires, for example. Or it can be explicit, using a pop-up menu from a portlet JSP page. This second approach, Click-to-Action, is a feature specific to the IBM® portlet API. To enable this feature, the <encodeProperty> tag is inserted to the JSP page.

To insert a Click-to-Action Output Property (encodeProperty), perform the following steps:

  1. Open a JSP file in the Design page in the Page Designer.
  2. Select the Portlet drawer in the Palette view.
  3. Drag and drop the Click-to-Action Output Property (encodeProperty) icon Click-to-Action Output Property object from the Palette view onto the page. Alternatively select Insert > Portlet > Click-to-Action Output Property (encodeProperty) icon Click-to-Action Output Property from the menu. The Insert Click-to-Action Output Property dialog opens.
  4. Provide values for the applicable fields. To configure the portlet, specify the output property data type by providing the Data type and Namespace field values. The Namespace value is used in conjunction with the Data type value to uniquely identify the output property's data type. Because a JSP page can be used by any portlet within the same project, you must also specify the Source portlet that the current JSP page belongs to.
    Note: Although the WebSphere Portal cooperative runtime environment supports complex data types, Rational tools only support simple string types for the output property. Therefore, only the name of the data type is required, because the schema of the data type is simply a string.
  5. Click OK. The inserted output property is displayed in the JSP page in the Design page as an output property icon (Click-to-Action Output Property (encodeProperty) icon).
  6. Refer to Editing Click-to-Action encodeProperty for a description of how to update attributes of the inserted Output Property (encodeProperty). You must specify the Value property, at a minimum.

Inserting the Click-to-Action Output Property (encodeProperty) icon Click-to-Action Output Property object performs the following tasks:

  1. Enabling cooperative sources if necessary.
  2. Inserts a <c2a:encodeProperty> tag and the taglib directive in the JSP file. The <c2a:encodeProperty> tag contains the specified type and the namespace property values. In addition to this, you must specify the Value property. You can also specify any other applicable properties. For details about updating these properties, refer to Editing Click-to-Action encodeProperty.
    • Value: Required.
    • Broadcast: Optional. The default setting is false.
    • Generate markup: Optional. The default is false.
Related concepts
Developing cooperative portlets
Related tasks
Enabling existing portlets for cooperation
Enabling cooperative sources
Enabling cooperative targets
Inserting Click-to-Action encodeProperties
Editing Click-to-Action encodeProperty
Editing Click-to-Action encodeProperties
Related reference
Web Services Description Language (WSDL) 1.1
WebSphere Portal Information Center
Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.