Azure DevOps Integration (via Microsoft Power Automate) - Create Bug and Task Work Items


About This Integration

IntegrationIntroduction

You can integrate third-party systems with Product name - ev itsm.png in many ways. The method you select will depend on business requirements, architectural and security constraints as well as the characteristics specific to each third-party application or service.

This document describes an integration process that has already been implemented in a customer context. 

To find out more about this integration (e.g. scripts to be used), please contact the Logo - EasyVista.png Consulting & Professional Services team, the Logo - EasyVista.png Support team, or your service provider and integrator.
 

Overview of the integration

Azure DevOps is a Microsoft solution. It is a management tool for DevOps projects that ensures monitoring for tasks, deadlines, problems and calendars relating to applications.

This integration enables you to create two work items, Bug and Task in Azure DevOps when a ticket is created in Service Manager, via Microsoft Power Automate.

  • The number of the Bug work item is saved in the Service Manager ticket.
  • The Task work item is associated with the Bug work item.
      

Preview of the tools used in this integration

  • Microsoft Power Automate (formerly known as Microsoft Flow) enables you to automate recurrent tasks by building workflows using Web applications. These applications use MS Power Automate connectors (based on Microsoft Azure Logic Apps) or the MS Graph gateway for interfacing with any endpoint via HTTP/HTTPS.
     
Integration Data Feed (direction) Authentication Type Integration Connector Options

Logo - EV Service Manager.png

Down arrow.png

Logo Icon - Microsoft Flow.png

Down arrow.png

Logo Icon - Azure DevOps.png

Down arrow.png

Logo Icon - Microsoft Flow.png

Down arrow.png

Logo - EV Service Manager.png

  • Depending on the third-party service used (authentication managed by Logic Apps)
  • Basic Authentication for the Service Manager REST API
  • Service Manager:

    EV Integration connector icon - Workflow.png    Workflows

    EV Integration connector icon - Business rule.png    Business rules

  • MS Power Automate:

    EV Integration connector icon - Receive.png    Connector: When a HTTP request is received

    (Service Manager trigger => Logic Apps)

Available versions
SaaS-based On-premises
Service Manager Check icon.png Check icon.png
Third-Party Product Check icon.png N/A

Azure DevOps - definitions

Definitions_AzureDevOps
  • Azure DevOps is a Microsoft solution. It is a management tool for DevOps projects that ensures monitoring for tasks, deadlines, problems and calendars relating to applications.
  • Work items are used to monitor functionalities and specifications, code errors, bugs, etc.
  • Each work item is based on a work item type and has a unique ID.
  • The work item types available are based on the processes used when creating projects, e.g. agile, scrum, etc. They can be configured differently by each team.
    • The Bug work item type is used for tracking bugs.
    • The Task work item type is used for monitoring activity and tasks.
  • Work items can be assigned to other work items according to a hierarchy based on parent-child relationships.

Microsoft Power Automate flows

The integration between Service Manager and Azure DevOps will trigger a flow in Microsoft Power Automate when a ticket is created in Service Manager.

==> Create Bug and Task work items in Azure DevOps flow
         Data feed diagram 1 - EN.png

Prerequisites

  • You must ask EasyVista to create two fields in the SD_REQUEST table which will be specific to Azure DevOps and GitHub.
  • You must create the Bug and Task work items in Azure DevOps for the process template used by your DevOps project. Open url.png See the procedure.
  • You must create two custom fields for the Bug work item to store the Service Manager ticket references. Open url.png See the procedure.

Best Practice

BestPractice
  • The procedure describes all of the steps for creating Microsoft Power Automate flows. To facilitate integration, the ZIP folders shipped with this integration contain pre-configured flows. Once you have downloaded them, you should specify the parameters specific to your environment, i.e. Azure account credentials, EasyVista server address, credentials of your Service Manager platform, etc.
  • Use the search field to find the connectors and actions to be created in the MS Power Automate workflow easily.

    example  Find the actions for the Azure DevOps connector

    Microsoft Power Automate - Best Practice search connector.png

Caution

Caution_TitleActionInPowerAutomateFlow
  • When you create workflow actions in Microsoft Power Automate, you must rename them as indicated in the procedure. This is because certain items of information in the name refer to the title of the action. If you do not respect the naming convention, the workflow will not be triggered correctly.

    example  The {outputs('Create_a_Work_Item_(Bug)')?['body/id']} instruction refers to the action called Create a Work Item (Bug)

    Note: Spaces in the title will automatically be replaced by the underscore _

