Azure DevOps Plan Hierarchy Integration - Integration Setup

This article explains how to set up the integration between OnePlan and Azure DevOps and incorporating a hierarchy structure.

This integration focuses on importing multiple work item types from Azure DevOps into OnePlan as plan level items, and all related child items will be brought into OnePlan as backlog items.

OnePlan Setup

For this integration, you will 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 AzureDevOps:

• the Azure DevOps URL

• a Personal Access Token

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
        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. Navigate to OnePlan Plans and Azure DevOps - Plans Hierarchy. Click the Configure button. The configuration form will open.

   

3. Complete the configuration form.

   1. Complete the OnePlan section:

      • App Name: Enter the OnePlan Group name you will be integrating into.

      • Key: Enter the OnePlan Authentication Key generated from OnePlan.

      • (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 Next.

   3. Complete the Azure DevOps section:

      Note

      Expand the Additional Options area to see all the necessary fields to be filled in.

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

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

        

      • Azure DevOps Plan Level Type: Enter a single Azure DevOps work item type that will be the Plan level item in OnePlan. If there are more than one work item types listed, no plans will be brought in.

        Note

        Please ensure that the hierarchy format matches what is shown in Azure DevOps, if the order is not the same, then the work items will not be brought in.

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

        

      • (Optional) Sync ADO team project name to come into OnePlan as parent plan type: (Default) When unchecked, the Team Project Name is ignored and not brought into OnePlan. If checked, it will be brought into OnePlan as a parent plan type of the plans being imported.

      • (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.