Skip to main content

Azure DevOps Plan Hierarchy Integration - Integration Setup

  • Updated

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

This integration focuses on synchronizing data between OnePlan and Azure DevOps. Multiple nested Work Item Types in Azure DevOps will be imported into OnePlan as hierarchical plans. Any other Work Item Types will be brought into OnePlans’ Work Plan – Backlog section as tasks.

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

Note

To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan.

  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.

Picture1.png

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
        ADOINtegration_ADOTokenInfo.png

    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

Note

To complete the OneConnect setup, you need have Administrator or Editor privileges in the OneConnect group you wish to set the integration up in.

  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.

    ADO_Plan_Hierarchy_Integration_Select.png

  3. Complete the configuration form.

    1. Complete the OnePlan section:

      Note

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

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

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

      • (Optional) Alternate OnePlan Environment URL: If using an alternative environment than https://my.oneplan.ai, please enter the appropriate URL here.

        Note

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

      • (Optional) Button Name: If connecting multiple Azure DevOps organizations to a single OnePlan group, use this field to create a custom name for the Azure DevOps button connecting to the listed Azure DevOps organization.

      ADO_Epics-_OnePlan_Configuration_Section.png

    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.

        ADO_Epics-_ADO_Configuration_Section_1.png

      • Azure DevOps Plan Level Type: Enter multiple Azure DevOps work item types that will be brought into OnePlan as Plan level items. Please note that the listed work item types must be nested (i.e., Epics is the parent, Feature is the child to the Epic).

        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.

        ADO_Epics-_ADO_Configuration_Section_2.png

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

OnePlan Changes After the Integration is Complete

Once the integration is complete, three things will occur in the OnePlan integration page:

  • An integration line item is made.

  • An integration event is created.

  • Azure DevOps is now available in the Connected Systems icon.

Integration Line Item

Each item within the Integration section shows the OneConnect integrations connected to the OnePlan Work Plan.

ADO_Plan_Hierarchy_Integration_Line_Item.png

Integration Event

Integration events are automated responses that will bring data over from OnePlan into Azure DevOps. What this event does is trigger the OnePlanPublish strategy for any item that is connected to Azure DevOps. This will bring any values that are mapped to go from OnePlan to Azure DevOps to be updated.

What triggers this event is after a connected item has been saved in OnePlan. At the plan details page, this occurs after an item has been modified and then is automatically saved. At the backlog level, this is done after editing a field, and then clicking Save.

Connected Systems

Any item that is connected to Azure DevOps will show the Azure DevOps icon at both the My Portfolio page, and for any item in the Work Plan Backlog page for plans and tasks that are connected to Azure DevOps.

To connect an item from OnePlan into Azure DevOps, navigate to the Work Plan - Backlog page, click on the plug icon (Connected Systems Icon) and select the options of connecting to an existing item within Azure DevOps, or creating a new item. Once the plan is connected, the Connected Systems window can also be used to Import, Export, or Open the Azure DevOps Plan level item.

Related articles

Comments

0 comments

Article is closed for comments.