Purpose of this Module Type

A portlet plugin module defines a portlet that users can add to their Dashboards.

Configuration

The root element for the portlet plugin module is portlet. It allows the following attributes and child elements for configuration:

Attributes

Name

Required

Description

Default

class

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.

The Java class of the component. Portlet implementation classes are required to implement the com.atlassian.jira.portlet.Portlet interface, but we strongly recommend that you extend the convenience class com.atlassian.jira.portlet.PortletImpl.

key

The unique identifier of the plugin module. You refer to this key to use the resource from other contexts in your plugin, such as from the plugin Java code or JavaScript resources.