Advanced Settings

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. You can set a different value by using the time shortcuts 's' (seconds), 'm' (minutes), or 'h' (hours), for example '1m' for 1 minute or '6h' for 6 hours.

Changing this value does not adversely affect system performance.

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.customLanguageList

By default, Backbone recognizes Jira's default languages and reacts to fields using them. If you are mapping translated custom field names in non-default languages, then you need to activate the recognition for those specific languages by providing them here. You can set one or more languages separated by commas, e.g 'en_US,de_DE,ja_JP'.

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). 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 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.

advanced.archivedMessagesPerIssue

Backbone stores part of its data in the JIRA-Home/data/backbone-issue-sync directory. This settings allows you to limit the number of messages to be stored in the archive folder (for unlimited, define '-1').

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.

• 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.