Page tree

Documentation for Structure version 5.0 and patch releases. Version Index

Skip to end of metadata
Go to start of metadata

Filter Synchronizer lets you automatically add issues to structure or remove issues from structure based on a Saved Filter or a JQL query.This powerful synchronizer lets you control the contents of the structure with an issue filter (either a Saved Filter or an arbitrary JQL Query). You can either add issues to structure automatically, or remove issues from structure automatically, or do both.

Filter Synchronizer Parameters

Filter

A Saved Filter or a JQL Query to sync with. Click Select to choose a saved filter or switch to JQL query and enter the JQL.

When this synchronizer is enabled and runs in background, it "listens" to JIRA events about issues being changed. That means that if the result of a query may change without an issue being actually changed, the synchronizer will not detect the change and will not update the structure.

For example, if you use JQL query updatedDate > startOfMonth(), the synchronizer will not update the structure at the beginning of a month, when the result of the query changes. You will need to do a Resync or use scheduled synchronization.

Add

Turns on Add Mode: the synchronizer will make sure that all issues from the filter's result are present in the Structure.

Place added issue at the top level

The newly discovered issues from the filter result are placed at the top level, at the end of the structure.

Place added issue as a sub-issue of ...

You can enter issue key (like PROJECT-123) of an issue that will serve as the parent for the newly discovered issues from the filter. They will be placed as children of this issue, at the end of the current children list. Note that if this issue is not present in the structure, the issues won't be added at all.

Allow move

This option is available if you have specified the parent issue for adding matching issues. This option tells the synchronizer what to do if a discovered matching issue is already added to the structure, but is located somewhere else, not under the designated parent issue. If the option is on, the synchronizer will move the issue (with all its possible sub-issues) under the parent issue. If the option is off, the issue will be left alone where it now resides.

Remove

Turns on Remove Mode: the synchronizer will remove issues from the structure when they no longer are present in the filter result. However, if an issue to be removed contains sub-issues that should stay in the structure, it will not be removed.

Remove only from where added issues are placed

Additional flag to remove issues only if they are either at the top level or under the issue where they were initially placed by the synchronizer. So if you move an automatically added issue somewhere else, it will not be removed even if it is no longer present in the search result.

This synchronizer supports only Import / Resync into Structure (more about resync).

If the Saved Filter used in configuration is deleted later, or if you lose permissions to run it, the synchronizer will not work.

No matter how synchronizers are configured, they will only affect issues from the projects that are enabled for synchronization.

CAREFUL! Please be careful when turning on Remove mode and installing another synchronizer into the same structure. It is possible to set up the structure synchronizers in a way to make them cycle: some other synchronizer, like Sub-tasks synchronizer, would add an issue to the structure and then Saved Filter synchronizer in Remove or Add/Remove mode would remove that issue, and so forth.

Filter Synchronizer Rules
  • Synchronizer adds issues from its filter's result to structure and/or removes issues that no longer are in the filter's result.
  • Whenever an issue changes, a query is run to see if it matches the filter. On resync, all issues are checked.
  • With Add mode on, an issue will be added to the structure if it matches the filter - even if the user has manually removed it from there. If the issue is already in the structure, it will not be affected, unless Allow Move is on - in which case it will be relocated under the specified parent issue.
  • With Remove mode on, an issue will be removed from the structure if it does not match the filter - even if the user has manually added it before.
  • When adding issues on Resync or Import, synchronizer places them at the end of the structure (or at the end under the specified parent issue), in the order that corresponds to the filter's order. However, if only part of the filter result is added (for example, because other issues are already in the structure), the final sequence of issues may be different from the filter result.