Content Comparison

Introduction

Step 1: Screenshots

There are two types of settings you have to configure when you start using Version & Component Sync (VCS).
There are settings to configure when enabling the add-on and there are settings to configure when you create a project link.

1. Settings when enabling the add on are explained in step 1.
   Step 1 This step can only be executed by the JIRA System Administrator within your organisation.
   
   
2. Settings when creating a project link are explained in step 2.
   Step 2 This step can be executed by anyone with Project Administrator permission.

Step 1: Enable Version & Component Sync 

1. To enable VCS, go to the JIRA administration at the top right of your screen , and click on add-ons.
   The VCS add-on is shown left on the add-ons page, click . Click on settings to go to the add-on settings . page

   Screenshots 1 & 2.
   
   
2. When you are on the settings page, click on edit.you can choose to enable Version Sync and/or Component Sync by clicking on the corresponding edit button
   Screenshot 3.
   VCS gives three options when enabling VCS.
   
   
3. A dialog will show with three options:

   Screenshot 4.
   
   

   • Timeout: This setting determines the time in seconds between synchronisations.
   • Enable synchronisation: This setting is used to turn synchronisation on and off. 
   • Multithreaded: This settings enables Multithreading for this add-om. This means that multiple synchronisations will be done simultaneously.  When enabled, multiple project links will be synchronised simultaneously. Multithreading is only recommended if you are experiencing slow synchronisation of project links. Enabling multithreading might increase memory and CPU consumption as well as database connectivity. Please make sure you monitor your JIRA Jira and database instance to avoid performance issues.
     
     
4. When VCS is you have enabled , the Version & Version Sync and/or Component Sync, the corresponding panels on the Project administration summary page
   will page will show "add project link".
   Screenshot 5. 

Step 2: Creating a project link

Step 2: Screenshots

After configuring the add-on settings, the second step is to create a project link. 

Versions are propagated from one Master project to multiple linked projects.

Given we have a JIRA Jira instance with a Master project (MAS), a Linked Project 1 (LP1) and Linked Project 2 (LP2), if we want to share versions from the Master Project, we will need to create project links to LP1 and LP2. 

1. Go to the Administration interface of the MAS project.
   You will see a Version and a Component Sync panel on the summary page below the Versions panelthe Versions panel
   
   
2. Click on the Add Project Link button to open the project link lightbox.
   Screenshot 1.
   
   

3. Select the project(s) you want to link the Master project with from the drop-down. project 
   Versions /components from MAS will be propagated to selected project(s)
   Screenshot 2.
   
   

   Note
   title Note
   Make sure that you have Project Administrator permission (not just Jira System Administrator) for all projects you would like to make a project link with. If you do not have Project Administrator permission for a project, this project will not be shown as an option to make a project link with.

   
   

4. Choose Click on Synchronisation to select the type of synchronisationof synchronisation
   You can choose between Full Synchronisation or Specific Changes.
   Screenshot 3 & 4.
   
   
5. Click on the Add Project Link button
   
   
6. When you added a project link, the Version or Component Sync panel on the administration interface
   in interface in the Master project , will show which projects are linked with the master project.
   Screenshot 5.
   
   
7. The Version or Component Sync panel on the administration interface of the linked projects
   will projects will only show a link to the Master project.
   Screenshot 6.
   
   
8. If you would like to make changes to the synchronisation settings, or remove a project link between projects,
   this can only be done from the Version or Component Sync panel on the project administration interface of the Master project.
   Removing a project link will stop the propagation of versions/components to the previously linked project.
   It will not remove any previously shared versions/components from the linked project.
   This  This can be considerate a safe operation.
   Screenshot 7 & 8.
   

   
   

   
   

Understanding Project Links

There are a few considerations when creating a project link:

• It is effective immediately, meaning that it will start synchronising versions/components as soon as the project link is created.
  In case of full synchronisation, the add-on will delete any versions/components in the linked project that does not exist in the Master project.
  
  
• You can create multiple project links for one Master project (e.g. MAS can have project links to LP1 and LP2).
  It is however not possible to have project links to a project that is already linked to another project or acts as a Master project.
  For  For instance, if we have a link between MAS and LP1 , we cannot create a project link to MAS or LP1 with LP2 as the Master project.
  
  
• In case of Full Synchronisation, the Versions or components /Components panel will be removed from the linked projects administration interface. In addition, the create and edit features of the Versions or components /Components configuration screen, will be disabled. Linked versions/components will be marked with the Version & Component Sync icon. (This means that , indicating that these versions/components can only be changed from the Master project)

Anchor
Synchronisation Types Synchronisation Types

Synchronisation Types

When creating a project link, you can choose between Full Synchronisation or synchronisation based on Specific Changes.

• Full Synchronisation will propagate any and all version/components changes from the Master project to all linked projects. It will disable the ability to create or edit versions/components from the linked project administration screen. 
  
  
• Specific Changes is less rigid. It will still propagate version updates like name and description, but it will  will give you more control over the synchronisation of versions/components in the linked project. For instance, if you only select the Create event, it will never delete versions/components from linked projects when they are deleted in the Master project. You can still manage versions/components from the linked project administration screen. This is particularly useful if the project has a mixture of shared versions/components and project specific versions/components.