TFS4JIRA Self-hosted | Configuring the ID field for the TFS Synchronizer and How to Deal with the ID field on TFS4JIRA

TFS4JIRA Self-hosted | Configuring the ID field for the TFS Synchronizer and How to Deal with the ID field on TFS4JIRA

The ID field is used in the self-hosted version of TFS4JIRA, and it is required for both Jira Data Center and Cloud as long as you use the self-hosted synchronizer.

There are some points to have in consideration about this field for the correct functioning of TFS4JIRA self-hosted:

  • You must manually create a short text custom field for this field in your Jira instance, that's required. On the Azure/TFS side, you can optionally create a text field in Azure DevOps, or alternatively hold the Jira ID in Azure comment.

  • This field can be hidden when empty in Jira.

  • Do not add default values to this field. Doing so can cause conflicts with the synchronizer, which only adds values to the field if it is empty.

  • Using the field improperly will prevent the synchronizer from updating the work item counterpart. This is especially true if you manually change the field; it should be filled out by the synchronizer only. Otherwise, you’ll get errors in the logs, and synchronization won’t happen properly.

  • The field points to a work item ID. This means the value could be changed manually into another ID, but doing so is not advised. It will generate errors in the logs.

  • If you need to create new work items or issues to synchronize existing objects that already have a counterpart, you should use the Initial Synchronization option, and the synchronizer will update the necessary fields and create the new items.