Skip to main content

Azure DevOps Connector

The Azure DevOps connector in SyncNow allows users to synchronize or migrate various entities such as features, user stories, bugs, and more between Azure DevOps and other work systems. This guide provides detailed steps on setting up the Azure DevOps connector, configuring sync processes, and managing synchronization settings.

Setting Up the Azure DevOps Connector

To set up the Azure DevOps connector in SyncNow, follow these steps:

  1. Navigate to the Systems Page

    • Access the "Systems" page from the main menu.

  2. Add a New System

    • Press the "Add System" button to create a new system connector.
    • Select “Azure DevOps Server” from the "Type" dropdown menu.

  3. Configure the Azure DevOps Connector

    • Name: Enter a unique name for the Azure DevOps connector.
    • Allow Self-Signed Certificates: Enable or disable the toggle for self-signed certificates. (Self-signed certificates are not recommended for production environments.)
    • URL: Provide the URL to the Azure DevOps Server instance.
    • Username: Enter the Azure DevOps username.
    • Access Token: Provide the access token for the Azure DevOps instance. (Create an Azure DevOps API token if not already done.)
    • API Version (Optional): Add a preferred API version. The default is 5.
    • Webhook Security: Configure webhook security as explained in the documentation for DevOps Gate and Sync. This includes options for authenticating webhooks anonymously, by IP address/range, or by SyncNow username/token authentication.

  4. Verify and Save

    • Press the "Verify Connection" button to check if the connection is established successfully.
    • Press the "Save" button to save the connector settings.

Creating a Sync Process

After configuring the Azure DevOps connector, follow these steps to create a sync process:

  1. Navigate to the Sync Processes Page

    • Access the "Sync Processes" page from the main menu.

  2. Add a New Sync Process

    • Press the "Add Sync Process" button to start configuring a new sync process.

  3. Define Sync Process Name

    • Enter a unique name for the sync process.

  4. Select Entity Types and Fields

    • Entity Types: Select the Azure DevOps entities such as features, user stories, bugs, tests, test plans, etc., that you want to synchronize.
    • Fields Mapping: Map Azure DevOps fields to corresponding fields in the target work system. All standard and custom fields are supported.

  5. Configure Synchronization Settings

    • Real-time Sync: Select this option to use webhooks for real-time synchronization. SyncNow will automatically register the necessary webhooks in Azure DevOps during the activation of the first sync process.
    • Timer Sync: Choose this option to synchronize data at regular intervals.

  6. Save and Activate

    • Click the "Save" button to save the sync process settings.
    • Activate the sync process to start synchronizing data between Azure DevOps and the target work system.

Supported Fields for Azure DevOps Synchronization

SyncNow provides support for synchronizing various fields between Azure DevOps entities and other work systems. The following table lists the fields that can be synchronized, specifying whether they support one-way or two-way synchronization.

FieldDescriptionDirection
TitleThe title of the entity.Bidirectional (Azure DevOps & Target System)
DescriptionThe detailed description of the entity.Bidirectional (Azure DevOps & Target System)
StatusThe status of the entity.Bidirectional (Azure DevOps & Target System)
AssigneesUsers assigned to the entity.Bidirectional (Azure DevOps & Target System)
CommentsComments related to the entity.Bidirectional (Azure DevOps & Target System)
Rich Text FieldsFields that contain rich text content.Bidirectional (Azure DevOps & Target System)
LinksLinks to other entities or resources.Bidirectional (Azure DevOps & Target System)
AttachmentsFiles attached to the entity.Bidirectional (Azure DevOps & Target System)
Custom FieldsCustom fields defined in the entity.Bidirectional (Azure DevOps & Target System)
TestsTest cases associated with the entity.Bidirectional (Azure DevOps & Target System)
Code TFVC/GitLinks to TFVC or Git repositories.Bidirectional (Azure DevOps & Target System)

Limitations