Child pages
  • Synchronizer Module

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

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.

Code Block
  <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"/>

    <inbound>
      <resync-description key="inbound.resync.i18n.key"/>
    </inbound>
    <outbound>
      <resync-description key="outbound.resync.i18n.key"/>
    </outbound>
  </structure-synchronizer>

Element

Required

Description

structure-synchronizer

Yes

The module descriptor

structure-synchronizer/@key

Yes

Unique module key within the plugin

structure-synchronizer/@order

Yes

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

structure-synchronizer/@class

Yes

The class that implements the synchronizer. Must implement StructureSynchronizer - better extend AbstractSynchronizer or AbstractIssueListeningSynchronizer

structure-synchronizer/label

Yes

The name of the synchronizer

structure-synchronizer/description

No

Description of the synchronizer

structure-synchronizer/rules

No

Possibly large text, that is shown at the top of synchronizer configuration page.

structure-synchronizer/resource[@name="form"]

Yes

A velocity template that contains form for the synchronizer parameters.

structure-synchronizer/inbound

Either inbound, outbound or both

If present, it means that Resync can run "from outside into Structure"

structure-synchronizer/inbound/resync-description

 

 

structure-synchronizer/outbound

Either inbound, outbound or both

If present, it means that Resync can run "from Structure to outside"

structure-synchronizer/outbound/resync-description