GitHub Integration (via Microsoft Power Automate) - Close a Service Manager Ticket Linked to a Pull Request

Last modified on 2023/11/21 17:02
Contents

IntegrationIntroduction

You can integrate third-party systems with Service Manager 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 do not hesitate to contact your EasyVista contact, or your service provider and integrator.

Overview of the integration

GitHub is an online service that hosts websites and source code files, and provides distributed version control using Git. It is also a collaborative space where each user can contribute content to online public projects.

This integration enables you to check if the pull request associated with a Service Manager ticket is merged when the ticket is closed, via Microsoft Power Automate.

  • A notification email is sent to the user in charge of the pull request if it is not merged.
  • A direct link to the pull request in GitHub is added.

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 Icon - GitHub.png

Down arrow.png

Logo Icon - Microsoft Flow.png

Down arrow.png

Favicon EasyVista - 32.png Service Manager
  • 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

GitHub - definitions

Definitions_GitHub
  • GitHub is an online service that hosts websites and source code files, and provides distributed version control using Git. It is also a collaborative space where each user can contribute content to online public projects.
  • Git is a distributed version control system for tracking project changes and saving them in different versions, thus enabling you to revert back to an older version at any time.
  • In Git, the copy of all project files and versions is called a repository. This is a storage space on the centralized GitHub server that contains each source code.
  • Issues are created to initiate discussions among developers, bug reports, proposed developments, etc.
  • A pull request is a procedure that enables an external contributor to propose changes to the original code (request), integrate feedback and resubmit them (pull).
  • A review is used to evaluate, comment and validate the changed code in the pull request. Once code changes are approved by the review, the pull request is merged with the original version.

Microsoft Power Automate flows

The integration between Service Manager and GitHub will trigger a flow in Microsoft Power Automate when a Service Manager ticket associated with a pull request is closed.

==> Close a ticket 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.

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 Send email action for the Office 365 Outlook 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 split(body('Analyze_Ticket_Info')'')?['AVAILABLE_FIELD_6'],',') instruction refers to the action called Analyze Ticket Info

   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.

In Azure DevOps

1. Create the MS Power Automate flow that will be triggered when a Service Manager ticket is closed. Open url.png See the detailed procedure.

   This requires a connection to GitHub and to Office 365 Outlook.

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.

   Flow Close a Service Manager ticket associated with a pull request

In Service Manager

2. Create a dedicated resource called Merge Pull Request used in a REST step of a process. Open url.png See the detailed procedure.

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

Import the workflow to Microsoft Power Automate

   This requires a connection to GitHub and to Office 365 Outlook.

Step 1: Download the flow

1. Download the file below to your workstation.

   Flow Close a Service Manager ticket associated with a pull request

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 4: 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 5: Configure package resources

   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 6:  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 Close a Service Manager ticket associated with a pull request workflow

Azure flow description - Close Service Manager ticket linked to a pull request.png
  • Step 1: Create the step that will trigger the flow
  • Step 2: Retrieve the Service Manager ticket
  • Step 3: Find the merge date of the pull request when the Service Manager ticket is associated with a pull request
    • Step 3.a: Define a condition to check if there is a pull request number in the Service Manager ticket
    • Step 3.b: Define a condition to check if there is a merge date for the pull request
  • Step 4: Send a notification email to the user in charge of the pull request if it is not merged
  • Step 5: Save the configuration of the workflow


Step 1: Create the step that will trigger the flow

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

1. Create a When a HTTP request is received action to trigger the workflow (Triggers).

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: Retrieve the Service Manager ticket

          Action Azure - Get info ticket.png

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

Microsoft Power Automate - Action - HTTP Get.png
  • Rename it HTTP Get Info Ticket using Browse black points icon.png in the title bar.
  • Specify the information on the action.
    • Method: Enter the GET value.
    • URI: Enter the following expression.
      concat(triggerBody()?['URL'],'requests/',triggerBody()?['id'])

2. Create a JSON Analysis action to retrieve information on the Service Manager ticket.

