Synchronisation Modes

As explained on the synchronisation modes page the app provides you with two synchronisation modes:

1. Simple

2. Advanced

When creating a project link the sync mode is set too Simple per default.

Simple

Using the Simple sync mode will ensure that the app:

1. Deletes any versions/components in the Linked project(s) that do not exist in the Master project

2. Propagates any and all changes made to versions/components in the Master project to the corresponding versions/components in the Linked project(s)

3. Disables the create and edit features of the versions/components configuration screen

This means that if you create a project link using the default settings, the app won’t allow you to:

1. Keep pre-existing versions/components in your Linked project(s).

2. Create versions/components in Linked project(s).

To keep pre-existing versions/components in a Linked project, you need create a project link using the Advanced sync mode.

Advanced

Using the Advanced sync mode gives you more control over the synchronisation of versions/components in Linked projects. It allows you to:

1. Select the specific events you would like to synchronise to the corresponding versions/components in Linked projects

2. Create versions/components in Linked projects

So how this sync mode allows us to keep pre-existing versions in Linked projects?

Create project link

In the example below we have the following set-up in Jira:

To share versions/components from the Master (MAS) project, we will create a project link with project Linked Project 1 (LP1)

• Navigate to the Administration interface of the Master project.

• Go to the Version & Component Sync page

• Click on Get Started

• Make sure to thoroughly read the message in the pop-up modal before you click on continue

• Select the project(s) you want to link to the Master project, Versions from Master will be propagated to selected project(s)

• In this example we will create a project link with Linked Project 1

• After selecting Linked Project 1, click on Next:Synchronisation

• On the next screen you can choose your desired synchronisation mode, Simple or Advanced

• As explained in synchronisation modes section, we will create a project link using the Advanced synchronisation mode

• After choosing the Advanced synchronisation mode, the app will provide you with the option to configure which events should trigger a synchronisation.

• By unchecking the Delete event, the app will no longer synchronise Delete events. This means that the app will not remove versions from the Linked project that do not exist in the Master projects

• The app will now show an overview of the project link(s) you are creating

• Click on save, to save the project link(s)

• Upon clicking on save, the app will:

  • Start synchronising

  • Shown an overview of the created project links and their current status

• To edit or delete a existing project link click on the triple dot menu on the right of the project link

• To provide you with insights in how the app works, this is what happens during synchronisation:

  • Upon creating a project link between Master & Linked Project 1 the app checks whether there are versions present in Linked Project 1

Version 1.0.0

• The app recognises that version 1.0.0 in Master does not exist in Linked Project 1

• The app creates versions 1.0.0 in Linked Project 1

  • Jira does not allow you to link a single version to multiple projects. Therefore the app needs to create ‘new’ versions in Linked Project 1

• The app makes sure that upon creation of the ‘new’ version 1.0.0 in Linked Project 1 it is linked to version 1.0.0 in Master

• This links ensures that any and all version changes to version 1.0.0 in the Master project are synchronised to version 1.0.0 in Linked Project 1

Version 2.0.0

• The app recognises that version 2.0.0 does not exist in Linked Project 1

• The app creates versions 2.0.0 in Linked Project 1

  • Jira does not allow you to link a single version to multiple projects. Therefore the app needs to create ‘new’ versions in Linked Project 1

• The app makes sure that upon creation of the ‘new’ version 2.0.0 in Linked Project 1 it is linked to version 2.0.0 in Master

• This links ensures that any and all version changes to version 2.0.0 in the Master project are synchronised to version 2.0.0 in Linked Project 1

Version 3.0.0

• The app recognises that version 3.0.0 in Linked Project 1 does not exist in Master

• The app deletes version 3.0.0 in Linked Project 1

  • For a more detailed explanation on why the app removes version 3.0.0 from Linked Project 1 please read about the different synchronisation modes

would like to synchronise to linked projects. If you would like to be able to keep manually created components in project A & B please uncheck 'Delete' in the 'Specific Changes' panel. 

The "Delete" event ensures that Version & Component Sync will remove all versions/components in 'Linked Projects' that are not present in the 'Master' project.

Keep in mind that unchecking the “Delete” event means that none of the “Delete” events will be synchronised. The deletion of a component in project A  will no longer result in the deletion of the component in projects B & C. Unfortunately, there is currently no option which will preserve the manually created versions/components whilst also deleting any version/component that does not exist in the Master project. This is a limitation which comes from the fact that the app has no means to determine if a version/component was manually created in the linked project.

Please let me know if you have any additional questions!

Kind regards,

Jonas Hallensleben