Breadcrumbs

Create a Synchronization

Backbone Work Sync allows you to integrate two Jira projects to synchronize work items.

Scope of a Synchronization

Synchronizations are always configured on a project-by-project basis, always between two projects.

However, you can create multiple synchronizations per project. So if you want to connect one project with multiple projects, you can simply create multiple synchronizations for a project.

Data Transmission Protocol

Backbone uses the official Jira REST API in order to access both Jira projects which it integrates. If you provide a HTTPS URL when you setup the synchronization, Backbone will use an encrypted channel in order to communicate with Jira.


Configuration

You have multiple options to sync from your cloud space, you can synchronize:

Synchronize two Jira spaces on the same instance 

  1. Firstly, open the space that you want to synchronize, and select Space settings > Backbone Work Sync > New Synchronization > Synchronize with another space on this instance:

    New-synchronization-cloud-local.png

  2. Choose the space you want to synchronize issue data with, then click Next

  3. Assign a name and description. For now, let's stick with the default name and description – click Next

  4. On the settings overview screen, check the configuration settings then click Send Request

  5. Now, any user with the Administer Space permission for Cloud Project B can accept the synchronization request to establish the connection between the spaces. To accept the request, open Cloud Project B and click Space settings > Backbone Work Sync > in the Actions column, click ... > View Request > Accept Request.

Congratulations, you've established a synchronization! Now, carry on and configure what work types will be synchronized between the projects.

Synchronize two Jira Spaces on different instances 

To sync with a space on another instance, you need to send a 'Synchronization request' to the other instance, which the Jira administrators in the other instance can accept to establish a connection.

  1. Open the space you want to synchronize, and select Space settings > Backbone Work Sync > New Synchronization > Synchronize with another Cloud instance > Next:

    New-synchronization-cloud- partner-instance.png

  2. In the Partner Instance column, enter the following data:

    1. In the Base URL field, enter the base URL of the Jira instance you want to synchronize with – it will have this structure: https://example.atlassian.net

    2. In the Space Key field, you can enter a specific space key of a space in the partner instance. Enter Cloud Project B's space key, and click Next

  3. Based on your needs, either choose “immediate“ or “review“, and click Next

  4. For now, let's stick with the default name and description – click Next

  5. Check the configuration settings, and click Send Request

  6. Now, any user with the Administer Space permission for Cloud Project B can accept the synchronization request to establish the connection between the spaces. To accept the request, open Cloud Project B and click Space settings > Backbone Work Sync > in the Actions column, click ... > View Request > Accept Request

Congratulations, you've established a synchronization! Now, carry on and configure what work types will be synchronized between the spaces.

Synchronize from Cloud to Data Center

Prerequisites

To set up a sync from Cloud to DC you need the following:

  • Space admin rights cloud

  • A sync user on Data Center

  • Jira 8.22 or higher on Data Center

Step 1 - Cloud: Create a Sync

  1. Go to the space that you want to synchronize on Cloud

  2. Select Space settings > Backbone Work Sync > New Synchronization > Synchronize with a Data Center Instance

  3. Copy the URL provided


Step 2 - Data Center: Create an Application Link

On the Data Center instance you want to sync with, create an application link

You only need to set up the application link once. Thus if you want to set up multiple synchronizations to the same instance, you can use the same application link and skip this step

  1. Go to the cog icon (Settings) > Applications.

  2. Select Application Links in the left menu.

  3. Select Create link:

    1. For Application type, select External application

    2. For Direction, select Incoming

  4. Click continue

  5. Fill out the form:

    • Name: give it a unique name, e.g. Backbone Authentication

    • URL: copy the URL provided in the create sync dialog (on cloud)

    • Permission: choose Admin

Admin permissions are needed for space administration actions Backbone performs, such as crating space versions. However, you can still restrict the permissions of the synchronization user to only have permissions for the spaces you want to sync.

  1. Save the form

  2. Copy the Client Id and Client Secret

Step 3 - Cloud: Continue Setting Up The Sync

  1. In the partner instance column, enter the following data:

    • Base URL: the Base URL of the Data Center instance

    • Client Id / Client Secret: Enter this information from the application link you have created in step 2.7

  2. Choose to Authenticate or copy the link

    1. Authenticate: Leads you to the DC instance where you can authenticate to the sync user with the username and password

    2. Copy Link: Send over the link to the admin on the DC side so they can authenticate to the sync user with the username and password

  3. Select which space you want to synchronize

  4. For now, let's stick with the default name and description – just click Next

  5. On the overview screen, check the configuration details then click Create

Congratulations, you've established a synchronization! Now create the data center WebHook, so that the updates from the data center instance can get synchronized.

Synchronize from Cloud to Cloud using the remote license

Prerequisites

To set up a sync from Cloud to Cloud with the remote license you need the following:

  • Space rights cloud

  • A sync user on Cloud

    • To also sync the status (workflow mapping), this user needs Jira Admin rights

  • A remote license uploaded

Configure the Synchronization

  1. Go to the space that you want to synchronize on Cloud

  2. Select Space settings > Backbone Work Sync > New Synchronization > Synchronize with a Cloud Instance

  3. In the Partner Instance column, enter the following data:

    1. In the Base URL field, enter the base URL of the Jira instance you want to synchronize with – it will have this structure: https://example.atlassian.net

    2. In the Space Key field, you can enter a specific space key of a space in the partner instance. Enter Cloud Project B's space key, and click Next

  4. Choose to Authenticate or copy the link

    1. Authenticate: Leads you to the Cloud instance where you can authenticate to the sync user with the username and password

    2. Copy Link: Send over the link to the admin on the Cloud side so they can authenticate to the sync user with the username and password

  5. On the overview screen, check the configuration details then click Create

Congratulations, you've established a synchronization! Now create the cloud WebHook, so that the updates from the remote Cloud instance can get synchronized.

Synchronize from Cloud to Data Center using the remote license

The steps to set up the remote license from Cloud to Data Center are the same as using a marketplace license. Therefore, please refer to these steps.