Automation Toolbox for Jira provides the capability to easily configure unique event or schedule based transactions or jobs, allowing for flexibility on an instance-wide scale.

These transactions are structured in so-called rules that comprise those configuration elements necessary for successful processing.

Even though the configuration of a rule requires no coding or scripting experience, rules can encompass very far-reaching possibilities affecting many issues.

Administrators only

Because of the possible consequences potentially affecting the Jira instance, rules must be configured by a Jira administrator.

Rules

Rules are at the heart of Automation Toolbox.

Each rule must have a unique name, one trigger, and those configuration elements necessary for processing.

The configuration can be reached via the Jira administration → Manage apps → Automation Toolbox → Automation Rules.

Rules will only be executed if their trigger condition is met. 


Rule navigator

The rule navigator is your central location for managing your automation rules. 

Here you can:

  1. Add rules.
  2. Use the Actions menu to configure, edit, copy, and delete rules.
  3. See the current status and activate/deactivate rules.
  4. Search and filter rules by various options.
  5. Import rules.

Adding a rule

Go to Jira administration → Manage apps → Automation Toolbox → Automation Rules, and click on Add Rule.

Enter a unique name and a description for the new rule and click on Add.

Remember

Per rule, only one trigger can be specified, whereas selectors, conditions and actions can be added multiple times and can be nested in various combinations.

You can choose one of the following events or schedule options for your trigger:

Please follow the links for a more detailed description and usage of examples.


Rule statuses

A rule can have different statuses.

Each status has implications on the available actions for a rule and additionally provides information about potential configuration errors.

The following statuses are currently available:

The rule is currently inactive and can be activated.

The rule is deactivated and cannot be activated due to errors in the rule (e.g. a selector was configured that is not available in this context)

The rule is deactivated and cannot be activated due to missing actions. Each rule must have at least one action configured to be activated.

The rule is active and cannot be edited.

The rule is a manual rule and cannot be activated due to errors in the rule (e.g. a selector was configured that is not available in this context)

The rule is a manual rule and cannot be activated due to missing actions. Each rule must have at least one action configured to be activated.

The rule is a manual rule and can be executed by hitting the button



Activating / deactivating rules

By toggling the status button of a rule, a rule can be activated and deactivated.


Rules can also be activated and deactivated by clicking on the Activate button in the upper right-hand corner when editing a rule.

If there are loops in rules (one rule triggers another one which triggers the first one...), they will be executed just once and the rule will stop execution in order to prevent breaking larger Jira instances.


Editing and reconfiguring rules

Remember

Only inactive or deactivated rules can configured.

The name and description of a rule can be edited at any time, also for active rules.

To configure a rule click on the rule name or choose "Configure" in the Actions (gear wheel) dropdown. 

Clicking on "Edit" in the Actions dropdown menu will let you edit the rule name and description.


Copying and deleting rules

You can copy any rule by choosing "Copy" in the Actions dropdown. Additionally, a new unique name has to be specified to be able to save it. Copied rules are always deactivated by default.


To delete any rule choose "Delete" from the Actions dropdown.


Expression Parser

Automation Toolbox uses a powerful Expression Parser for interpreting expressions with logical, mathematical, date-time and string-text terms. This parser is a fundamental part of Automation Toolbox  and is used by various features in the add-on.

To get you started we have created the Expression Parser 101, that provides you with all the information to start configuring your first rules.


On this page

  • No labels