Skip to main content
Skip table of contents

Advanced Settings

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 by opening the Synchronization Configuration > Advanced Settings. This article describes which settings are available, and how to change them.

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

Available settings

Key

Description

sync.correlationFieldId

This setting allows you to select 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. Select the created custom field 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 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 only want to apply updates for an issue in state 'in Progress', you could define the value 'status  = "In progress"'.

Outgoing updates are not affected by this setting. You can limit them in the issue type mapping.

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. The values should be 'true' or 'false'.

Attachments not created by Backbone Issue Sync will never be deleted by the app.

sync.replaceUserMentions

This setting enables you to replace user mentions inside comments and multi-line text fields with the configured text. If no value is configured, no replacement will take place. Note: this can’t be used in combination with sync.useDisplayNameUserMentions.

sync.useDisplayNameUserMentions

This setting enables you to replace the user mention in a comment or text field that are sent to the other project with the plain text display name of the user. This can be handy when the user doesn’t exist on the other project. Note: this can’t be used in combination with sync.replaceUserMentions.

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 this 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.notifyUsers

Disable Jira from sending issue updated email notifications for issue updates performed by Backbone (excluding comments/attachments).

advanced.issueTypeChangeAllowed

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

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 the Backbone configuration should be the same for the issue types.

sync.unsyncedIssueTypeAllowed*

You can choose between the following settings:

  • All:

    • Values (such as fields, comments) will sync bidirectionally, even if the issue type is only synced unidirectionally.

    • If an issue type is changed to one not included in the sync, updates will still continue for that issue type.

    • Potential risk (only for "review mode" syncs): Issues could be paired with types that aren't meant to be synced, which may lead to data leakage.

  • Any direction (Default):

    • Values (such as fields, comments) will sync bidirectionally, even if the issue type is only synced unidirectionally.

    • If an issue type is changed to one not in the mapping, syncing will stop for that issue type.

  • Configured Directions

    • Values (such as fields and comments) will not sync bidirectionally if the issue type is only synced unidirectionally. The direction of syncing for issue types also applies to field mappings, statuses, comments, and attachments.

*Example situation for sync.unsyncedIssueTypeAllowed

You have the following configuration:

  • Sync between project A and project B

  • Issue types (unidirectional):

    • Bug → Bug

  • Field Mappings (bidirectional):

    • Description ↔︎ Description

 

You create a bug in project A (PA-1) which gets synced to project B (PB-1). The table below shows what does and doesn’t get synced based on the configuration.

Action

All

Any Direction

Configured Direction

Update description in PA-1

description synced (tick)

description synced (tick)

description synced (tick)

Update description in PB-1

description synced (tick)

description synced (tick)

description not synced (error)

Change issue type PA-1 from bug to a task and update the description on PA-1

description synced (tick)

description not synced (error)

description not synced (error)

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.