Page tree

This documentation relates to an older version 5.2 of the Structure for Jira. Visit the current documentation home.

Skip to end of metadata
Go to start of metadata

Synchronizer module allows you to plug additional synchronizers into Structure.

Module description sample

Here's a template of a synchronizer module declaration, and explanation of the parameters follows.

  <structure-synchronizer key="module-key" order="100"
                          class="com.company.your.plugin.sync.SyncClass">
    <label key="label.i18n.key">Name of Synchronizer</label>
    <description key="description.i18n.key">Description of Synchronizer</description>
    <rules key="rules.i18n.key">Large text to be shown at the top of synchronizer's configuration page.</rules>
    <resource type="velocity" name="form" location="/templates/myplugin/sync-form.vm"/>
  </structure-synchronizer>

Element

Required

Description

structure-synchronizer

Yes

The module descriptor.

@key

Yes

Unique module key within the plugin.

@order

Yes

Order of the synchronizer among other synchronizers, whenever a list of synchronizers is present.

@class

Yes

The class that implements the synchronizer. Must implement StructureSynchronizer. It is recommended to extend AbstractSynchronizer.

label

Yes

The name of the synchronizer.

description

No

Description of the synchronizer.

rules

No

The text that is shown at the top of the synchronizer configuration page. Could be a large text.

resource[@name="form"]

Yes

A velocity template that contains the form for the synchronizer parameters.

  • No labels