10X: Configure and Activate Azure DevOps Integration

You should configure Azure DevOps settings in Jira Align for the correct data synchronization. You can customize many settings according to your needs.

To configure and turn on integration:

Prerequisites:

  1. In Jira Align, set up portfolios and programs.
  2. Create the PI dates you identified in Step 8 in the Azure DevOps Integration Prerequisites section.
  3. Create sync sprints for each PI and each iteration.

Set up connector information

  1. Select Administration from the left menu bar, and then click VSTS Settings under Connectors.
  2. Click Add Connector. The New Azure DevOps Connector slide-out appears.
  3. Type the connection name and the URL to connect to Azure DevOps.
    Note: This configuration supports both the https://visualstudio.com and https://dev.azure.com.
  4. Select the authentication method you want to use: PAT (personal access token), NTLM (NT LAN manager), or OAuth (only available for Cloud instances), and then enter the necessary credentials. Read more on authentication methods here.
    1. When PAT is chosen, you are given the choice to set a timezone.  Set this to the timezone of the Azure DevOps user for whom you created the personal access token. Setting this incorrectly can cause the connector to miss changes to work items that need synchronization.
  5. From the Default Sync User drop-down menu, select the user name that will be used by default to synchronize the unassigned items in Jira Align. If you don’t select anyone from the list, the item will stay unassigned.
  6. In the Item Link Back URL Template box, type the URL template used when you want to present a link in Jira Align in the upper-right corner of an item that will take you to the linked item in Azure DevOps.
  7. In the Instance Image URL box, provide a path to the logo to use for this connection.
  8. Enter a value between 60 and 1440 minutes in the Project sync timer field. This value controls how often the connector syncs mapped program area paths, team area paths, and iteration paths.
  9. Enter a value between 3 and 60 minutes in the Work item sync timer field. This value controls how often the connector syncs new and updated work items.
  10. Enter a value between 240 and 1440 minutes in the Recycle bin sync timer field. This value controls how often the connector syncs items in the ADO recycle bin with the Jira Align recycle bin.
  11. Select Save. The connector information updates an is deactivated by default; additional Projects and Items tabs display at the top of the slide-out.
  12. Activate the connector by selecting Activate on the right of the connector slide-out. When active, the Activate option will change to Deactivate so that the connector can be disabled if desired.
  13. Remove the connector permanently by selecting Delete on the right of the slide-out.

 Configure your projects

  1. On the connector slide-out, select the Projects tab.

  2. Switch-on the Support Multiple Projects toggle if you would like to map multiple Azure DevOps projects with this single connector.

Important: When this toggle is toggled on or off, the connector’s previous project setup is cleared.

If mapping a single project with the connector:

  1. Enter the Azure DevOps Project Name for the project you’d like to map.
  2. Select a Jira Align program to use as a Default Program if a program cannot be found in the mapping for an item’s area path.

If mapping multiple projects with the connector:

  1. Enter a Process Template Name.
  2. Add Azure DevOps projects to be synced by entering the project name and then selecting the plus (+) icon to add it to a list of projects to sync.
  3. Remove a path from the list by selecting the X icon next to its name.
  • In the Program Mapping section, enter the Azure DevOps Value that you wish to map, and select its corresponding Jira Align Program.
  1. Add additional programs for mapping by selecting the Add button. You can also delete program mappings by clicking the trashcan icon next to the mapping.
  2. In the Work Code Field Name text field, enter the name of the Azure DevOps custom field you’d like to use to set Jira Align work codes for features.
  3. Under Team Area Setup, set up your Team Level Mapping by selecting the minimum and maximum team area hierarchy levels in the Minimum Level and Maximum Level drop-downs, respectively.
  4. If you’re only mapping a single project with this connector, set a Scope Path. Enter an Azure DevOps Path to define the team sync scope in the text field, and then select a Matching Method in the drop-down:
    1. Begins with - all paths that starts with the specified value will be synced as teams.
    2. Includes - all paths that includes the specified value will be synced as teams.
    3. Exact only - only the path with the specified value will be synced as a team.
  5. Optionally, add Exclude Paths to denote team area paths, including children, that will not be synced. All items with paths set in the Exclude Paths section will not be synced. For each path you’d like to exclude, enter the name of the path to exclude, and then select the plus (+) icon to add it to a list of excluded paths.
  6. Remove a path from the Excluded Path list by selecting the X icon next to its name.

