Sync Profile Overview

Owned by Jeff Gleeson
Last updated: Jan 11, 2024
3 min read

Introduction

Once a sync profile has been created, the Profile Overview page for that profile provides information relating to:

  • Synchronization - enable or disable the synchronization for this profile with the Synchronization toggle

  • Sync initial items - synchronize items that existed on either platform prior to configuring and enabling the synchronizer

  • Profile History - display details of previous synchronizations

  • Sync Log - display history and status of all synchronized item pairs.

Access the Overview page

  1. Access a profile Overview page from the TFS4JIRA Synchronizer page by clicking Sync profiles from the Jira-Azure Synchronizer menu.

  2. From the Sync Profiles page, select a sync profile, or click the Options icon (…) for the profile and select See Overview from the list. The profile’s Overview page opens.

Sync Profile

The Sync Profile panel at the top of the page provides:

  • the profile number

  • the profile status (draft sync on sync off )

  • the number of configuration steps completed

  • the Synchronization toggle

  • the Sync initial items button

Sync Log

Click Sync log to open the history of the profile synchronizations.

Each issue ID provides access to the synchronization’s issue details including:

  • the Jira ID

  • the synchronization direction represented by an arrow

  • the associated Azure item number

  • the synchronization outcome 

  • the synchronization time

The Filter by ID field allows you to search for specific items. Enter an ID to look up an item, and select In Jira or In Azure and select between Failed and Synched to further narrow your search.

Select a Jira ID or an Azure task number to see that particular item in their respective platforms.

Failed items in the Sync log

When investigating a failed item, click Failed to see the list of failed items. This list provides additional information that relates to the failed sync. Click the error message beside the failed item for additional details relating to the error.

If you receive an error when synchronizing you can:

  • adjust the mappings and resolve or remove the issues causing the errors.

  • update the mapping default value options so the error won’t be raised in the future. If changing the default to Skip, the item won’t be included in the syncrhonization. Set the item to map to a default value and when TSF4JIRA encounters an unmapped item or value, it maps it to the specified condition.

Profile History

  1. Click the Profile History tab to see the list of profile events.

  2. Click See details for an event to see the number of synced and failed items. This list shows the Jira and Azure items that were synchronized and the direction of the synchronizations. In the screenshot below, you can see the direction of the synchronization goes from Azure to Jira.

  3. Click the Jira or Azure ID number to go to that item on their respective platforms.