Integration process

 Prerequisite  Ask EasyVista to create two fields in the SD_REQUEST table which will be specific to Azure DevOps and GitHub. Add them to the ticket form. Open url.png See the detailed procedure.

1. Create the Bug and Task work items in Azure DevOps for the process template used by your DevOps project. Open url.png See the detailed procedure.

2. Create the two custom fields for the Bug work item to store the Service Manager ticket references. Open url.png See the detailed procedure.

3. Create the MS Power Automate flow. Open url.png See the step-by-step integration process.

  • Note: This requires a connection to Azure DevOps.

Best Practice icon.png  Import the preconfigured flow below containing all of the steps to MS Power Automate. Open url.png See the procedure for importing flows.
        Download icon.png  Flow Create Bug and Task work items in Azure DevOps

Step-by-Step Integration Process


AddDevOpsFieldsInTicketForm_Procedure

Add fields specific to Azure DevOps and GitHub to the SD_REQUEST table

Step 1: Ask EasyVista to add fields to the database

1. Ask EasyVista to add the following two fields.

  • Field called E_ADO_NUMBER, nvarchar data type, size 20. This will store the ID of the Azure DevOps work item associated with the Service Manager ticket.
  • Field called E_PR_NUMBER, nvarchar data type, size 20. This will store the number of the GitHub pull request associated with the Service Manager ticket.
     

Step 2: Add fields to the Ticket forms, i.e. Incident and Request forms

     Open url.png See the detailed procedure

1. Open each Ticket form, i.e. Incident and Request forms.

2. Click Browse grey points icon.png in the top banner and select Edit Form.
The main form presentation will appear.

3. Select and place the two fields in the form.

4. Click Save and click Save and Close.

The form will be refreshed.
         Add fields DevOps in ticket form.png

Create the Bug and Task work items

Caution: Make sure you create the work items in the process template or in the process used by your DevOps project.

CreateBugWorkItemType_Procedure

Step 1: Log in to Azure DevOps

1. Log in to Azure DevOps using your Azure account credentials.

2. Click the name of your organization.

3. Click Organization settings.

          Azure DevOps - Open.png
 

Step 2: Create the Bug work item type

1. Select Boards > Process in the menu pane.
The list of DevOps processes will appear.
         Azure DevOps - Open processes.png

2. Select the DevOps project in which you want to monitor tickets created in Service Manager.
The list of work item types defined for the project processes will appear.
         Azure DevOps - Work item types.png

3. Click + New work item type.

4. Specify the information on the new work item type and name it Bug.
         Azure DevOps - Work item types - Creation.png

5. Click Create.
The properties of the new work item type will appear.

Step 3: Create the Task work item type

1. Click + New work item type.

2. Specify the information on the new work item type and name it Task.

3. Click Create.
The properties of the new work item type will appear.


Step 4: Create two custom fields to store the Service Manager ticket references

CreateEZVFieldsForBugWorkItem_Procedure

1. Select the Bug work item type.

2. Click New field.

          Azure DevOps - Work item types - Creation EZV fields.png

3. Specify the information on storing the ticket ID in the new field and name it EZV_ID.
         Azure DevOps - Work item types - Creation EZV fields - Add field.png

4. Click Add field.
The new field will be associated with the Bug work item type in the Custom section.
         Azure DevOps - Work item types - Creation EZV fields - Detail.png

5. Repeat the procedure to create the second field for storing the ticket URI and name it EZV_URI.

Import the workflow to Microsoft Power Automate

Note: This requires a connection to Azure DevOps.

Step 1: Download the flow

1. Download the file below to your workstation.

      Download icon.png  Flow Create Bug and Task work items in Azure DevOps

ImportFlowInMicrosoftPowerAutomate_Procedure

Step 2: Import the flow to Microsoft Power Automate 

1. Log in to the Microsoft Power Automate website using your account credentials.

2. Click My flows in the left pane.
A list of your MS Power Automate flows will appear.
         Microsoft Power Automate - Import flow - Flow list.png

3. Click Import in the menu bar and select the file you downloaded.

  • Once imported, the package contents will appear.
  • The Red nok icon.png icon indicates that the connection for the resource was not found.
    Microsoft Power Automate - Import flow - Package content.png
     

Step 3: Create the connections required for the flow

1. Click the Select during import link in the Import Setup column for the relevant resource.
         Microsoft Power Automate - Import flow - Import setup link.png

The window for configuring the import will appear.
         Microsoft Power Automate - Import flow - Import setup window.png

2. Create a new connection for the resource or select an existing connection.

There is an existing connection for the resource

  • Select the connection.
  • Click Save.

    Microsoft Power Automate - Import flow - Import setup - Select existing connection.png

