Novell Doc: Identity Manager Accessory Portlet Reference Guide

13.2 Portlet preferences

HTML-portlet-specific preferences can be set to personalize many options. For details on each preference, click Show Descriptions in the Portlet Preferences Editor. Furthermore, you may use the wizard to record the URL and URL parameter settings and divide up the page (see Section 13.3.1, Using the Wizard). In order for the wizard's settings to take effect, the URL Configuration preference must be set to Wizard-generated configuration.

For each HTML portlet preference, specify a value and settings.

Preference settings	Description
Hide	When Hide is checked, this preference is not visible at runtime.
Required	When Required is checked, this preference must be set at runtime.
Read Only	When Read Only is checked, this preference cannot be changed at runtime.

You can set values for the following HTML portlet content preferences:

Preference	Value to specify
URL Configuration	Specifies whether you define the URL, parameters, and post values using Wizard or Manual preferences.
Wizard	Choose View or Edit Custom Preferences. Use the wizard to record the URL and URL parameters, then divide the target Web page into content areas. You can select any of these areas individually for display in the HTML portlet window. This option is required for using Wizard-generated configuration.
Fully qualified Web URL	URL of the HTML portlet to display. It must include the URL scheme (protocol) such as HTTP or HTTPS. Required for manual configuration. To use $PORTLET_AUTH_ID$ or $PORTLET_AUTH_PWD$ substitution strings, change the URL here. To change the URL and rerun the wizard, click the Restart icon.
Parameters to pass to URL	Specifies and passes URL Parameters in the format of NAME=VALUE. Portlet authentication credentials can be passed with the following substitution strings: $PORTLET_AUTH_ID$and $PORTLET_AUTH_PWD$. The values in Username and Password preferences are used. This parameter is used with manual configuration.
Encode URL parameters	Specifies whether to encode the URL parameters using UTF-8 (if applicable).
Do a post to URL	Specifies whether the portlet should do a post or get to the URL. Applies for Manual configuration
Parse Data and Change Links	Specifies whether the portlet should parse the HTML content. When True, the portlet reconciles relative links in the HTML content and lets you specify any valid value for the Link Destination preference. When False, the portlet displays the HTML content as is and requires that you set Link Destination to Leave to leave the links unchanged. To optimize the server, you can set this parameter to False and then see if you can view the page through the portlet.
Link Destination	Specifies where links will be shown when clicked. You must select Leave to leave the links unchanged when Parse Data and Change Links = false.
URL host to use when parsing relative paths	Specifies the URL host to use when parsing relative paths such as www.wtcrelief.info.
URL protocol to use when parsing relative paths	Specifies the URL scheme (protocol) to use, such as HTTP or HTTPS, when parsing relative paths.
URL relative path to use when parsing relative paths.	Specifies the URL relative path to use when parsing relative paths. It must begin and end with a slash (/), for example /Charities/Information/pages/
Forward cookies back to separate browser window	Specifies whether to forward cookies when Link Destination = Separate Window. When True, link content is displayed within a maximized HTML portlet in a separate browser window. When False, link content is displayed directly in a separate browser window. Cookies are always forwarded when Link Destination = Within the Portlet or Within the Portlet Maximized.
Character encoding	Specifies the character encoding for this URL. Use this setting if the characters are not appearing correctly.
Use basic authentication	Select True when the URL forwards basic authentication parameters. When True, you must also specify the Username for basic authentication and Password for basic authentication preferences.
Username	Specifies the user name that the portlet passes when the target URL requires basic authentication or when using substitution authentication strings. Portal macros may be used, for example: ${User/id} to pass portal ID or if SSO is enabled in the login portlet ${Application/login-user}. Required when Use basic authentication = True.
Password	Specifies the password that the portlet passes when the target URL requires basic authentication or when using substitution authentication strings. Portal macros may be used, for example: if SSO is enabled in the login portlet ${Application/login-pass}. Required when Use basic authentication = True.
Search and replace strings in URL content	Enter the search criteria followed by the replacement string separated by ~. You can use regular expressions for the search criteria. For example, nove?l+.com~something else.
Display HTML only within BODY tags	Specify True to maintain compliance with the Java Portlet 1.0 Specification, but this means that you lose all scripting and styling done within the HEAD tags. The Parse Data and Change Links preference must be true if you want to set this preference to True.
Cache URL for quicker display	Specifies whether the portlet should cache the HTML content for faster display. Set to False when Wizard-generated Configuration is selected and you have divided the portlet to display only sections of interest.
Frequency to refresh cache (minutes)	Specifies the amount of time, in minutes, before the HTML cached data expires. Required when Cache URL for quicker display = true.
Do a post for any form submission	Specify True if the HTML form uses the post method. Specify True if the HTML form uses the get method.