Synchronisation methods (v3.0.0)

Owned by Jonas Hallensleben
Last updated: Oct 17, 2024
3 min read

Note
Version & Component Sync will apply changes to versions/components retroactively upon creating the project link for both the Simple & Advanced synchronisation method

Settings

When creating a project link, the app provides you with the option to set your desired synchronisation mode. Depending on the synchronisation method you choose users or Jira Administrators can configure the following settings:

Schedule

This setting allows you to configure when a synchronisation should take place.

Triggers

This setting allows you to configure which events should trigger a synchronisation. Jira distinguishes the following events related to versions & components:

Versions

  • Create

  • Delete

  • Move

  • Release

  • Unrelease

  • Archive

  • Unarchive

Components

  • Create

  • Update

  • Delete

  • Archive

  • Unarchive

Synchronisation method: Simple

Note

  1. This synchronisation mode will delete any versions/components in the Target project that do not exist in the Source project

  2. This synchronisation mode will propagate any and all changes made to versions/components in the Source project to the corresponding versions/components in the Target project(s)

  3. This synchronisation mode will disable the ability to create or edit versions/components from the Target project administration screen

Schedule

  • Default: When choosing the simple synchronisation method the schedule is set to default. The default schedule can only be configured by a Jira administrator. To set the default schedule take the following steps:

    • Navigate to Jira Administration > Manage apps > Version & Component Sync > Synchronisation

    • Click on Edit on the right hand side

    • Set the desired timeout & threads

    • Click save

VCS - Synchronisation methods (1).png

 

VCS - Synchronisation methods (2).png

 

Triggers

  • Per default synchronisation is triggered by all version & component related events. This setting is not configurable when using this synchronisation method.

    • This means that the app will propagate any and all changes made to versions/components in the Source project to the corresponding versions/components in the Target projects

 

Synchronisation method: Advanced

Note

  1. This synchronisation mode allows you to select the specific events you would like to synchronise to the corresponding versions/components in Target projects.

  2. This synchronisation mode allows you to keep creating/editing versions/components in Target projects. This is particularly useful if the project has a mixture of shared versions/components and project specific versions/components.

Schedule

When using the Advanced synchronisation method the app provides you with the following options with regards to the schedule:

  • No scheduling: Synchronisation is only triggered by Jira events. This will disable the “Update” trigger. Rename operations or changes to description, start & release date will not be propagated

  • Default scheduling: Synchronisation will be scheduled using the global schedule set by the Jira administrator

  • Custom: Allows you to set a specific schedule for this project

 

Triggers

  • Per default synchronisation is triggered by all version & component related events. This setting is configurable when using the Advanced synchronisation method. You can disable or enable all the version/component related triggers.