Workflow Plugin Modules

The workflow plugin modules allow you to add new capabilities to JIRA's workflow engine.

JIRA uses OSWorkflow as it's workflow engine. The web-based workflow editor has a number of plugin modules which allow you to build workflows more easily.

The modules are:

Conditions - check whether or not a given workflow transition can be executed by a given user
Functions - perform actions after a workflow transition has been executed.
Validators - check that the data given to a workflow transition is valid.

Here are some sample descriptors for these plugin modules:

<workflow-condition key="isuseringroup-condition" name="User Is In Group" 
    class="com.atlassian.jira.plugin.workflow.WorkflowIsUserInGroupConditionFactoryImpl">
    <description>
    Condition to allow only users in a given group to execute a transition.
    </description>

    <condition-class>
    com.opensymphony.workflow.util.OSUserGroupCondition
    </condition-class>

    <resource type="velocity" name="view" 
    location="templates/jira/.../isuseringroup-condition-view.vm"/>
    <resource type="velocity" name="input-parameters" 
    location="templates/jira/.../isuseringroup-condition-input-params.vm"/>
</workflow-condition>

<workflow-function key="update-issue-field-function" name="Update Issue Field" 
    class="com.atlassian.jira.plugin.workflow.UpdateIssueFieldFunctionPluginFactory">
    <description>Updates a simple issue field to a given value.</description>

    <function-class>
    com.atlassian.jira.workflow.function.issue.UpdateIssueFieldFunction
    </function-class>

    <orderable>true</orderable>
    <unique>false</unique>
    <deletable>true</deletable>

    <resource type="velocity" name="view" 
    location="templates/jira/.../update-issue-field-function-view.vm"/>
    <resource type="velocity" name="input-parameters" 
    location="templates/jira/.../update-issue-field-function-input-params.vm"/>
</workflow-function>


<workflow-validator key="permission-validator" name="Permission Validator" 
    class="com.atlassian.jira.plugin.workflow.WorkflowPermissionValidatorPluginFactory">
    <description>Validates that the user has a permission.</description>

    <validator-class>
    com.atlassian.jira.workflow.validator.PermissionValidator
    </validator-class>

    <resource type="velocity" name="view" 
    location="templates/jira/.../permission-validator-view.vm"/>
    <resource type="velocity" name="input-parameters" 
    location="templates/jira/.../permission-validator-input-params.vm"/>
</workflow-validator>

For more details, see the How to create Custom Workflow Elements for JIRA 3 page.

Workflow Plugin Modules

Labels: