08 - Create the 'ServiceNow Create Incident' tool

In this module we will create a stateful workflow to create a ServiceNow incident. Our Agent Loop will leverage this workflow as a tool when processing user requests.

Create Stateful Workflow

1. Create a new workflow:

   • Navigate to the Workflows -> Workflows section of your Logic app

   • Click + Add -> Add

     

2. Create a new stateful workflow with:

   • Workflow name: tool-ServiceNow-CreateIncident
   • Select the radio button for the Stateful workflow type
   • Click Create

   

3. Open the workflow visual editor by clicking on the tool-ServiceNow-CreateIncident link

   

Configure Workflow

1. Configure the workflow trigger to accept an HTTP Request

   • Click on Add Trigger

   • Select the Request action located in the Built-in tools group

     

   • Select the When a HTTP request is received

     

2. Configure the When a HTTP request is received action:

   • Request Body JSON Schema

     {
         "type": "object",
         "properties": {
             "AssignmentGroup": {
             "type": "string"
             },
             "Description": {
             "type": "string"
             },
             "FailureDateTime": {
             "type": "string"
             },
             "ResolutionSteps": {
             "type": "string"
             },
             "Severity": {
             "type": "string"
             }
         }
     } 

3. Look up the internal identifier for the Assignment Group in ServiceNow. The Assignment Group is the group of the team that will be responsible for resolving the particular incident. By assigning, this value during ticket creation, we can ensure that it is assigned appropriately.

   • Add a new action. Click + Add an action

     

   • Select the ServiceNow - List Records action

     

4. Configure the ServiceNow - List Records activity.

   • Configure the Connection:

     • Connection Name: connServiceNowDev
     • Authentication Type: Use Oauth2
     • Instance Name: [obtained from Module 2]
       • example: devXXXXXX
       • can also be found in the URL of your developer instance https://[instance name].service-now.com

   • ClientId: [obtained from Module 2 - ]

     • example: 924168e8304a2210cc58c3f34c9b62f3
     • Click Sign in

     

   • NOTE you may receive the following error.

     

     If you receive this error you will need to:

     • Copy the URL into a text editor

     • note the redirect_uri parameter in the query string

       • redirect_uri=https%3a%2f%2flogic-apis-canadacentral.consent.azure-apim.net%2fredirect

     • convert the URL Encoded ASCII characters back as follows

       • Replace %3a with :
       • Replace %2f with /

     • in the above example we would have resolved to https://logic-apis-canadacentral.consent.azure-apim.net/redirect

       • Update the Application Registration entry created in the Module 4 - Prerequisites - ServiceNow setup. Add the Redirect URL

     

   • Close the browser popup window

   • Click the Sign In button again

     Note please check for errors in the upper right hand corner of your browser. Some browsers may block popups.

     

5. Click Allow granting Logic Apps permission to connect to your ServiceNow instance

   

6. Configure the List Records Activity as follows

   • Record Type: Group
   • Advanced Parameters (click Show all)
   • Query: name=@{triggerBody()?['AssignmentGroup']}

   

7. Add a new action

8. Select the ServiceNow - Create Record action

   

9. Configure the Create Record action as follows:

   • Rename action to: Create Record-Incident
   • Record Type: Incident
   • Advanced Parameters:
     • you can show selected advanced parameters by clicking on the dropdown and select each parameter individually
     • Short Description:

       The following error occurred and needs to be investigated: @{triggerBody()?['Description']} 
     • Assignment Group:

       @{first(body('List_Records-AssignmentGroups')?['result'])['sys_id']}
     • Description:

       The following workflow failed and needs to be investigated:
       
       Error Message: @{triggerBody()?['Description']}
       
       Additional Information: @{triggerBody()?['FailureDateTime']}
       Resolution Steps (from Operation Manual):
       @{triggerBody()?['ResolutionSteps']}
     • Severity:

       @{triggerBody()?['Severity']}
     

10. Add the Request (Built-in) -> Response action

    

11. Configure the Response action as follows:

    • Status Code: 200
    • Body:

      {
          "TicketNumber": "@{body('Create_Record-Incident')?['result']?['number']}"
      }
    • Response Body JSON Schema

      {
          "type": "object",
          "properties": {
              "TicketNumber": {
                  "type": "string"
              }
          }
      }

    

12. Click Save to save the changes made to the workflow

    

    You should see a notification once the workflow is saved.