Renderer Administration Portlet
Portlet Title | Renderer Administration |
Portlet Name | wm_renderadmin |
Portlet File Name | wm_renderadmin.pdp |
Top-level Folder | development |
JSR168 Portlet? | No |
Alias | /portlet/wm_renderadmin |
Default Instances of the portlet | Folders > Administrative Folders > Administration Dashboard > User Interface > Renderer Administration |
Tools. Administrators use this portlet to manage portal renderers. The portlet lists all registered portal renderers and allows administrators to edit them. Additionally, administrators can create new UsePortlet portal renderers.
A portal renderer is a My webMethods Server component that renders My webMethods Server pages. UsePortlet portal renderers render the standard My webMethods Server shell header and footer, but delegate the rendering of the page's main content to another portlet.
To create a new UsePortlet renderer, an administrator selects the
Create New Renderer tab of the
Renderer Administration portlet, selects the portlet that the new renderer is to use for the page's main content, and configures the portlet's properties.
To use the new renderer for a page, the administrator can add the "layout" parameter to the page's URL. For example, to display the Public Folders page with a renderer named "myRenderer", the following URL might be used:
http://localhost:8585/folder.public?layout=myRenderer
An administrator can also use rendering rules to automatically apply a new renderer to a page; for more information, see Administering My webMethods Server.
To edit the properties of an existing portal renderer, an administrator pages through the list of existing renderers to locate the portal renderer to update, and then selects the
Modify Renderer option of the Tools menu for that renderer. For UsePortlet renderers, an administrator can update any property of the portlet used by the renderer; however, for a non-UsePortlet renderer, an administrator can only edit the renderer's name and description.
The portlet also allows administrators to edit the raw configuration for all types of portal renderers. To do so, an administrator pages through the list of existing renderers to locate the renderer to update, and then clicks the name of that renderer. In response, the portlet displays the raw properties page that lists the raw XML configuration data that the administrator can edit.
Properties
Cache Age (CacheAge)
Defines how long to cache the contents of the Renderer Administration portlet. Specify one of the following:
0 – Default. Do not cache the contents of the portlet.
-1 – Cache the contents of the portlet indefinitely.
number – Cache the contents for the specified number of minutes.
All instances of the portlet share the value of this property.
Portlet Properties
Portlet (portlet)
Required. Identifies the portlet that the new renderer is to use to render the page's main content. Specify the thingID or alias of the portlet. If the property has no value, the Renderer Administration portlet will not create the new renderer.
When using the Renderer Administration portlet user interface, this property is automatically set based on the portlet selected on the Create New Renderer tab. When programmatically using the Renderer Administration portlet, you must specify a value for this property.
Renderer Properties
Renderer Name (rendererName)
Required. Identifies the name of the renderer that is being created or edited. Specify 1 through 100 characters for the name. If the property has no value, the Renderer Administration portlet will not create or update the renderer.
When using the Renderer Administration portlet user interface, this property is automatically set based on the name you specify for the new renderer on the Create New Renderer tab or the name of the renderer you selected for edit. When programmatically using the Renderer Administration portlet, you must specify a value for this property.
Renderer Description (rendererDescription)
Provides a description of the renderer being created or edited. If the property has no value, the renderer will not have a description.
When using the Renderer Administration portlet user interface, this property is automatically set based on the description you specify in the user interface. When programmatically using the Renderer Administration portlet, specify a value for this property if you want to provide a description.
Params Properties
Renderer ID (renderedID)
Required. Identifies the renderer that you want to edit by the thingID or alias of the renderer.
When using the Renderer Administration portlet user interface, this property is automatically set to the ID of the of the UsePortlet renderer. When programmatically using the Renderer Administration portlet, you must specify a value for this property.