Note: When syncing a single-project, exclude paths should be within the team area scope set in Scope Path.

  1. Under Iteration Area Setup, set up your Release Level Mapping by selecting the minimum and maximum release area hierarchy levels in the Minimum Level and Maximum Level drop-downs, respectively.
  2. Set up your Iteration Level Mapping electing the minimum and maximum number of iteration area hierarchy levels in the Minimum Level and Maximum Level drop-downs, respectively.
  3. If you’re only mapping a single project with this connector, set a Scope Path. Enter an Azure DevOps Path to define the sync scope in the text field, and then select a Matching Method in the drop-down:
    1. Begins with - all paths that starts with specified value will be synced as releases or iterations.
    2. Includes - all paths that includes specified value will be synced as releases or iterations.
    3. Exact only - only the path with specified value will be synced as a release or iteration.
  4. Optionally, set a number of Buffer Days to automatically map Azure DevOps releases and iterations that have end dates to Jira Align sprints and releases on a day range.
  5. Optionally, add Exclude Paths to denote iteration area paths that will not be synced. All items with paths set in the Exclude Paths section will not be synced. For each path you’d like to exclude, enter the name of the path to exclude, and then select the plus (+) icon to add it to a list of excluded paths.
  6. Remove a path from the Excluded Path list by selecting the X icon next to its name.

Note: When syncing a single-project, exclude paths should be within the iteration area scope set in Scope Path.

  1. Select Save to save your changes to the connector.

Configure work item sync

A variety of work items can be synced between Azure DevOps and Jira Align, including tasks, defects, stories, and features. On the Items tab, you can toggle syncing of each work item type on and off, as well as configure a variety of other settings.

Defects, stories, and features can be synced forward from Azure DevOps to Jira Align or bi-directionally; tasks can only be synced forward (from Azure DevOps to Jira Align).

To sync a work item:

    1. Switch-on the toggle next to the work item’s type to turn sync on.
    2. Enter the Azure DevOps Item Type to be synced with the Jira Align work item.
    3. Select a Delete Action to determine what will happen to the work items in Jira Align when the associated work items are deleted in Azure DevOps.
    4. For features and stories, enter the name of the Azure DevOps field that syncs with Jira Align acceptance criteria in Acceptance criteria field name.
    5. In the State Mapping (Azure DevOps to Jira Align) section, enter the Azure DevOps Value that you wish to map, and select its corresponding Jira Align State. Optionally, add one or more Other Allowed States in Jira Align for the mapping.
    6. For all items except tasks, in the State Mapping (Jira Align to Azure DevOps) section, enter the Jira Align State that you wish to map. Then, set its corresponding Azure DevOps Value. Optionally, add one or more Other Allowed States in AzureDevOps for the mapping.
      1. Add additional states for mapping by selecting the Add button. You can also delete state mappings by clicking the trashcan icon next to the mapping.
    7. For defects, in the Severity Mapping section, enter the Jira Align Severity that you wish to map. Then set its corresponding Azure DevOps Value.
    8. For stories and features, in the Type Mapping section, enter the Jira Align type that you wish to map to a Azure DevOps Value Area.  Optionally, add one or more Other Allowed Types for the mapping.

Authentication methods

PAT (personal access token)

For PAT authentication, you need to generate an access token in Azure DevOps first. Read the Authenticate access with personal access tokens for Azure DevOps Services and TFS article to learn how to create personal access tokens to authenticate access. For proper functioning of the connector, select Project and team (read, write, and manage), Work item (full), and Identity (manage) as scopes. Finally, enter your user name (email) and password (your access token) in Jira Align.

NTLM (NT LAN manager)

NTL is used for server authentication. Type a user name, which is a domain name/the user added to the Azure DevOps server, for example, {local/admin}, and a password, which is a password of this user.

OAuth

OAuth is an authentication method that Cloud users can use. First, click Register to register your application with Visual Studio Online. Read more on how to register your app here.

Required fields to fill in are your Company name, Application name, Application website, and Authorization callback URL. For authorization callback URL, use https://{yourinstancename}/privateapi/tfsConfig/oauth/callback/. For proper functioning of the connector, select Project and team (read, write, and manage), Work item (full), Identity (manage), and MemberEntitlement Management (read) as authorization scopes.

After the registration, you will get a generated App ID, Client Secret, Authorized Scopes, and Callback URL. Copy and transfer them to Jira Align. Click Authorize and Get Token.

Was this article helpful?
0 out of 0 found this helpful
Print Friendly Version of this pagePrint Get a PDF version of this webpagePDF

Join the Atlassian Community!

The Atlassian Community is a unique, highly collaborative space where customers and Atlassians come together. Ask questions and get answers, start discussions, and collaborate with thousands of other Jira Align customers. Visit the Jira Align Community Collection today.

Need to contact Jira Align Support? Please open a support request.