EV Observe - Integration with EV Service Manager

Last modified on 2022/11/17 10:09

This ticketing integration is used to create and synchronize tickets in both EV Service Manager and EV Observe when a monitoring alert is acknowledged for a service or host in EV Observe.

To set up this integration, you must first define the cross-reference mapping between EV Observe information and Service Manager information.

     Open url.png See Ticketing integration - Overview

Integration use case  - Open url.png See the detailed description

  • An incident can be created in Service Manager. Alerts can also be associated with an existing incident.
  • You can define a link between a host and a configuration item (CI) in Service Manager to display change requests and problems related to the CI in the host's history of statuses.
  • You can view information on the incident or CI in the EV Observe service or host. You can use a link to open the Incident form or CI form directly in Service Manager.

Notes

  • The priority of the incident is calculated in Service Manager using the impact level and the urgency level.
    • A priority matrix is used to determine the priority level dynamically based on the type of component (host/service), its priority and its current status in EV Observe.
    • If the priority matrix is undefined or incomplete, the default values for the impact level, urgency level and critical level in Service Manager will be applied.
  • Service Manager offers functionalities for accessing EV Observe information. Open url.png See the description

Mapping between EV Observe and Service Manager

  • The relationship between EV Observe and Service Manager is established using an auto connection link.
  • Each auto connection link is built by specifying the form to be opened in Service Manager, the field used as the search criterion and the search value for this field.
  • It takes the form of a URL followed by parameters introduced by field variables.

    https://{your_server}/autoconnect_mail.php?/field1={your_account_crypted}&field2=login&field3=password&field4={form_id}&field5=ViewDialog&field6={searched_value}&field7={search_field}

    • {your_server}: URL of the server.
    • field1 = {your_account_crypted}: Encrypted Service Manager account used (40000, 50004, 50005).
    • field4 = {form_id}: ID of the form searched for.
    • field6 = {searched_value}: Search value.
    • field7 = {search_field}: Name of the search field.
  • The table below indicates the different parameters used by EV Observe for accessing Service Manager objects.
Service Manager object Service Manager form Service Manager search field Variables field
Configuration item (CI) DialogCMDB_ConfigurationElement ASSET_ID
  • field1 = account_id
  • field4 = ci_form
  • field6 = ID of the host in EV Observe, retrieved from the value of the Service Manager ID field in the form
Incident DialogHD_Incidents RFC_NUMBER
  • field1 = account_id
  • field4 = inc_form
  • field6 = ID of the ticket in EV Observe
Problem DialogHD_Problems RFC_NUMBER
  • field1 = account_id
  • field4 =p_form
  • field6 = ID of the problem in EV Observe, retrieved from the list of problems
Change request DialogFO_RFC RFC_NUMBER
  • field1 = account_id
  • field4 = r_form
  • field6 = ID of the ticket in EV Observe

Priority matrix

  • The priority matrix, if defined, is used to determine the impact and urgency of an incident dynamically based on the type of component (host/service), its priority and its current status in EV Observe. It is determined using the information below.
Type of EV Observe component EV Observe status EV Observe business impact Calculated priority in Service Manager
  • 0: Host
  • 1: Service
  • 0: OK
  • 1: Warning
  • 2: Critical
  • 3: Unknown
  • 0: Low
  • 1: Medium
  • 2: High
Based on the urgency and impact in Service Manager

example  

Type of EV Observe component Status Business impact Impact in Service Manager Urgency in Service Manager Calculated priority in Service Manager
0: Host Critical High 1 1 1
0: Host Critical Medium 2 1 2
1: Service Warning High 1 2 2
1: Service Warning Medium 2 2 3
1: Service Warning Low 3 2 4
  • The matrix is sent to the Service Manager REST API in a JSON schema.

"priority":{
      "0" for a host / "1" for a service:{
            "statut_id":{
                  "impact_id":"xx",
                  "urgency_id":"xx"
            }
      }
}

