There are five modules, one for each type of generators, that work in the same way:
structure-inserterstructure-extenderstructure-filterstructure-grouperstructure-sorter
Each module allows declaring a generator of a specific type. When a plugin with a generator module is installed, you get the ability add those generators to structures.
Example
<structure-extender
key="extender-examples" name="extender:Examples" description="Examples extender"
class="com.mycompany.structure.examples.ExamplesExtender">
<label key="com.mycompany.examples.extender.label"/>
<icon spanClass="s-fa s-fa-link"/>
<dialog-title key="com.mycompany.examples.extender.dialog-title"/>
<resource type="velocity" name="form" location="/templates/example/extender-examples.vm"/>
<resource type="velocity" name="summary" location="/templates/example/extender-examples-summary.vm"/>
</structure-extender>
CODE
Other types of generators are declared in the same way.
| Element | Required? | Description |
|---|
@key | Yes | The unique identifier of the generator. Full module key will a part of generator specification, defining the automation. |
@name | No | The name of the module for the JIRA administrator. |
@description | No | Description of the module for the JIRA administrator. |
label | Yes | The name of the generator as it appears to the user. |
icon | No | The icon for the generator that will be shown whenever the generator row is displayed. See below for details. |
dialog-title | No | The title of the dialog that is used to edit the generator |
resource[@name=form] | No | Form template that will be used for editing the generator's parameters |
resource[@name=summary] | No | Form template that will be used to display the generator as a row in a structure |
Generator Icons
The icon for the generator is defined using CSS classes. If you're using your own icons, make sure the appropriate CSS styles are loaded everywhere Structure can be used (see Loading Additional Web Resources For Structure Widget).
You can also use the standard icons used by bundled generators:
| Generator Type | Icon Classes |
|---|
| Inserter | s-fa s-fa-plus |
| Extender | s-fa s-fa-link |
| Filter | alm alm-group |
| Grouper | s-fa s-fa-filter |
| Sorter | alm alm-sort-asc |