...
To explain how to create an extension for dashboard gadgets, we will base this on an example using the Show Saved Filter with Columns for Jira plugin and its Show Saved Filter with Columns gadget.
Step 1: Create the gadget feature and export it with PCJ
First create an example of a gadget in a dashboard in Jira, configuring it as required. The screenshot below shows an example configuration.
...
Notice how each gadget has several parameters that represent how you configured the gadget at the Jira user interface, setting preferences like the filter, the number of results to display, and the refresh period.
Step 2: Implement interface HookPointCollection
This step is the same as the example in Workflow Extensionsextensions. It is even possible to have workflow and gadget extensions within the same instance of HookPointCollection.
Step 3: Implement the gadget extension
Analyze
First, check which of the parameter elements in your gadget contain references to other entities in Jira. As with workflows, you have to specify how these references can be found in the configuration for dashboards and what their content is. In this example, you can find two references:
...
| Info |
|---|
Adding support for a parameter in a gadget means creating an instance of |
Define location
The "location" of a gadget parameter consists of:
...
This means the gadget type is identified by its URI (otherwise, it would contain a child <completeModuleKey> element). Use the text of the <type> element as a return value for the getTypeURIString() method of the associated GadgetHookPoint.
Define the content of the reference
This is described the same way as with workflow extensions. GadgetHookPoint extends the interface HookPoint; therefore, it must implement the method:
...