Get started

Thanks for choosing Backbone Issue Sync for Jira. Backbone helps you simplify collaboration on projects, internally or across organizations, by synchronizing Jira issues in real-time.

This guide will illustrate the steps required to get started with Backbone on Jira Cloud.

Watch the video

To learn more about what Backbone can do for you, watch the Get Started video that introduces Backbone’s features.

1: Finding Backbone in Jira

After installing Backbone Issue Sync for Jira from the Atlassian Marketplace, you can find Backbone in the Jira sidebar of a project under the “Apps” tab.

To create your first project synchronization, follow these steps:

Go to Project settings > Apps > Issue Synchronization.
Click New Synchronization.

As illustrated below, Backbone allows you to create a synchronization:

With another project in the same instance.
With another Cloud instance.

2: Synchronizing Projects Using Backbone

There are two separate options when syncing Jira projects using Backbone. Please choose the section that applies to your use case.

Synchronizing projects on the same Jira instance.
Synchronizing projects on a separate Jira instance.

Syncing Projects on the Same Jira Instance

Starting the synchronization

Select the first option Synchronize with another project on this instance > Next.
You will be prompted to select the project from the list of Jira projects available on your instance.
For our example, we will create a synchronization between Project A and Project B. Choose the project to be synced.
The name and description of the synchronization is already filled out. You have the option to change it as well.
Click Send Request.

Accepting the Sync Request

Navigate to the relevant Jira project (Project B in this example).

Go to the Project Settings > Apps > Issue Synchronization.
1. Here you should see an Incoming Request message under Status in the Backbone panel.
Click on the three dot menu (…) under Actions > View request.
Click Accept Request > Start Configuration.

Congratulations! The connection between Project A and Project B is established. You are now ready to start the configuration of your synchronization.

Click here to expand...Syncing Projects on a Separate Jira Instance

This section will show you how to configure Backbone to synchronize issues between projects across two separate Jira instances (referred to as instance A and instance B).

Please make sure that you have installed Backbone on both Jira instances.

On instance A, create a new project called Project A, and on instance B, create a new project called Project B.

Starting the synchronization

Let's establish a connection between the two projects so they can communicate with each other.

We'll send a 'Synchronization request' to the other instance. This request has to be accepted by a Jira administrator or a project admin on the other instance to establish the connection.

Click New Synchronization.
Select the second option Synchronize with another Cloud instance > Next.
You will be prompted to enter the Base URL and Project Key in the Partner Instance column.
1. In the Base URL field, enter the base URL of the Jira instance you want to synchronize with. The URL will have this structure: https://example.atlassian.net.
2. In the Project Key field, you can enter a specific project key of a project on the partner instance. Enter Project B's project key and click Next.
You can change the name and description of the synchronization. For now, let's stick with the default name and description and click Next.
Check the configuration settings and click Send Request.

Accepting the Sync Request

Any user with the project admin status for project B on Instance B can accept the synchronization request to establish the connection between the projects.

Navigate to the relevant Jira project (Project B in this example).
1. Go to the Project Settings > Apps > Issue Synchronization.
2. Here you should see an Incoming Request message under Status in the Backbone panel.
Click on the three dot menu (…) under Actions > View request.
Click Accept Request > Start Configuration.

Congratulations! The connection between Project A and Project B is established. You are now ready to start the configuration of your synchronization.

3: Configure Synchronization Settings

After establishing a connection between two Jira projects, you can now select the exact type of Jira data you want to synchronize. The following steps will guide you on how to successfully set up a sync.

Issue Type Mapping:

To start editing the synchronization, click Edit Configuration.
Open the Issue Types tab and click Start with simple mappings.
Select the issue types you want to map across Project A and Project B.
a. In this example, we will select the issue type Task.
You can use the drop down box and choose to synchronize the issue types either in both directions between Project A and Project B or in one direction.
Click Create to save the issue type mapping.

Field Mapping:

Navigate to the Fields - Mappings tab > + Field Mapping.
Select the fields you want to synchronize. In this example, we will select Summary and Description.
You can use the drop down box to synchronize issue fields either in one or both directions.
Click Create to save the fields configuration.

Comments Mapping:

Navigate to the Comments tab.
Use the drop down box to choose between uni-directional or bi-directional comment mapping.
Click Enriched mapping to get the complete information about the reporter and comment date and time.
Click Publish Draft > Start Synchronization.

Well done! You've configured your first Backbone synchronization. Now, all issues with type Task will be synchronized between Projects A and B.

The fields Summary and Description fields will be synchronized between those issues along with any comments.

4: Using the Synchronization

Now for the fun part: let's use Backbone to test the synchronization by creating an issue type Task in Project B and testing whether the issue is automatically synchronized to Project A.

Create a new issue with type Task in Project B, and enter some text in the Summary and Description fields.
Open Project A. You can see that the issue has now been synchronized.
Open the synchronized issue in Project A and add a comment.
Go back to the issue in Project B and open the synced Task. The comment can now be seen as well.

Easy-peasy! You have successfully created and tested your first synchronization.

Next steps:

Now, you can try out more configuration options, such as different issue/field types, or comments and attachments.