Skip to main content

Azure DevOps Integration - Integration Setup

© 2024 OnePlan Solutions. All Rights Reserved.
Download Article

Azure DevOps Integration - Integration Setup

  • Updated

This integration aims to synchronize data between OnePlan and Azure DevOps. In Azure DevOps, multiple nested work item types will be imported into OnePlan as hierarchical plans.

Additionally, various listed work item types from Azure DevOps will populate OnePlan's Work Plan - Backlogs section, appearing as individual tasks. This arrangement allows for detailed task management within OnePlan.

OnePlan

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

  • the group name

  • an authentication key

  • the authentication key name

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

  1. Log into your OnePlan group using your OnePlan login credentials.

  2. Access the Admin pages by clicking on the settings (gear) icon at the top right of the browser.

  3. Navigate to the Integration section in the left-hand navigation panel.

  4. Next to the Authentication Keys section click the + Add Key button.

  5. Provide a descriptive name or title for the Authentication Key to denote its purpose, then click ADD.

  6. Store the OnePlan group name and the Authentication Key securely. This grants access to your OnePlan group for any program. Please note that the key will no longer be visible after the page is refreshed.

Note: It's recommended to generate a new authentication key for every integration and assign a descriptive name to each key, enabling clear association with its corresponding integration. This practice enhances security, simplifies management, and facilitates easier tracking and troubleshooting. 

2024 Authentication Key Img.png

Azure DevOps

There are several ways to connect to Azure DevOps. Please review this article before you make a decision.

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

  • the Azure DevOps URL

  • a Personal Access Token (PAT) (in case you want to use that)

    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. Log into Azure DevOps.

    2. Navigate to User Settings > Personal Access Tokens.
    3. Click on the + New Token button.
    4. Give the token a Title (e.g., OneConnect Integration).
    5. Select the Organization that will be accessed by this token.
    6. Select an expiration date for the Token (tokens can be valid for up to 1 year, please keep this in mind for renewing your Azure DevOps token in the future).
    7. In Scopes, select Full Access.
    8. Click Create.

      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. Alternatively, you can connect using an Entra service principal. Click here to get help with that.

OneConnect Setup Process

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 (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).

  2. Navigate to OnePlan Plans and Azure DevOps. Click Configure.

OnePlan Connector

  1. Group Name
    • Input the name of the OnePlan Group name you intend to integrate with.
  2. Authentication Key
    • Paste the generated OnePlan Authentication Key obtained from OnePlan.
  3. Additional Options
    • Expand the section for additional configuration options.
  4. (Optional) Alternate OnePlan Environment URL
  5. (Optional) Button Name
    • If integrating multiple Azure DevOps organizations with a single OnePlan group, customize the name for the Azure DevOps button linked to the listed Azure DevOps organization
  6. (Optional - Checkbox) Sync to Schedule
    • Unchecked: All listed work item types from Azure DevOps will be imported into the OnePlan Backlog.
    • Checked (Default): Allows users to manually bring in work item types from Azure DevOps to enter the OnePlan Schedule. For more information on this functionality, please review the Sync to Schedule functionality. 
  7. Test Connection
    • Click Test to verify the correctness of the connection settings to OnePlan.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
  8. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

Azure DevOps Connector

  1. Azure DevOps URL
    • Enter the URL of your Azure DevOps organization (e.g., https://dev.azure.com/{OrganizationName}).
  2. Personal Access Token (PAT)
    • Input the PAT associated with the Azure DevOps organization intended for integration with OnePlan.
  3. Additional Options
    • Expand the section for additional configuration options.
  4. Azure DevOps Plan Level Type
    • Specify multiple Azure DevOps work item types to be imported into OnePlan as Plan level items. Ensure that the listed work item types follow a nested structure (e.g., Epics as the parent, Feature as the child to the Epic).
    • Note: It's crucial that the hierarchy format matches the arrangement in the Azure DevOps Boards: Backlogs section. If the order differs, the work items won't be imported. 
  5. Azure DevOps Work Item Type
    • Enter the desired work item type(s) from Azure DevOps intended to be imported into OnePlan as Work Plan – Backlog items.
  6. (Optional) Bring in Tasks & Bugs that are not in an iteration/sprint
    • Unchecked : Tasks and Bugs within a sprint will be imported.
    • Checked (Default): All work items, even those not assigned to a sprint, will be imported.
  7. (Optional) Allow creation of backlog items in OnePlan and have those backlog items be brought into Azure DevOps
    • Unchecked: When unchecked, users in OnePlan will be unable to:
      • Export changes made on tasks in OnePlan back into Azure DevOps.
      • Export newly created items in OnePlan to Azure DevOps. 
    • Checked (Default): Allows users to create additional item in the OnePlan Work Plan, and export those items to Azure DevOps. 
  8. (Optional) If you are using an Entra service principle to connect to Azure DevOps
    • Click here to learn more about the prerequisites. 
    • Expand the section called Advanced Options
    • Check the "Use a Service Principal to connect to Azure DevOps" checkbox.
    • If you are using the default OnePlan App to connect to DevOps, then click the Authorize button. (you must be a tenant administrator to do that)
    • If you are using your own app registration, then fill out the Client ID and Client Secret fields.
  9. Test Connection
    • Click Test to verify the correctness of the connection settings to OnePlan.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
  10. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

Related articles

Comments

0 comments

Please sign in to leave a comment.