You are viewing documentation for Structure Server and Data Center version 5.6 and patch releases. For other versions, see Version Index or [Structure Cloud].
Dark Feature - Synchronizers are hidden by default
We recommend using Automation instead of Synchronizers. Automation is safer, provides additional functionality and flexibility, and uses fewer system resources.
To enable synchronizers, see Advanced Configuration and Dark Features.
Synchronize | Choose the mode of operation:
|
Agile Board mode parameters: | |
---|---|
Agile Board | Select the Jira Agile board to synchronize with. The issues matching the Board query will be synchronized. If the structure contains other issues, they will not be affected. |
Synchronize Rank | If checked, repositioning issues in the structure will also change their Rank respectively. Changing Rank in Jira will likewise cause the issue to be repositioned in the structure. |
Synchronize Epics | If checked, placing an issue under an epic in the structure will add it to that epic in Jira. Similarly, if you add an issue to an epic (on the Scrum board or by changing Epic/Theme field of the issue), the issue will be repositioned under that epic in the structure. |
Auto-add sub-tasks | If checked, all sub-tasks of an issue will be added to the structure as well and positioned under the parent issue. |
Custom projects and fields parameters: | |
Projects | Select the Jira project(s) to synchronize with. If the structure contains issues from other projects, they will not be affected. The issues from all selected projects will be synchronized using the same Global Rank field. |
Rank Field | The field of type "Rank" that holds the rank (backlog order) for the selected Project. If you do not wish to synchronize rank, select Don't synchronize. |
Synchronize Epics | If checked, placing an issue under an epic in the structure will add it to that epic in Jira. Similarly, if you add an issue to an epic (on the Scrum board or by changing Epic/Theme field of the issue), the issue will be repositioned under that epic in the structure. |
Auto-add Subtasks | If checked, all sub-tasks of an issue will be added to the structure as well and positioned under the parent issue. |
This synchronizer supports both Import and Export / Resync into/from Structure (more about resync). Incremental synchronization watches both structure changes and Jira changes and applies the change to the other side.
CAREFUL! Please be careful when using this synchronizer, especially when you add multiple issues to the Structure, as this may lead to massive updates in the Agile ranks. There is no "undo" option.
When issues are repositioned in the structure according to Rank, they are never moved under a different parent issue.
This restricts the possible rank changes in Jira - you can only move an issue to the position of another issue that is under the same parent issue in the structure; otherwise, the issue will "jump back" later.
When the Agile synchronizer is enabled, it automatically updates the Agile order in background when any Structure change happens. This means that if you carelessly add issues from the sync'ed project to the structure in some random order, their ranks will be updated according to that order.
Agile Boards are flat (except for sub-tasks), and the Structure is hierarchical - so it is not possible to precisely rearrange a structure to have all issues come in the same order as they do on the Planning Board, without changing issue parents or making the Structure also flat.
To that end, the structure syncs subsets of the issues in the hierarchy with Agile Rank. For example, consider the following Structure:
A |
|
| B |
| C |
D |
|
| E |
| F |
It is not possible to rearrange the sub-issues so they come in the following order: B, E, C, F - although this is possible on the Planning Board. Instead, the structure will synchronize sub-sets of the issues in the Structure with Jira. The following sub-sets will be synchronized separately:
In Jira version 6.1 and later, the epics are treated as a separate set of issues, different from Stories and other non-Epics. To accommodate this, Structure updates the rank of issues using a "partial order" approach, syncing epics and non-epics separately. This means that if an epic comes before a Story on the Structure Board, it is not required that they come in the same order on the Scrum Board.