{
"priority":{
  "0":{
     "2":{
        "0":{
           "impact_id":"3",
           "urgency_id":"1"
         },
        "1":{
           "impact_id":"2",
           "urgency_id":"1"
         },
        "2":{
           "impact_id":"1",
           "urgency_id":"1"
         }
      },
     "3":{
        "0":{
           "impact_id":"3",
           "urgency_id":"3"
         },
        "1":{
           "impact_id":"2",
           "urgency_id":"3"
         },
        "2":{
           "impact_id":"1",
           "urgency_id":"3"
         }
      }
   },
  "1":{
     "1":{
        "0":{
           "impact_id":"3",
           "urgency_id":"2"
         },
        "1":{
           "impact_id":"2",
           "urgency_id":"2"
         },
        "2":{
           "impact_id":"1",
           "urgency_id":"2"
         }
      },
     "2":{
        "0":{
           "impact_id":"3",
           "urgency_id":"1"
         },
        "1":{
           "impact_id":"2",
           "urgency_id":"1"
         },
        "2":{
           "impact_id":"1",
           "urgency_id":"1"
         }
      },
     "3":{
        "0":{
           "impact_id":"3",
           "urgency_id":"3"
         },
        "1":{
           "impact_id":"2",
           "urgency_id":"3"
         },
        "2":{
           "impact_id":"1",
           "urgency_id":"3"
         }
      }
   }
}

Procedure: How to configure the Service Manager ticketing system

Configuration in Service Manager

Step 1: Create a REST API profile

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

2. Create a new user profile. Open url.png See the procedure

3. Select the REST API box to authorize the use of the Service Manager REST API.
   REST API - Dedicated user.png

4. Click Wheel icon.png next to the REST API field to grant access rights to Service Manager REST API methods.

  • Select only the routes below to configure the Service Manager ticketing system. Unselect the other routes.
    • GET: Read-only access
    • PUT: Write access
       
Route HTTP Method Service Manager REST API
Method URL for accessing the method
/{account}/configuration-items GET See a list of CI "https://{your_server}/api/v1/{your_account}/configuration-items"
/{account}/employees GET See a list of employees "https://{your_server}/api/v1/{your_account}/employees"
/{account}/locations GET See a list of locations "https://{your_server}/api/v1/{your_account}/locations"
/{account}/locations/{location_id} GET See a location "https://{your_server}/api/v1/{your_account}/locations/{location_id}"
/{account}/requests GET See a list of tickets "https://{your_server}/api/v1/{your_account}/requests"
/{account}/requests/{rfc_number} GET See a ticket "https://{your_server}/api/v1/{your_account}/requests}/{rfc_number}"
PUT Update a ticket
/{account}/requests/{rfc_number}/comment GET See the ticket comment "https://{your_server}/api/v1/{your_account}/requests}/{rfc_number}/comment"

Step 2: Create a dedicated user authorized to run REST requests

1. Go to the Employee Directory by selecting References > Directory > Employees in the menu.

2. Create a new user and assign the REST API user profile you just created.

          User - Profile REST API.png

Configuration in EV Observe

Step 1: Create a Service Manager connector

1. Go to the Web app.

2. Create a Service Manager connector.

  • Select Administration > External connections > External connections in the menu.
  • Click + Add.
    EV Observe - Service Manager connector configuration.png
     

Step 2: Specify the information on the connector

1. Specify the information below.

  • Type: Select the EasyVista Webservice connector.
  • Module: Select the Ticketing value.
  • User / Password: Specify the credentials of the user authorized to use the Service Manager REST API (see the configuration in Service Manager in step 2).
  • URL: URL for accessing Service Manager.
  • Port: Port for accessing the Web server.
    • You must have already enabled the port (443/80 or another).
  • Specific information: Specify the field in a JSON schema using the parameters below. JSON is the exchange format of the Service Manager REST API.
    • account: Service Manager account used.
    • ci_form: ID of the Configuration Item (CI) form in Service Manager. Open url.png See Auto connection link
    • p_form: ID of the Problem form in Service Manager. Open url.png See Auto connection link
    • inc_form: ID of the Incident form in Service Manager. Open url.png See Auto connection link
    • r_form: ID of the Change Request form in Service Manager. Open url.png See Auto connection link
    • account_id: Encrypted ID of the Service Manager account used.
    • severity_id: ID of the severity value in Service Manager assigned by default to new incidents.
    • createticket: Information specific to ticket creation in Service Manager.
      • instruction: Used to indicate whether the contents of the instruction specified in the EV Observe object should be added to the description of the incident ("true") or not ("false").
      • submit_date: Used to indicate whether the ticket date is equal to the alert date in EV Observe ("ack") or to the actual creation date of the incident (unspecified value).
      • catalog_code: Category in the EV Observe catalog assigned by default to new incidents.
      • priority: ID of the priority level in Service Manager assigned by default to new incidents, or the priority matrix if it is defined.
      • impact_id: ID of the impact level in Service Manager assigned by default to new incidents, or the priority matrix if it is defined.
      • urgency_id: ID of the urgency level in Service Manager assigned by default to new incidents, or the priority matrix if it is defined.
      • origin: ID of the origin in Service Manager assigned by default to new incidents.

example

{
  "account": "50006",
  "ci_form": "%7B2858FDB5-72D9-48C9-8051-186A64A533FA%7D",
  "p_form": "%7BD7406E06-3ACD-4D60-AD2A-9AA5CCADC96B%7D",
  "inc_form": "%7BAF1AE6AD-FF4B-41B0-93B3-99BEF6052B12%7D",
  "r_form": "%7B70384870-2A12-4D37-9A0C-469C5DE74CB1%7D",
  "account_id": "5C0F051E590F056F1F",
  "severity_id": "40",
  "createticket": {
     "instruction": "true",
     "submit_date": "ack",
     "catalog_code": "61",
     "priority": "0",
     "impact_id": "",
     "urgency_id": "",
     "origin": "3"
   }
}

{
  "account": "50006",
  "ci_form": "%7B2858FDB5-72D9-48C9-8051-186A64A533FA%7D",
  "p_form": "%7BD7406E06-3ACD-4D60-AD2A-9AA5CCADC96B%7D",
  "inc_form": "%7BAF1AE6AD-FF4B-41B0-93B3-99BEF6052B12%7D",
  "r_form": "%7B70384870-2A12-4D37-9A0C-469C5DE74CB1%7D",
  "account_id": "5C0F051E590F056F1F",
  "severity_id": "40",
  "createticket": {
     "instruction": "true",
     "submit_date": "ack",
     "catalog_code": "61",
     "priority":{
        "0":{
           "2":{
              "0":{
                 "impact_id":"3",
                 "urgency_id":"1"
               },
              "1":{
                 "impact_id":"2",
                 "urgency_id":"1"
               },
              "2":{
                 "impact_id":"1",
                 "urgency_id":"1"
               }
            },
           "3":{
              "0":{
                 "impact_id":"3",
                 "urgency_id":"3"
               },
              "1":{
                 "impact_id":"2",
                 "urgency_id":"3"
               },
              "2":{
                 "impact_id":"1",
                 "urgency_id":"3"
               }
            }
         },
        "1":{
           "1":{
              "0":{
                 "impact_id":"3",
                 "urgency_id":"2"
               },
              "1":{
                 "impact_id":"2",
                 "urgency_id":"2"
               },
              "2":{
                 "impact_id":"1",
                 "urgency_id":"2"
               }
            },
           "2":{
              "0":{
                 "impact_id":"3",
                 "urgency_id":"1"
               },
              "1":{
                 "impact_id":"2",
                 "urgency_id":"1"
               },
              "2":{
                 "impact_id":"1",
                 "urgency_id":"1"
               }
            },
           "3":{
              "0":{
                 "impact_id":"3",
                 "urgency_id":"3"
               },
              "1":{
                 "impact_id":"2",
                 "urgency_id":"3"
               },
              "2":{
                 "impact_id":"1",
                 "urgency_id":"3"
               }
            }
         }
      },
     "impact_id": "",
     "urgency_id": "",
     "origin": "3"
   }
}

2. Click Test to check that the connector is correctly configured.

3. Click Apply.
 

Step 2: Associate the company with the Service Manager entity

1. Select Organization > Sites in the menu.

2. Select the company and click Update.

3. Specify the CRM link field.

        EV Observe - Service Manager company configuration.png

Use case

Synchronize Service Manager incidents with monitoring alerts

Step 1: Create a new incident or create a link with an existing incident

When a monitoring alert is acknowledged in EV Observe for a service or host, three options will be available.

     Open url.png See the detailed procedure How to create a ticket in Service Manager from a monitoring alert

          Use Case - Incident - Options.png

1. You want to create a ticket in Service Manager using information from the alert.

  • Click Create a ticket and acknowledge.
  • Specify the ticket using the form loaded by default with information from the alert.
  • Click Apply.
  • The alert will be acknowledged.
  • The ticket will be created in Service Manager using information from the EV Observe alert.

          Use Case - Incident - Ticket creation in Service Manager.png

2. You want to associate information from the alert with an existing ticket in Service Manager.

  • Click Link to an existing ticket and acknowledge.
  • Select the relevant ticket.
  • Click Apply.
  • The alert will be acknowledged.
  • Information from EV Observe alert will be added to the selected ticket.

          Use Case - Incident - Link to existing ticket in Service Manager.png

3. You want to acknowledge the alert in EV Observe, without any action in Service Manager.

  • Click Acknowledge.
     

Step 2: Access an incident directly from monitoring

Once you have created the ticket in Service Manager, you can access its form directly from EV Observe.

1. Go to the EV Observe dashboard displaying the list of hosts/services or select the Operations tab in the Details form of the host/service associated with the incident.

2. Click View ticket information icon.png to open the relevant Incident form in Service Manager.

          Use Case - Access to Incident in Service Manager - Via dashboard.png
         Use Case - Access to Incident in Service Manager - Via form.png

The ticket will open in Service Manager.
         Incident.png

Link between a host and a Service Manager configuration item (CI)

Step 1: Associate a host with a Service Manager configuration item (CI)

1. Associate each host with the ID of the corresponding Service Manager CI.

Best Practice icon.png  You can perform a mass association using a mass import or the EV Observe API.

          Use Case - Access to CI in Service Manager - Association.png

2. Open the Configuration form of the host.

3. Click View CI ID icon.png to display the ID of the CI.

          Use Case - Access to CI in Service Manager - Association details.png

Note

  • The ID of the CI is accessible in read-only mode.
  • The corresponding field in the database is ITSM ID and is displayed in the Service Manager ID field in the interface.
     

Step 2: Access a configuration item (CI) directly from monitoring

Once you have created the link between the host and the Service Manager CI, you can access its form directly from EV Observe.

1. Open the Details form of the host associated with the CI.

2. Click View CI information icon.png to open the corresponding CI form in Service Manager.

          Use Case - Access to CI in Service Manager.png

The CI form will open in Service Manager.
      CI.png
 

Step 3: Display change requests and problems related to the CI in the host's history of statuses

1. Open the Details form of the host associated with the CI.

2. Select the History tab.

The timeline will display all events related to the CI over a given period, i.e. incidents, change requests, problems.
      Use Case - Access to CI in Service Manager - Change history.png

3. Place your cursor over an icon associated with an event.

The details will appear in a tooltip.

4. Click the event reference to open the corresponding form in Service Manager.

Service Manager functionalities for accessing EV Observe

Service Manager offers functionalities for accessing EV Observe information.

Deep links are used to access EV Observe directly using a specific icon displayed next to certain form fields.

This means that you can open an EV Observe Host form from an Incident form.

          Service Manager - Deep Linking functionality.png

Implementation principle
1. Configure a direct link in EV Observe.

2. Configure the deep link in Service Manager.

Contextual apps

You can run contextual apps found in the right sidebar in forms. Information specific to the current record will appear in a slide-out window.

This means that you can display an EV Observe Dataviz monitoring dashboard from an Incident form.

          Service Manager - Contextual apps functionality.png

Tags:
Powered by XWiki © EasyVista 2022