Azure DevOps Team Projects Integration - Integration Setup

This article explains how to set up the integration between OnePlan and Azure DevOps based on the Team Project.

This integration focuses on importing plan and backlog level items into OnePlan from Microsoft’s Azure DevOps environment.

To set up this integration, you need:

• to have OnePlan and OneConnect approved by an Office365 tenant admin

• to be a OnePlan admin, meaning you are a user with Owner permissions in OnePlan

• to be a OneConnect Administrator or Editor in the OneConnect group where you want to set up the integration

• to be an Azure DevOps admin

OnePlan Setup

For this integration, you need to collect the following information from OnePlan:

• the group name

• an authentication key

• the authentication key name

1. Log in to your OnePlan group with your Office365 account.

2. Open the Admin pages by clicking on the Settings gear.

3. Select Integration in the admin navigation.

4. Click the + (plus) icon in the Authentication Keys section.

5. Save the key name and generated key somewhere, as once you navigate away from this browser page, the key cannot be seen. This Authentication key is to be used at a later step in the OneConnect configuration.

Azure DevOps Setup

For this integration, you will need to collect the following information from Azure DevOps:

• the Azure DevOps URL

• a Personal Access Token

Note

It is best practice to create a service account to use for the integrations. We strongly recommend setting up an Azure DevOps service account with admin permissions to use in this configuration.

1. Copy and save the root of the URL (i.e. https://dev.azure.com/Organization).

2. Generate an Azure DevOps Personal Access Token.

   1. Go to Azure DevOps.

   2. On the top right-hand corner, click on User Settings and select Personal Access Tokens. Once you are redirected to the user settings page, click New Token and fill out the information.

      • Make sure to provide a token name and only allow the token access within the organization you are going to connect in OneConnect.

      • Set the Expiration to be the maximum (Azure DevOps only allows 1 year as the maximum token validity) by selecting Custom Defined and select the dates.

      • Set the Scopes for the token to Full Access.

        Note

        If your Organization does not allow Full Access for any reason, we understand. The integration requires the following permissions at minimum:

        Scope Name	Permission Level
        Identity	Read and Manage
        Project and Team	Read, Write, and Manage
        Security	Manage
        Work Items	Read, Write, and Manage

        

   3. Click Create. After you click Create, you will be provided with the token. Make sure to save the token name, key and expiration date somewhere (notepad, doc, etc.), as once you close the tab, the key will remain hidden. Also, note the expiration date to extend the token once it expires.

OneConnect Setup

1. Go to https://my.oneconnect.ai.

2. Configure the following integration: OnePlan Plans and Azure DevOps Plans Hierarchy. Click the Configure button.

   

3. Complete the integration configuration form.

   1. Complete the OnePlan section.

      • App Name: Enter/paste the OnePlan Group name from the earlier OnePlan Setup steps.

      • Key: Enter/paste the OnePlan Authentication Key that you saved from the earlier OnePlan Setup steps.

      • (Optional) OnePlan URL: For clients that have their oneplan.ai hosted outside of the United States, please enter the OnePlan URL used.

        Note

        Options currently are: https://au.oneplan.ai, https://ca.oneplan.ai, https://eu.oneplan.ai.

      

   2. Click the Next button.

   3. Complete the Azure DevOps section.

      Note

      Expand the Additional Options tab to see all necessary fields for the integration.

      • Azure DevOps URL: Enter in the Azure DevOps Organization URL (e.g. https://dev.azure.com/{OrganizationName}/).

      • Azure DevOps Personal Access Token: Enter the Personal Access Token the organization that will be integrating with OnePlan.

        

      • Azure DevOps Work Item Type (Comma Separated): Enter any work item type desired to be imported from Azure DevOps into OnePlan as a Backlog/Task level item.

        

      • (Optional) Bring in Tasks and Bugs that are not in an iteration/sprint: (Default) When unchecked, only the tasks and bugs that are in a sprint will be brought in. When box is checked, all items will be brought in (even if no sprint is selected).

        

   4. Click Next.