Microsoft Power Automate - Action - Parse JSON.png
  • Rename it Parse JSON Get Group ID using Browse black points icon.png in the title bar.
  • Specify the information on the action.
    • Contents: Select the dynamic variable called Body from the HTTP Get a comment step.
    • Schema: Copy and paste the JSON schema below.

      Display the JSON schema

      {
         "type": "array",
         "items": {
             "type": "object",
             "properties": {
                 "id": {
                     "type": "integer"
                  },
                 "node_id": {
                     "type": "string"
                  },
                 "user": {
                     "type": "object",
                     "properties": {
                         "login": {
                             "type": "string"
                          },
                         "id": {
                             "type": "integer"
                          },
                         "node_id": {
                             "type": "string"
                          },
                         "avatar_url": {
                             "type": "string"
                          },
                         "gravatar_id": {
                             "type": "string"
                          },
                         "url": {
                             "type": "string"
                          },
                         "html_url": {
                             "type": "string"
                          },
                         "followers_url": {
                             "type": "string"
                          },
                         "following_url": {
                             "type": "string"
                          },
                         "gists_url": {
                             "type": "string"
                          },
                         "starred_url": {
                             "type": "string"
                          },
                         "subscriptions_url": {
                             "type": "string"
                          },
                         "organizations_url": {
                             "type": "string"
                          },
                         "repos_url": {
                             "type": "string"
                          },
                         "events_url": {
                             "type": "string"
                          },
                         "received_events_url": {
                             "type": "string"
                          },
                         "type": {
                             "type": "string"
                          },
                         "site_admin": {
                             "type": "boolean"
                          }
                      }
                  },
                 "body": {
                     "type": "string"
                  },
                 "state": {
                     "type": "string"
                  },
                 "html_url": {
                     "type": "string"
                  },
                 "pull_request_url": {
                     "type": "string"
                  },
                 "author_association": {
                     "type": "string"
                  },
                 "_links": {
                     "type": "object",
                     "properties": {
                         "html": {
                             "type": "object",
                             "properties": {
                                 "href": {
                                     "type": "string"
                                  }
                              }
                          },
                         "pull_request": {
                             "type": "object",
                             "properties": {
                                 "href": {
                                     "type": "string"
                                  }
                              }
                          }
                      }
                  },
                 "submitted_at": {
                     "type": "string"
                  },
                 "commit_id": {
                     "type": "string"
                  }
              },
             "required": [
                 "id",
                 "node_id",
                 "user",
                 "body",
                 "state",
                 "html_url",
                 "pull_request_url",
                 "author_association",
                 "_links",
                 "submitted_at",
                 "commit_id"
              ]
          }
      }


Step 3: Find the merge date of the pull request when the Service Manager ticket is associated with a pull request


Step 3.a: Define a condition to check if there is a pull request associated with the Service Manager ticket

3. Create a Condition action to check if there is a pull request number in the Service Manager ticket.

Action Azure - Get Service Manager ticket - Condition If there is a PR - Line condition.png
  • Rename it Condition if there is a PR using Browse black points icon.png in the title bar.
  • Click Add to add the following lines to the condition.
ticket
Value tested Condition line
E_PR_NUMBER field specified in the Service Manager
  • Select Value: Enter the instruction below.
    @body('Parse_JSON_Get_Info_Ticket')?['E_PR_NUMBER']
  • Comparator: Select is not equal to.
  • Value: Select the "" value.

3. Define the actions to be performed when the pull request number is specified (condition for the Condition if there is a PR action).

  • Go to the If Yes branch.
  • Add the actions from step 3.b by selecting Add an action.


Step 3.b: Define a condition to check if there is a merge date for the pull request

          Action Azure - Condition If there is a PR - Yes branch.png

1. Create a Get a Pull Request action to read the pull request number stored in the E_PR_NUMBER field.

Action Azure - Condition If there is a PR - Yes branch - Get a PR.png
  • Specify the information on the action.
    • Repository Owner: Name of the owner of the GitHub folder.
    • Repository Name: Name of the GitHub folder.
    • Pull Number: Enter the following expression.
      @{body('Parse_JSON_Get_Info_Ticket')?['E_PR_NUMBER']}

2. Create a Condition action to check if there is a merge date for the pull request.

Action Azure - Condition If there is a PR - Yes branch - Condition PR is merged - Line condition.png
  • Rename it Condition PR is merged using Browse black points icon.png in the title bar.
  • Click Add to add the following lines to the condition.
Value tested Condition line
Merge date unspecified
  • Select Value: Enter the instruction below.
    @outputs('Get_a_pull_request')?['body/merged']
  • Comparator: Select is equal to.
  • Value: Select the false value.

3. Define the actions to be performed when the merge date of the pull request is unspecified (condition for the Condition PR is merged action).

  • Go to the If Yes branch.
  • Add the actions from step 4 by selecting Add an action.


Step 4: Send a notification email to the user in charge of the pull request if it is not merged

1. Create a Send an email (V2) action (Office 365 Outlook connector) to create an email.