There is no existing connection for the resource

  • Click + Create.

    Microsoft Power Automate - Import flow - Import setup - Create connection.png

    • An MS Power Automate instance will appear in a new Web browser tab.
    • The list of existing connections will appear.
               Microsoft Power Automate - Import flow - Import setup - Create connection 2.png
  • Click + New connection.
  • Find the connection you want using the search field and select it from the list.

example  Find the GitHub connection

Microsoft Power Automate - Import flow - Import setup - Create connection 3.png

A window displaying the list of permissions to be granted to Microsoft Power Platform will appear.

  • Click Create to create the new connection.
  • Click Accept to accept the conditions and authorize Microsoft Power Platform access.
    • You will return to the tab displaying the list of MS Power Automate flows.
    • The new connection for the resource will appear in the list.

example  New GitHub connection

Microsoft Power Automate - Import flow - Import setup - New connection added.png

  • Close your Web browser tab.
    You will return to the tab displaying the details of the imported package.
  • Click Refresh List.
    The new connection for the resource will appear in the window for configuring the import.
             Microsoft Power Automate - Import flow - Import setup - Refresh list.png
  • Select the connection and click Save.
    The Black cross icon.png icon indicates that the connection for the resource has been correctly established.
             Microsoft Power Automate - Import flow - Import setup - New connection ok.png

3. Repeat the procedure for each connection required for the flow.
 

Step 3: Import package resources

1. Click Import.

          Microsoft Power Automate - Import flow - Button.png

The Green ok icon.png icon next to each package resource indicates that the flow has been correctly imported.
         Microsoft Power Automate - Import flow - Ok.png

Step 4: Configure package resources

Note: You should perform this step if a message at the top of the page informs you that package resources must be configured.

1. Click Save as new flow in the message displayed at the top of the page.

         Microsoft Power Automate - Import flow with error - Save as new flow.png

  • An MS Power Automate instance will appear in a new Web browser tab.
  • The workflow of the imported package will appear.
             Microsoft Power Automate - Import flow with error - Invalid connection.png

2. Click the action indicating an invalid connection.
The list of all existing connections for the selected type of resource will appear.
         Microsoft Power Automate - Import flow with error - Invalid connection - Select connection.png

2. Click the connection defined for the type of resource.

The properties of the action will appear. The properties displayed depend on the type of resource.

example  Unspecified properties for an action using the Azure DevOps resource

Microsoft Power Automate - Import flow with error - Invalid connection - Configure connection.png

3. Specify the connection information for the action.

example  Properties for an action using the Azure DevOps resource

  • Organization Name: Select the name of your organization.
  • Project Name: Select the name of your DevOps project.

4. Repeat the procedure for each action indicating an invalid connection.

5. Click Save.

  • The error message for the action will disappear.

example  Action for the Azure DevOps resource

Microsoft Power Automate - Import flow with error - Invalid connection - Configure connection ok.png

  • You have configured all of the connections required for the flow.
  • The workflow will be created.
             Microsoft Power Automate - Import flow - Success.png
     

Step 5:  Configure the workflow

1. Move your cursor over the name of the flow and click Edit icon.png.
         Microsoft Power Automate - Open flow.png

The workflow will appear.
         Microsoft Power Automate - Detail flow.png

2. See the procedure for configuring the imported flow.

Create the MS Power Automate flow

Description of the Create Bug and Task work items in Azure DevOps workflow

Azure flow description - Creation Azure DevOps work items.png
  • Step 1: Create the step that will trigger the flow
  • Step 2: Create a Bug work item containing the Service Manager ticket references
  • Step 3: Create a Task work item in Azure DevOps containing the Service Manager ticket references
  • Step 4: Associate the Task work item with the Bug work item
  • Step 5: Store the Bug work item ID in the Service Manager ticket
  • Step 6: Save the configuration of the workflow


Step 1: Create the step that will trigger the flow

==> The flow is triggered when a ticket is created in Service Manager.

1. Create a When a HTTP request is received step that will trigger the workflow.

