Microsoft Azure Logic Apps Integration

Last modified on 2022/11/08 13:22
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

Microsoft Azure Logic Apps enables you to create logic apps that run workflows and provide access to cloud data and services. The tool relies on a large ever growing ecosystem of standard connectors available for interfacing with any endpoint via HTTP/HTTPS.

example  Azure Active Directory, Office 365, Skype For Business, Teams, Jira Software, SAP, etc.

This integration enables you to perform actions in both Service Manager and a third-party service using a logic app. You can do this in two ways.

  •  Perform actions in a third-party service from a Service Manager workflow/business rule. Open url.png See Integration Process 1.

    example 

    • In Service Manager, approval of an onboarding request for a new employee via a HR workflow ==> Creation of a user in Microsoft Azure Active Directory with the relevant information, e.g. name, first name, title, department, etc. The user will be added to an AD group and a manager will be assigned.
    • In Service Manager, creation of an incident via a standard ticket management workflow or business rule ==>  Creation of a new incident in Jira Software.
    • In Service Manager, approval of an SAP-related change request via a change management workflow ==>  Creation of a new card in Trello, with the change request number as its name.
  • Perform actions in Service Manager from a third-party service. Open url.png See Integration Process 2.

    example  In Trello, creation of a new card for a new training course in the HR catalog ==>  Creation of a new New Training Analysis change request in Service Manager, with the description of the Trello card.

     
Integration Data Feed (direction) Authentication Type Integration Connector Options

Logo - EV Service Manager.png

Up and Down arrow.png

Logo Icon - Microsoft Azure Logic Apps.png
  • Depending on the third-party service used (authentication managed by Microsoft Azure Logic Apps)
  • Basic Authentication for the Service Manager REST API
Available versions
SaaS-based On-premises
Service Manager Check icon.png Check icon.png
Third-Party Product Check icon.png N/A

Notes

  • Microsoft Azure Logic Apps is similar to Zapier and IFTTT, also supported by Service Manager thanks to standard connectors (services) that can be used in business processes via REST actions.

Microsoft Azure Logic Apps - Definitions

Definitions_MicrosoftAzureLogicApps
  • A logic app is a series of steps that run actions by accessing data via a connector. The first step requires a trigger.
    • The trigger is run when an event meets the specified conditions. It will start the logic app workflow.

      example  A logic app REST action is used as the trigger in a Service Manager workflow.

    • The action is a task carried out by the workflow of your logic app.

      example  A Send Email action is performed when the logic app REST action is triggered in a Service Manager workflow.

       
  • What is the difference between Logic Apps and Microsoft Power Automate?
    • Microsoft Power Automate is a tool integrated with certain Microsoft 365 programs. It is based on Logic Apps, with same workflow designer and connectors. It enables any user to perform simple integrations without requiring developers or the IT Department.

      example  Receive SMS notifications for important emails

    • Logic apps are used for advanced or strategic integrations that require corporate development and security practices. For this reason, Microsoft Azure Logic Apps includes more functionalities intended for IT teams and developers.

Prerequisites

Integration process 1: From Service Manager to a third-party service

example

  • Main trigger event in Service Manager: Creation of a service request by a VIP (high priority)
  • Action carried out in the Outlook third-party service: Sending of an email to a mailing list of members in charge of processing VIP requests

 

Azure Logic Apps: Create the logic app

Step 1: Create the new app

1. Log in to the Azure portal using your Azure account login.

2. Move the cursor over the logic app service and click + Create.

          Logic Apps resource - Selection.png

3. Create the new logic app.

  • Enter the information on the new app.
             Logic Apps - Create new Logic app.png
    • Subscription: Name of your Azure subscription.
    • Resource group: Azure resource group, used to organize and manage Azure resources (Open url.png See the description.). Select an existing group or create a new one.
    • Logic App Name: Name of the app.

      Note: Letters and numbers as well as the following characters are authorized:-  (  )  . There must be no spaces.
      example  EVSM_New_Request_WKFW_(High-VIP)_SendE-mail

    • Location: Location of the data center hosting your logic app. 

4. Click Review + create, then click Create.

  • The logic app is created on the Azure portal.  
  • It is deployed for the selected group.

 

Step 2: Create the app trigger

1. Open the Logic Apps Designer via Go to resource.

          Logic Apps - Access Logic Apps Designer.png

2. Select the app trigger.

example  When a HTTP request is received trigger 

Process 1 - Select trigger.png

3. Generate the URL of the app via Save in the Designer toolbar.

          Process 1 - Generate Logic app URL.png

