Field Sync Documentation

1.Description

Field Sync plugin provides synchronization for the selected fields between:

• An issue and it's sub-issues 
• Linked issues
• Agile issues
  
  

2.Installation

To install Field Sync, involves the following steps:
 

1. Log in as a user with the JIRA Administrators.
2. Select Add-ons from the Administration menu at the top right of your screen. 

You can install the Add-On in two ways: Install the Add-On from Marketplace OR Upload an Add-On.

Upload an Add-On:
 

Install the Add-On from Marketplace:

1. Click the Find New Add-ons link.
2. Enter a search string in the Search the Marketplace box.
3. To install an add-on, click the Install button for free add-ons or the Buy Now or Free Trial buttons for paid add-ons. 

3.Configuration

How to Configure: 

Return back Add-ons section from the Administration menu. Go to " Field Sync Admin Section" .

You will see Field Sync Settings section on the left side of the screen: 

3.1. Field Sync Setting

Field sync provides multiple settings schemes. Thus you can save your settings and use them separately or simultaneously and enable them when they are needed.

• Checking "Active" checkbox activates the corresponding setting.
• Clicking "Delete Setting" deletes that setting.
• If you want to examine or edit your settings click setting link. It redirect you to a listener setting page.
• If you want to create new settings click "New". It redirect you to a listener setting page.
   

3.2. Subtask Listener Setting Configuration

If you would like to do synchronization between issue and sub-issues, configure this section. Check the "Activate" checkbox and type your "Listener Name". The configuration options will be shown. Configure those as your needs. Hold "Ctrl" key and click to select multiple "Project Names", "Issue Types", "SubTask Issue Types", and "Fields".
 

 
If you choose "Check all" option, all projects, issue types, link directions and fields will be selected. The key point is when you add a new option (Ex: new project) for one of them in JIRA, you don't have to configure in Field Sync panel. Because it will be added automatically.

Please note that, only system and custom fields are supported by default. Please check the availability of the custom field if it comes with a specific plugin.

Sync on Create: If you enable this option; whenever you create sub-task, related fields will be synchronized automatically. If not, sync will be applied after the "Edit Issue" event such as changing the status or a field.

Sync on Move: If you enable this option; when you move the issue, sync will be applied again.

Allow sync on not editable issues: Check the checkbox if you allow the synchronization on "Not editable issues".

Allow Comment Sync on issues: Enables comment synchronization between linked issues.

Sync Existing Issues: If you want to sync all issues in the system, check the box.

Bidirectional Sync: If this field is checked, field value synchronization will be applied to both parent issue to sub-issue and sub-issue to parent issue.
 

3.3. Linked Issues Listener Setting Configuration

If you would like to do synchronization  between linked issues, configure this section. Check the "Activate" checkbox and type your "Listener Name". The configuration options will be shown. Configure those as your needs. Hold "Ctrl" key and click to select multiple "Project Names", "Issue Types", "Link Types" and "Fields".
 

If you choose "Check to sync all" option, all projects, issue types, link directions and fields will be selected. The key point is when you add a new option (Ex: new project) for one of them in JIRA, you don't have to configure in Field Sync panel. Because it will be added automatically.

Please note that, only system and custom fields are supported by default. Please check the availability of the custom field if it comes with a specific plugin.

Link Direction:  You can define the sync direction with this option.

Sync on Create: If you enable this option; whenever you create linked issue, related fields will be synchronized automatically. If not, sync will be applied after the "Edit Issue" event such as changing the status or a field.

Sync on Move: If you enable this option; when you move the issue, sync will be applied again.

Allow sync on not editable issues: Check the checkbox if you allow the synchronization on "Not editable issues".

Allow Comment Sync on issues: Enables comment synchronization between linked issues.

Sync Existing Issues: If you want to sync all issues in the system, click this button.
 

3.4. Epic-Story Listener Setting Configuration

If you would like to do synchronization between agile issues, configure this section. Check the "Activate" checkbox and type your "Listener Name". The configuration options will be shown. Configure those as your needs. Hold "Ctrl" key and click to select multiple "Project Names", "Issue Types" and "Fields".

Direction:  You can define the sync direction with this option; "Both", "Story to Epic" or "Epic to Story".

Sync on Create: If you enable this option; whenever you create issues in epic , related fields will be synchronized automatically. If not, sync will be applied after the "Edit Issue" event such as changing the status or a field.

Allow sync on not editable issues: Check the checkbox if you allow the synchronization on "Not editable issues".

Allow Comment Sync on issues: Enables comment synchronization between linked issues.

Sync Existing Issues: If you want to sync all issues in the system, click this button.
 

4.Usage

For example, you can see settings that are selected as below. Priority and Description field values among the issue and sub-issue will be synchronized with these settings.

After saving the settings and creating a issue and a sub-issue; it is clear in the below image that the priority and description fields are synchronized between the parent issue and the sub-issue:
 

Parent Issue:

  
 

Sub Issue: 

5. Previous JIRA Versions Support

For the customers are using older JIRA Server versions: Please visit "Version History" page of this plugin and download the compatible version.