Microsoft Power Automate - Trigger - When a http request is received.png
  • Specify the information on the trigger.
    • Body: Copy and paste the JSON schema below.

      Display the JSON schema

      {
         "$id": "http://example.com/example.json",
         "type": "object",
         "definitions": {},
         "$schema": "http://json-schema.org/draft-07/schema",
         "properties": {
             "Description": {
                 "$id": "/properties/Description",
                 "type": "string",
                 "title": "Description",
                 "default": "",
                 "examples": [
                     "{Description}"
                  ]
              },
             "id": {
                 "$id": "/properties/id",
                 "type": "string",
                 "title": "Id",
                 "default": "",
                 "examples": [
                     "{id}"
                  ]
              },
             "Host": {
                 "$id": "/properties/Host",
                 "type": "string",
                 "title": "Host",
                 "default": "",
                 "examples": [
                     "{Host}"
                  ]
              },
             "Account": {
                 "$id": "/properties/Account",
                 "type": "string",
                 "title": "Account",
                 "default": "",
                 "examples": [
                     "{Account}"
                  ]
              },
             "URL": {
                 "$id": "/properties/URL",
                 "type": "string",
                 "title": "URL",
                 "default": "",
                 "examples": [
                     "{URL}"
                  ]
              },
             "Title": {
                 "$id": "/properties/Title",
                 "type": "string",
                 "title": "Title",
                 "default": "",
                 "examples": [
                     "{Title}"
                  ]
              },
             "Priorite": {
                 "$id": "/properties/Priorite",
                 "type": "string",
                 "title": "Priorite",
                 "default": "",
                 "examples": [
                     "{Priorite}"
                  ]
              }
          }
      }
    • Method: Select the POST value.
  • Save the trigger.

    The following information will be retrieved from Service Manager: Ticket description, ticket ID, Host, Account, URL, title of the ticket, priority level.


Step 2: Create a Bug work item containing the Service Manager ticket references

1. Create a Create a work item action (Azure DevOps  connector).

Microsoft Power Automate - Action - Create a work item Azure DevOps.png
  • Rename it Create a Work Item (Bug) using Browse black points icon.png in the title bar.
  • Specify the information on the action.
    • Organization Name: Name of your organization.
    • Project Name: Name of your DevOps project.
    • Work Item Type: Select Bug.
    • Title: Enter the following value.
      concat(triggerBody()?['id'],' ',triggerBody()?['Priorite'],' ',triggerBody()?['Title'])
    • Description: Description of the Service Manager ticket. Select the dynamic value called Description from the When a HTTP request is received step.


Step 3: Create a Task work item in Azure DevOps containing the Service Manager ticket references

1. Create a Create a work item action (Azure DevOps  connector).

Microsoft Power Automate - Action - Create a work item Azure DevOps.png
  • Rename it Create a Work Item (Task) using Browse black points icon.png in the title bar.
  • Specify the information on the action.
    • Organization Name: Name of your organization.
    • Project Name: Name of your DevOps project.
    • Work Item Type: Select Task.
    • Title: Enter the following value.
      concat(triggerBody()?['id'],' ',triggerBody()?['Priorite'],' ',triggerBody()?['Title'])
    • Description: Description of the Service Manager ticket. Select the dynamic value called Description from the When a HTTP request is received step.


Step 4: Associate the Task work item with the Bug work item

1. Create an Update a work item action (Azure DevOps  connector).

Microsoft Power Automate - Action - Update a work item Azure DevOps.png
  • Specify the information on the action.
    • Organization Name: Name of your organization.
    • Work Item ID: ID of the Task work item. Select the dynamic value called ID from the Create a work item (Task) step.
    • Work Item Type: Select Bug.

    • Advanced options:
      • Link URL: Enter the URL of the Bug work item in the following format. Replace the values highlighted in yellow with the values of your environment.
        https://dev.azure.com/{your_organization}/{your_project}/_apis/wit/workItems/@{outputs('Create_a_Work_Item_(Bug)')?['body/id']}
      • Link Type: Select the Hierarchy-reverse value.


Step 5: Store the Bug work item ID in the Service Manager ticket

1. Create a HTTP action to update the Service Manager ticket.

Microsoft Power Automate - Action - HTTP Put.png
  • Rename it Update Ticket using Browse black points icon.png in the title bar.
  • Specify the information on the action.* Method: Enter the PUT value.
    • URI: Enter the URL below.
      concat(triggerBody()?['URL'],'requests/',triggerBody()?['id'])
    • Body: Copy and paste the JSON schema below.
      { "E_ADO_NUMBER": "@{outputs('Create_a_Work_Item_(Bug)')?['body/id']}" }
    • Advanced options:
      • Authentication: Select the Basic value.
      • Username: Service Manager platform account.
      • Password: Password of the Service Manager platform account.


Step 6: Save the configuration of the workflow

1. Click Save at the bottom of the flow.

        Azure flow - Save configuration.png

Links to other integrations

List of files to download

Note: To find out more, see the step-by-step integration process.

      Download icon.png  Flow Create Bug and Task work items in Azure DevOps

Tags:

Shortcuts

Powered by XWiki © EasyVista 2022