4. Click Copy icon.png to copy the URL displayed in the HTTP POST URL field and paste it in your text editor in order to store it temporarily. It will be required when defining the configuration in Service Manager.
 

Step 3: Create the logic app workflow.

1. Click + New step below the trigger step.

          Process 1 - Create new step.png

The window for selecting the action will appear.

2. Select the connector and the action to be performed.

  • Use the search field to filter the list of connectors.
  • Select the connector you want.
    The list of all actions available for the selected connector will appear.
  • Select the action you want.

example  

  • Filter the outlook connectors.
  • Select the Office 365 Outlook connector.
  • Select the Send email action.
    Process 1 - Create new action - Example.png

3. Enter the login information required by the connector or click Change connection.

example  For the Outlook connector: User name and password for the Outlook account

4. Specify the information for the action based on your requirements.

example  Information for sending an email to a mailing list via Outlook

Process 1 - Create action - Information - Example.png

5. Click Save in the Designer toolbar to save the workflow.

Service Manager: Create a resource called Microsoft Azure Logic Apps used in a REST step of a process

Notes:

  • The Microsoft Azure Logic Apps resource will enable to perform actions in a third-party service from Service Manager.
  • It is associated with a Microsoft Azure Logic Apps 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 Microsoft Azure Logic Apps associated with a Microsoft Azure Logic Apps service

        Open url.png See the detailed procedure.

Step 2.a: Create a service called Microsoft Azure Logic Apps

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 Azure Logic Apps.
  • Authentication Method: None.
  • Service URL: URL for accessing the new Microsoft Azure Logic Apps 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-29.eastus.logic.azure.com:443/workflows/1f5f40b60154432abcb0b8084892440f/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=5-nNWgR2Hho6s5YN2BYzqBFpzrLmf7UBqhrl6328rIB

    • Replace prod-29.eastus with {subdomain}.
       

Step 2.b: Create a connection to the Microsoft Azure Logic Apps service.

1. Create a new connection.

          New REST connection - None authentication.png

2. Specify the information below.

  • Connection Name: Enter the label Microsoft Azure Logic Apps.
  • Authentication Method: None.
  • Service Name: Select the Microsoft Azure Logic Apps service you created at step 2.a.
    The URL of the service will automatically appear.
  • subdomain: Copy and paste the prod-29.eastus value of the URL you stored in your text editor.
     

Step 2.c: Create a resource associated with the Microsoft Azure Logic Apps service

1. Create a new resource.

          New REST resource - None authentication.png

2. Specify the information below.

  • Label: Enter the label Microsoft Azure Logic Apps.
  • 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-29.eastus.logic.azure.com:443/workflows/1f5f40b60154432abcb0b8084892440f/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=5-nNWgR2Hho6s5YN2BYzqBFpzrLmf7UBqhrl6328rIB

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

Caution: 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.

Specify the parameters to be used in the third-party service such as the incident number and description in the email sent to a mailing list.

Step 3: Use the Microsoft Azure Logic Apps 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 Microsoft Azure Logic Apps 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.

          New REST action in workflow - Properties.png

4. Click Confirm Changes.


 

Step 4: Pass Service Manager parameters to the logic app.

          Open url.png See Use the HTTP Request trigger.

Note: 

  • The parameters must be passed to the logic app trigger in a JSON schema. To do this, you can use jsonschema.net.
  • You can then use them in actions via dynamic variables.
     

Step 4.a: Pass Service Manager resource parameters to the logic app trigger.

1. In Service Manager, go to the resource you previously associated with the logic app service.

  • Copy the text added to the Content field.
             Process 1 - Trigger configuration - Service Manager resource content.png

2. Open a text editor, e.g. Notepad++.

  • Paste the text.
  • Ensure that all invisible characters and line breaks are deleted.
  • Copy the clean text.

3. Go to jsonschema.net.

  • Paste the clean text in the JSON field.
  • Click Submit.
  • Switch to Plain mode.

          Process 1 - Trigger configuration - JSONSchemanet editor.png

  • (optional) Rename the Service Manager parameters so you can identify them easily in the logic app.

example  

  • comment > title: Description of the incident in Service Manager
          ==> previous value The comment schema
          ==> new value EVSM_Request_Description
  • rfc_number > title: Number of the incident in Service Manager
          ==> previous value The rfc_number schema
          ==> new value EVSM_Request_Number
    Process 1 - Trigger configuration - JSONSchemanet editor - Modify schema.png
  • Click Copy icon.png to copy the JSON schema.

4. Go to the Azure Logic Apps trigger.

  • Click the title bar to display the trigger's properties.
  • Paste the JSON schema in the Request Body JSON Schema field.
             Process 1 - Trigger configuration - Logic Apps request body.png
     

