| Attributes |
| Name | Required | Request-time | Description |
| forcedAmpForm | false | true |
Forces the form of query separators used for this URL. This overrides the natural mechanisms for determining ampersand entity or character usage based on document type and/or configuration. If the value 'true' is used, then "&" will be the separator. If 'false' is used, then "&" will be the separator.
|
| var | false | true |
The name of the variable to which the return value will be assigned. The return value is of type java.lang.String.
|
| scope | false | true |
The scope in which the variable should live. Defaults to page scope. Valid values are "REQUEST", "SESSION", or "APPLICATION".
|
| scheme | false | true |
Valid values are "http" and "https". If not specified, uses the scheme that was used to make the request.
|
| domain | false | true |
Server domain. If not specified, uses the domain that was used to make the request. If requests are made via a proxy, specify the domain of the proxy server.
|
| port | false | true |
Server port. If not specified, uses the port from the request. If requests are made via a proxy, specify the port of the proxy server for the scheme used.
|
| pathPrefix | false | true |
A prefix that will be applied to the URL template specified. The value is inserted into the {url:prefix} token in the URL template.
|
| encodeSession | false | true |
Encodes the URL to include session ID. Defaults to true.
|
| windowLabel | false | true |
The instance label of the portlet you want to generate a URL to.
|
| windowMode | false | true |
Sets a portlet window mode. Valid values include "edit", "help", "view", or a user-defined custom mode name.
|
| windowState | false | true |
Sets a portlet window state. Valid values include "minimized", "maximized", "delete", "float", "normal", or a user-defined custom state name.
|
| template | false | true |
Sets a URL template for this URL. URL templates should be specified in "beehive-url-template-config.xml" file in WEB-INF directory of the webapp. Defaults to "default".
|
| portletUri | false | true |
Used to create a "detached" Portlet. A detached portlet is not associated with a Portal and is typically used to provide shared "popup" type application components. This attribute and the windowLabel attribute are mutually exclusive.
|
| contentOnly | false | true |
Removes portlet window decorations.
|
| contentMode | false | true |
Possible values are "FULL" or "FRAGMENT".
|
| desktopStateShared | false | true |
WARNING: this attribute is DEPRECATED. This attribute is provided to support the previous behavior of StandalonePortlets which did not share state with the originating desktop. If not specified, the default value for this attribute is 'true'.
|