Azure DevOps Setup

Updated 7 months ago by Copado Solutions

Copado’s integration with Azure DevOps allows you to work on your user stories by easily creating a project and importing your work items to the project in Copado. Let’s see how you can set up this integration and start leveraging Copado and Azure DevOps.

Setup Requirements

In order to get the integration up and running, you need to make the following configurations:

  1. Install the Copado Change Management Integrations package.
  2. Create a named credential.
  3. Create a Copado Integration Setting record.
  4. Customize the Project object’s layout.
  5. Update your project in Copado or create a new one if there is none.
Installing the Copado Change Management Integrations Package

The first thing you need to do is install the Copado Change Management Integrations package.

You can choose to install the package for admins only (recommended option) or for specific profiles.

Creating the Named Credential

Once the package has been successfully installed, the next step will be to create a named credential. A named credential specifies the callout endpoint's URL and the authentication settings that are required for Salesforce to make callouts to the remote system. 

To create the named credential, follow the steps below:

  1. Go to Setup > Named Credentials.
  2. Click on New Named Credential.
  3. Type in a label for your named credential and insert the URL. The accepted Azure DevOps URL is “[OrganizationName]/”. Taking Copado Academy as organization name, the URL would look like this:
If you configured the integration before VSTS was rebranded as Azure DevOps, the old URL endpoint “https://[CompanyName]” is still valid.
  1. Choose Named Principal as Identity Type.
  2. Select Password Authentication as Authentication Protocol.
  3. Enter your username and the Azure DevOps API token. If you don’t have an API token yet, follow these steps to create one:
    1. Sign in to your organization in Azure DevOps using “[CompanyName]”.
    2. Go to your profile and select Security
    3. Click on New Token
    4. Give your token a name and set an expiration date.
  4. Make sure the Generate Authentication Header checkbox is enabled and click on Save:

Creating the Copado Integration Setting Record

Now that you have the named credential, you need to create a Copado Integration Setting record to link the named credential with the project where you would like to import your work items.

  1. Navigate to the Copado Integration Setting tab and click on New.
  2. Give the setting a name.
  3. In the External System field, select Visual Studio Team Services.
  4. In the Named Credential field, type in exactly the same name (API name) you used for the named credential.
  5. Click on Save:

Customizing the Project Layout

In order for you to be able to make the necessary changes to the project, you will need to add a few elements to the project layout.

  1. Go to Setup > Object Manager > Project.
  2. Click on Page Layouts and then on Project Layout.
  3. Add the following fields to the layout:
  • Workspace Id
  • Project External Id
  • Copado Integration Setting
  • Enable Logs
  1. Add the Sync External User Stories button. This button will be used to fetch and import Azure items on demand. 
  2. Add the following related lists:
  • Field Mappings. Click on the wrench icon in the related list to open the related list properties and include the fields as related list’s columns:
    • Field Mapping Name
    • Salesforce Field Name
    • Third Party Field Name
    • Exclude from Salesforce update
    • Exclude from Third Party update
    • Created by
    • Last Modified by
  • Callout Logs
Updating an Existing Project or Creating a New One

Finally, it is time to define the project information.

  1. Navigate to the project where you want to import your Azure DevOps work items. If you have not created a project yet, follow the instructions in the article Project Overview and Setup to create a new one.
  2. In the Copado Integration Setting lookup, find the setting you have previously created.
  3. Populate the Project Id from Azure DevOps. This will be the name of the project as shown in Project details in Azure.
  4. Enter the Workspace Id from Azure DevOps.
  5. Build a query that suits your needs.
  6. Click on Run Query to test it and then on Save Query if you are happy with the result.
  7. Give your query a name and select a folder to store it. Then, click on OK:

How did we do?