×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Advanced Settings

Sebastian Hesse

Sebastian Hesse Last update: Feb 6, 2019

The advanced settings allow project and system admins to tweak the behavior of Backbone Issue Sync. Advanced Settings can be separately configured for each synchronization configuration by navigating to the list of Synchronizations > Configure a synchronizationConfiguration > Advanced Settings. This article describes what settings are available, and how to change them.

Note

Please read the documentation carefully before applying any changes in production.

Available settings

KeyDescription
sync.outgoingInterval

This setting allows you to override the default outgoing synchronization interval of '5s' with a custom value. The interval defines how often Backbone Issue Sync checks for updated issues, identifies the changes and sends them to the other project.

Changing this value does not adversely affect system performance.

sync.correlationFieldId

This setting allows you to define the ID of a custom field which should be used to store the issue key of the partner project. You should perform the following steps in order to configure this successfully:

  1. Create a read-only text custom field with a relevant name, e.g. 'Partner Issue Key'.
  2. Get the ID of the custom field. The format of the value must be structured like 'customfield_10000' with 10000 replaced by the corresponding custom field ID.
  3. Supply the custom field ID including the string 'customfield_' as value for this setting for the corresponding project.

Please note that the custom field needs to be present on the 'edit screen' (as for all other mapped fields). You don't need any other bidirectional field mappings in order to enable this.

sync.editTransition

By default, Backbone Issue Sync uses the regular edit action of an issue to update issue information. Therefore, all fields to be written to need to be present on the 'edit screen'.

If certain fields are only written by the other system you may want to hide those fields from your users. This setting allows you to define the name of a transition which Backbone will use instead of performing the changes via the edit operation. In order to use this feature, you need a transition which is available in each workflow state and does not change the status (global looped transition). This transition needs a transition screen with all fields to be written to. The name of the transition should be provided as a value here.

sync.incomingJql

This setting allows you to prevent the processing of incoming updates for certain issues. If this field is empty, all incoming changes will be applied. If this field is filled, the issue must match the given jql condition so that the changes are accepted. E.g. if you do not want to apply updates for an issue in state 'Closed', you could define the value 'status  != Closed'.

(info) Outgoing updates are not affected by this setting – you can limit them in the Issue Type Mappings.

sync.disableAttachmentDeletion

By default, Backbone Issue Sync synchronizes attachment deletions as described here. This setting allows you to disable the deletion of attachments completely for this project.

(info) Please note that attachments not created by the synchronization user will never be deleted by Backbone Issue Sync. The values should be 'true' or 'false'.

sync.jsdScenario

If you configured your synchronization using one of the officially supported JIRA Service Desk scenarios, this field will display which scenario is configured for the synchronization. If you have not configured a JIRA Service Desk scenario, this field will be blank.

The possible values for this field are:

(info) This field is read-only, and cannot be edited. This is because the JIRA Service Desk synchronization scenario cannot be changed after you have configured and activated the synchronization.

sync.responsibilityConfiguration

Configure a custom field to define which synchronization partner has the 'responsibility' of making changes to an issue. When one synchronization partner has responsibility, changes made by the other synchronization partner are not synchronized.

The format of this field is a JSON object containing the field ID of the custom responsibility field, the local responsibility option ID, and the remote responsibility option ID. For a detailed configuration guide, see the knowledgebase article.

sync.automaticConflictResolution

When the sync.responsibilityConfiguration setting is configured (see above for details), this setting defines how changes made by the synchronization partner without responsibility are handled.

  • if this option is set to Yes, the changes are rolled back when the synchronization is updated
  • if this option is set to No, the changes are kept but not synchronized
sync.notifyUsersDisable JIRA from sending issue updated email notifications for all changes performed by Backbone. The Backbone add-on user requires global or project-level admin permissions to disable notifications.
advanced.issueTypeChangeAllowed

By default, Backbone does not synchronize the change of an issue type. If this setting is checked, Backbone will also try to sync the issue type change.

(warning) Please note that we discourage the use of this feature if the issue types in your project have different workflows. Please also pay attention that the field mappings in Backbone should be the same for the issue types.

2x3.6
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok