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:
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.
|
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 | Enabling this option allows the synchronization of issue data, even for not included issue types. Enabling this feature can cause the following behavior:
see for more information: https://k15t.jira.com/browse/BAC-1738 |