Structure (DC)
Breadcrumbs

structure-effector

You can use this module to add a new effector to Structure. Effectors are used to update items based on Structure forests and attribute values.

Example

<structure-effector
    key="effector-example" name="effector:Example"
    class="com.mycompany.structure.examples.ExamplesEffector">
  <label key="com.mycompany.examples.effector.label"/>
  <dialog-title key="com.mycompany.examples.effector.dialog-title"/>
  <resource type="velocity" name="form" location="/templates/example/effector-example-form.vm"/>
  <resource type="velocity" name="summary" location="/templates/example/effector-example-summary.vm"/>
</structure-extender>


Element

Required?

Description

@key

Yes

The unique identifier of the effector. Full module key will be a part of effector 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.

@class

Yes

Fully-qualified class name of the effector implementation. Must implement 

Effector

.

label

Yes

The name of the effector as it appears to the user.

dialog-title

No

The title of the dialog that is used to edit the effector.

resource[@name=form]

No

Velocity template with the HTML form that will be used for editing the effector's parameters.

resource[@name=summary]

No

Velocity template that will be used to display the effector as a row in a structure.