Action Azure - Condition If there is a PR - Yes branch - Condition PR is merged - Yes branch.png
  • Rename it HTTP Get Group ID using Browse black points icon.png in the title bar.
  • Specify the information on the action.* To: Specify the recipient of the notification email. Caution: Avoid specifying a group email address to ensure that these emails are sent only to the relevant users.
    • Subject: Enter the subject of the notification email.
      [Anomaly] Close action in SM: PR not merged
    • Body: Enter the text of the notification email.
      Hello, pull request @{outputs('Get_a_pull_request')?['body/number']} is not merged. Please merge it. @{outputs('Get_a_pull_request')?['body/html_url']}


Step 5: Save the configuration of the workflow

1. Click Save at the bottom of the flow.

          Azure flow - Save configuration.png

Service Manager: Create a dedicated resource used in a REST step of a process

Notes:

  • The dedicated resource called Merge Pull Request will enable to check if the pull request associated with a Service Manager ticket is merged when the ticket is closed.
  • It is associated with a Microsoft Power Automate service.
  • It is used in a Service Manager process using a REST action type.
CreateInServiceManagerRestResource_Procedure

Step 1: Manage rights for using the Service Manager REST API

1. Select Administration > Access Management > User Profiles in the menu.

2. Select a user profile authorized to use the Service Manager REST API.

3. Tick the REST API box.

Your changes will automatically be saved.

4. Repeat the procedure for all authorized profiles.

Step 2: Create a resource called Merge Pull Request associated with a Microsoft Power Automate service

        Open url.png See the detailed procedure.

Step 2.a: Create a service called Microsoft Power Automate

1. Select Administration > REST > Services in the menu.

2. Create a new service.

          New REST service - None authentication.png

3. Specify the information below.

  • Service Name: Enter the label Microsoft Power Automate.
  • Authentication Method: None.
  • Service URL: URL for accessing the new Microsoft Power Automate service.
    • Copy and paste the URL you stored in your text editor when creating the MS Power Automate flow (step that will trigger the flow).
    • You should keep only the text displayed in yellow below.

      https://prod-55.westeurope.logic.azure.com:443/workflows/a903f9140a874277be8b9dd39b5c4305/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=R-FJw5q_MEn-I-98MNF794bVtN91QIWFt8gixg-8

    • Replace prod-55.westeurope with {subdomain}.
       

Step 2.b: Create a connection to the Microsoft Power Automate service.

1. Create a new connection.

          New REST connection - None authentication.png

2. Specify the information below.

  • Connection Name: Enter the label GitHub.
  • Authentication Method: None.
  • Service Name: Select the Microsoft Power Automate service you created at step 2.a.
    The URL of the service will automatically appear.
  • subdomain: Copy and paste the prod-55.westeurope value of the URL you stored in your text editor.
     

Step 2.c: Create a resource associated with the Microsoft Power Automate service

1. Create a new resource.

          New REST resource - None authentication.png

2. Specify the information below.

  • Label: Enter the label Merge Pull Request.
  • Resource URI: ID of the new resource.
    • Copy and paste the URL you stored in your text editor when creating the MS Power Automate flow (step that will trigger the flow).
    • You should keep only the text displayed in yellow below.

      https://prod-55.westeurope.logic.azure.com:443/workflows/a903f9140a874277be8b9dd39b5c4305/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=R-FJw5q_MEn-I-98MNF794bVtN91QIWFt8gixg-8

  • Contents: Body of the query containing the data to be updated. Copy and paste the text below without inserting any spaces or line breaks.

   If you paste a JSON schema copied from a third-party editor such as Microsoft Word or Notepad++, invisible characters may be inserted. This will create an error in the processing of the REST step using the resource.

{"Description": "{Description}","id": "{id}","Host": "{sys.EVSM_HOST}","URL": "{sys.EVSM_REST_SERVICE_URL}","Account": "{sys.EVSM_ACCOUNT}","Title": "{Title}","Priorite": "{Priorite}"}

Step 3: Use the Merge Pull Request resource in a REST step of a process

1. Open the workflow or the business rule-related process you want.

  • Workflow: References > Other References > Workflows (Operation/Transition)
  • Business rule: Administration > Business Rules > Related Processes

2. Click and drag the new Merge Pull Request resource from the REST Actions category of the palette of action types to the graphic editor of the process.

A new step will be added to the process.

          New REST action in workflow - Add in GUI.png

3. Double-click to define the properties of the new step.

     Open url.png See the description

          New REST action in workflow - Properties.png

4. Click Confirm Changes.

Links to other integrations

List of files to download

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

Tags:
Powered by XWiki © EasyVista 2022