TFS4JIRA Self-Hosted | Force sync priority during the initial synchronization

Owned by Damian Kilkowski (Inactive) (Deactivated)
Last updated: Oct 07, 2022
2 min read

With the default setup, TFS4JIRA Self-Hosted, during initial synchronization, sorts migrated issues/ work items using the last change date. With version 7.10.16 we introduced an additional setting that can force TFS4JIRA to sort synchronization queue based on issue work item type. This additional configuration should be set up if HIERARCHY is used within Jira or TFS/ADO environment.

In order to enable issue/item type sorting, an additional line must be added to the web.config on the TFS4JIRA installation folder. Please follow the below instruction to complete the task.

  1. Please make sure you have the latest version of TFS4JIRA Self Hosted. The latest version of TFS4JIRA Self-Hosted can be downloaded from this page: Appfire - TFS4JIRA

  2. Login to your SERVER where TFS4JIRA Self-Hosted is installed.

  3. Browse to your TFS4JIRA installation folder. Default folder: C:\inetpub\wwwroot\tfs-jira-synchronizer

    1. if you do not remember where TFS4JIRA is installed, you can check where the LOGs are stored. Simply open TFS4JIRA configurator page, go to LOG section and check the bottom of the page. It should hold a line similar to this, but with your own LOGs location: “Log files directory: C:\inetpub\wwwroot\tfs-jira-synchronizer\App_Data\log”

  4. Before any EDITions please create a copy of web.config.

  5. In the main application folder please EDIT web.config

  6. Look for a section starting with: <appSettings>

  7. Add the following line within <appSettings> section.

    1. to set priority of sync from TFS: <add key="sortTfsItemTypeDuringInitial" value="Epic,*,task" />

    2. to set priority of sync from JIRA: <add key="sortJiraIssueTypeDuringInitial" value="Epic ,*,sub-task"/>

    3. VALUE in both lines must be adjusted to HIERARCHY in your environment

    4. in case of one direction migration, only one line must be added corresponding to the source environment.

    5. example:
      In my environment (JIRA) I have EPICS as top-level in the hierarchy. Features and stories are set up as issues for EPICS. Features have children in form of BUGs. Both BUGs and STORIES have Sub-Tasks. Here is the line I need to add.
      <add key="sortJiraIssueTypeDuringInitial" value="Epic,Feature,Story,Bug,*,sub-task" />

  8. Save web.config.

  9. Now, please re-login to the TFS4JIRA configurator site and check if HIERARCHY is properly migrated to the opposite environment.