Backbone Work Sync
5.24 5.23 5.22 5.21 5.20 Cloud Data Center
5.24 5.23 5.22 5.21 5.20 Cloud Data Center

Workflow Mappings

With Backbone, you can define workflow mappings based on issue status, allowing you to sync statuses between issues. This guide will demonstrate how to map the workflows between two synchronized issues. 

Are you on the right help page?

If you connect Jiras...
...via HTTP(S) (server/data center, cloud, local), you're in the right place.
...via email or file exchange (server/data center behind a firewall), check out this page instead.

Requirements

The synchronization user must have the transition issues and administer projects permissions

Choose the Correct Workflow Editor

Backbone has two workflow mapping editors:

When you start configuring your workflow mappings, it's important to choose the correct one for your needs. You can always switch from default to advanced, but the other way around is not possible without needing to create a new workflow mapping.

It is recommended to use the default editor as it’s easier to use and maintain. However, when you have certain transitions in your workflows that can be executed in multiple ways, and you need to define which exact path should be taken, we recommend the advanced editor. This is because you can't select which transitions between states should be made in the default editor.

Default Editor

Let's create a workflow mapping with the default editor.

  1. To get started, open the synchronization configuration and click Workflows > New workflow mapping;

    Workflow-mapping-overview.png

    If you see a different view (with two columns for the two projects), this means that you've already created workflow mappings for this project with the advanced editor – you won't be able to switch back to the simple editor without losing these.

  2. Select which workflows you want to map, and what issue types you want to map the workflow for.

  3. Now, you can use the editor to map what workflow state the partner project should be triggered to when your project sends them a certain workflow state:
    Workflow-mapping-simple.png In this example, when Project A sends Project B its current workflow status, Project B's workflow status will transfer to the same status. If there is more than one path between two statuses, Backbone will always select the shortest path. If there are multiple possible shortest paths, you can select which Backbone should take by clicking the path selection button:

    Workflow-mapping-multiple-transitions-highlighted.png
  4. On the next screen, map what workflow status your project should transition to when the partner project sends a workflow state. You can configure this in the same way as step 3.

Advanced Editor

The advanced editor lets you map workflow states between projects, and also select specific transitions between those states.

If you need to use the advanced editor, switch by clicking ... > Switch to advanced view:

Workflow-mapping-switch-advanced.png
  • If you want to create a workflow mapping for all issue types belonging to a project's default workflow, then click Default workflow mapping +.

  • If you want to create a workflow mapping for (a) specific issue type/s, click + New workflow mapping.

To define a workflow mapping, simply click + then you can define transition rules for your project. When you define a transition rule, you can define what transition for project's workflow should be triggered when the workflow status in the partner project changes. The condition is always a combination of the local status and the status of the partner project. Whenever the status in the partner project changes, Backbone will search for a matching condition and perform the selected transition (or transitions). The list of transitions to select depends on the selected local status.

Transition rule example

Screen Shot 2021-11-11 at 14.00.41.png

Here, if Project A is in status To Do, and Project B's workflow status changes to in Progress, then Project A's workflow status transitions to status In Progress.

Choose How Statuses Sync for New Work Items

When Backbone Work Sync creates a work item in your space, the partner work item may already have changed status several times. You can choose whether the new work item replays those changes or goes straight to the matching status.

The setting is called Status sync for new issues which can be found below your workflow mappings. It appears once you've added at least one workflow mapping.

Each space has its own setting. It controls incoming status changes, so how statuses are applied to new issues in that space. The options are:

  • Current status only (default for new syncs/recommended): Backbone moves the new work item straight to the status that matches the partner issue's current status. Status changes from before the first sync are ignored.

  • Full status history: Backbone replays every status change of the partner issue, in order. The new issue can pass through several statuses before it settles.

Example of how the setting is used

A work item moves from Open to In Progress, then to Done, and back to Open. Then it's synchronized for the first time.

  • With Current status only, the new work item goes straight to the status mapped to Open.

  • With Full status history, the new work item moves to In Progress, then Done, then back to Open.

Change the setting

To change how statuses sync for new work items:

  1. Open the synchronization and select Edit Configuration.

  2. Select Workflows.

  3. Below the workflow mappings, choose an option under Status sync for new issues for your space.

  4. Publish your changes.

The setting also applies when you resync statuses with their history. See Trigger a Resync.

Last updated: