Portlet Plugin Module - deprecated
In JIRA 4.0, portlets were replaced by gadgets. For details, please see Gadgets and JIRA Portlets.
Purpose of this Module Type
A portlet plugin module defines a portlet that users can add to their Dashboards.
The root element for the portlet plugin module is
portlet. It allows the following attributes and child elements for configuration:
The class which implements this plugin module. The class you need to provide depends on the module type. For example, Confluence theme, layout and colour-scheme modules can use classes already provided in Confluence. So you can write a theme-plugin without any Java code. But for macro and listener modules you need to write your own implementing class and include it in your plugin. See the plugin framework guide to creating plugin module instances.
In the example,
The localisation key for the human-readable name of the plugin module.
The human-readable name of the plugin module.
The plugin key.
A human-readable description of this portlet module. May be specified as the value of this element for plain text or with the
The user-visible name of this portlet. May be specified as the value of this element for plain text or with the
An optional thumbnail image used to preview the portlet for users.
Permission required to add this portlet to a dashboard. Value must be one of the fields of
Allows configuration of this portlet with an object descriptor class (see this page for more details). We recommend using a
Whether to load this portlet lazily.