Step 4.b: Pass Service Manager resource parameters to the logic app action.

1. Click the title bar to display the action's properties.

2. Add the parameters retrieved from the Service Manager resource using the app's dynamic variables.

Note: The list of variables available is automatically displayed when you click the Body or Subject field.

          Process 1 - Action configuration - Send email properties.png
 

Step 5: Verification and test.

1. Create an incident in Service Manager.

2. Check that the action configured in the logic app is correctly performed in the third-party service.

example  Creation of a service request in Service Manager  ==> An email is automatically sent to a mailing list of members in charge of processing VIP requests, using the Outlook account.

          Process 1 - Test - Incident in Service Manager.png
         Process 1 - Test - Email in Outlook.png

Integration process 2: From a third-party service to Service Manager

example

  • Main trigger event in the Outlook third-party service: Reception of an email for a service request
  • Action performed in Service Manager: Creation of a service request by sending a HTTP POST request to the Service Manager REST API

 

Azure Logic Apps: Create the logic apps

Step 1: Create the new logic apps.

1. Log in to the Azure portal using your Azure account login.

2. Move the cursor over the logic app service and click + Create.

          Logic Apps resource - Selection.png

3. Create the new logic app.

  • Enter the information on the new app.
             Logic Apps - Create new Logic app.png
    • Subscription: Name of your Azure subscription.
    • Resource group: Azure resource group, used to organize and manage Azure resources (Open url.png See the description.). Select an existing group or create a new one.
    • Logic App Name: Name of the app.

      Note: Letters and numbers as well as the following characters are authorized:-  (  )  . There must be no spaces.
      example  EVSM_New_Request_WKFW_(High-VIP)_SendE-mail

    • Location: Location of the data center hosting your logic app. 

4. Click Review + create, then click Create.

  • The logic app is created on the Azure portal.
  • It is deployed for the selected group.

 

Step 2: Create the app trigger.

1. Open the Logic Apps Designer via Go to resource.

2. Select the Blank Logic App template.
Note: You can use a predefined template.

          Process 2 - Select trigger.png

3. Select the app trigger.

  • Use the search field to filter the list of connectors.
    The list of all triggers available for the selected connector will appear.
  • Select the trigger you want.

example  

  • Filter the outlook connectors.
  • Select the Office 365 Outlook connector.
  • Select the When a new email arrives trigger.
    Process 2 - Create trigger - Example.png

4. Enter the login information required by the connector or click Change connection.

example  For the Office 365 Outlook connector: User name and password for the Outlook account

5. Specify the information for the trigger based on your requirements.

example  Information for the When a new email arrives trigger
Process 2 - Create trigger - Information.png

The logic app workflow trigger is created.

6. Click Save in the Designer toolbar to save the app.
 

Step 3: Create the steps in the logic app workflow.

1. Click + New step below the trigger step.

          Process 2 - Create new step.png

The window for selecting the action will appear.

2. Select the connector and the action to be performed.

The window for selecting the action will appear.

3. Select the connector and the action to be performed.

  • Use the search field to filter the list of connectors.
  • Select the connector you want.
    The list of all actions available for the selected connector will appear.
  • Select the action you want.

example  

  • Filter the HTTP connectors.
  • Select the HTTP connector.
  • Select the HTTP - HTTP action.
    Process 2 - Create new action - Example.png

4. Specify the information for the action based on your requirements.
Note: The list of variables available is automatically displayed when you click one of the fields.

example  Define the email to be sent when a service request is created in Service Manager

Process 2 - Action configuration - Send email properties.png

5. Click Save in the Designer toolbar to save the workflow.
 

Step 4: Check and test.

1. In the Designer toolbar, click Run.

          Process 2 - Run action.png

2. Check the workability of the workflow. A Check icon.png should appear in the Designer window.

          Process 2 - Check application workflow.png

example  Send an email with a new service request using a specific email address  ==>  Creation of the corresponding service request in Service Manager

          Process 2 - Test - Email in Outlook.png
         Process 2 - Test - Change request in Service Manager.png

AccountFreeCreation

How to create a free Azure account

1. Go to the Microsoft Azure website.

2. Click Start free.

          Microsoft Flow - Free account.png

3. Log in to your professional Microsoft account.
         Microsoft Flow - Login account.png

4. Enter the login information.
         Microsoft Flow - Account creation - Identification 1.png

5. Click Next.

6. Tick the I agree box.
         Microsoft Flow - Account creation - Identification 2.png

7. Click Sign up.

Links to other integrations

Tags:
Powered by XWiki © EasyVista 2022