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.
Example source code
The complete source code for this example is available at https://bitbucket.org/Adaptavist/example-gadget-extension/src/master/.
Step 1: Create the gadget feature and export it with PC
First create an example of a gadget in a dashboard in Jira, configuring it as required. The screenshot below shows an example configuration.
Next, export a configuration with PC that includes the dashboard. Bear in mind that Project Configurator does not export dashboards as a default, so you have to select the export option that exports the dashboard you created as a sample. Go to the Dashboards Options drop-down menu in the Export Projects page and select an option that is appropriate for your case. In the example below, we have chosen to export all dashboards, which guarantees all dashboards in this instance will be exported (even private ones):
Once this configuration is exported, open the created XML file with an editor of your preference and locate the gadget description. There is a dashboards element in the file that contains all exported dashboards, that contains several dashboard elements. Each of these will have several gadget items. It is easy to identify a dashboard by its name and owner, or as the default dashboard (system dashboard). You will see something similar to the following:
Notice how each gadget has several parameters that represent how you configured the gadget at 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 Extensions. 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:
- A parameter with key "columNames" that is a list of field identifiers
- A parameter with key "filterId"
Parameter "columNames" can be ignored. This appears in many gadgets and it is already handled by Project Configurator as standard.
Focus on parameter "filterId". If you check the filter set up during dashboard configuration, you will notice this parameter contains a string with the internal Jira ID for the selected filter. This means that this parameter will have to be translated to a different ID for a successful migration. This implies you will implement this extension as a GadgetTranslationPoint. If this parameter contained a reference to another entity that never requires a translation, then you would use a GadgetReferencePoint.
Define location
To identify a gadget extension point, you must specify two things:
- The type of gadget where it appear
- In which of the user preferences / parameters it appears for that gadget type
If you look at the GadgetHookPoint interface, which is the common ancestor of interfaces GadgetTranslationPoint and GadgetReferencePoint, you will notice it has these methods:
|
|
|
One of the first two methods will be used to identify the gadget type; most often, getTypeURIString(). In this example, looking at the XML file with the dashboard description, you can see the gadget element has a child element <type>:
... <gadget> <type>rest/gadgets/1.0/g/com.ja.jira.plugin.searchrequest:sswc-gadget/gadget_wc.xml</type> <column>0</column> ...
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 return value for the getTypeURIString() method of the associated GadgetTranslationPoint.
Define the content of the reference
This is described the same way as with workflow extensions. Navigate to the available predefined TranslateOption values that describe built in translators and identify one that handles a filter ID:
Combining the location and reference content, you define the GadgetTranslationPoint. It could similar to the following:
public GadgetTranslationPoint getSSSCGadgetFilterHookPoint() {
return new GadgetTranslationPointImpl.Builder().
withTranslator(translatorFactory.fromOption(TranslatorFactory.TranslateOption.FILTER_ID)).
withUri("rest/gadgets/1.0/g/com.ja.jira.plugin.searchrequest:sswc-gadget/gadget_wc.xml").
withParamKey("filterId").build();
}
Remember to add this as a method of the class you created in step 2, so you will have:
package com.adaptavist.projectconfigurator.ssscextension;
import com.atlassian.plugin.spring.scanner.annotation.Profile;
import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
import com.awnaba.projectconfigurator.extensionpoints.common.HookPointCollection;
import com.awnaba.projectconfigurator.extensionpoints.extensionservices.ReferenceMarkerFactory;
import com.awnaba.projectconfigurator.extensionpoints.extensionservices.TranslatorFactory;
import com.awnaba.projectconfigurator.extensionpoints.gadget.GadgetTranslationPoint;
import com.awnaba.projectconfigurator.extensionpoints.gadget.GadgetTranslationPointImpl;
import org.springframework.stereotype.Component;
import javax.inject.Inject;
@Profile("pc4j-extensions")
@Component
public class SSSCExtensionModule implements HookPointCollection {
private TranslatorFactory translatorFactory;
private ReferenceMarkerFactory referenceMarkerFactory;
@Inject
public SSSCExtensionModule(@ComponentImport TranslatorFactory translatorFactory,
@ComponentImport ReferenceMarkerFactory referenceMarkerFactory) {
this.translatorFactory = translatorFactory;
this.referenceMarkerFactory = referenceMarkerFactory;
}
public GadgetTranslationPoint getSSSCGadgetFilterHookPoint() {
return new GadgetTranslationPointImpl.Builder().
withTranslator(translatorFactory.fromOption(TranslatorFactory.TranslateOption.FILTER_ID)).
withUri("rest/gadgets/1.0/g/com.ja.jira.plugin.searchrequest:sswc-gadget/gadget_wc.xml").
withParamKey("filterId").build();
}
}
And that's it!
You have now completed an integration of this gadget type with Project Configurator.