ServiceNow integration (version 5.0)

Contents

Introduction

Upgrading from a previous integration version

Install the xMatters application

Configure xMatters

Configure ServiceNow

How to use the integration

Troubleshooting

Extended functionality

Download resources

The information in this article is the intellectual property of xMatters and is intended only for use with xMatters products by xMatters customers and their employees. Further, this intellectual property is proprietary and must not be reused or resold.

Introduction

This article provides technical details for the implementation of the xMatters On-Demand service for use with ServiceNow.

xMatters for ServiceNow is a direct, cloud-to-cloud integration, leveraging the communication plan technology within xMatters On-Demand to become the voice and interface of an automation engine. When ServiceNow detects something that requires attention, xMatters places phone calls, send emails or notifies your mobile app.

Integration Version

Version 5.0.1 of the xMatters application within ServiceNow is certified with Helsinki, Istanbul, Jakarta, and Kingston.

How it works

The integration consists of a pre-configured communication plan, and the xMatters application within ServiceNow which includes the following components:

  • The synchronization component, which synchronizes users, groups and group members to xMatters.
  • The incident notification component, responsible for handling incidents from ServiceNow to xMatters and from xMatters to ServiceNow.
  • The Engage with xMatters component, which handles ad hoc communications, including conference bridges with xMatters.

The components use different sets of business rules, script includes and web services to accomplish their tasks. Each of the components is based on a trigger on a business rule; these triggers are set for Insert, Update, and Delete. After the change has been committed, initial checking within the business rules determines what type of operation has occurred. A call is then made to the script include, which processes the request and runs various rules based on the Incident Notification, Engage with xMatters, and Data Sync Configuration pages to determine what type of action to take.

If the script include determines that an action is to be sent to xMatters, it creates a ServiceNow REST message for incident events or an xMatters API REST message for synchronization requests. ServiceNow REST messages are received by the inbound integrations on the communication plan, where the appropriate notification layout is determined based on the target device. xMatters API messages are received by the xMatters REST operations, and devices, users, or groups are added, updated, or deleted appropriately.

Note for Kingston deployments!

See How to use the integration with Kingston for important information on using the latest versions of this integration with the Kingston release of ServiceNow.

ServiceNow Roles

This integration installs new roles into ServiceNow to control interactions between users and integration components.

  • x_xma_xmatters.xmatters_admin: Only users with this role can modify xMatters components within the ServiceNow interface. 
  • x_xma_xmatters.xmatters_rest: This role must be assigned to a ServiceNow API user to successfully access the REST endpoint and execute the required integration requests. See ServiceNow API User, below.
  • x_xma_xmatters.xmatters_engage: Users with this role can use the Engage with xMatters feature described below. Assigning this role to a group automatically assigns it to all users within a group, or you can add this role to an existing role to automatically assign it to multiple users. (You should also assign this role to the ServiceNow API user so they can update the Engage with xMatters records.)
  • x_xma_xmatters.xmatters: Assign this role to any users or groups you want to synchronize into xMatters. Assigning this role to a group automatically assigns it to all users within a group, or you can add this role to an existing role to automatically assign it to multiple users. 

Features and updates in this version

Along with all of the fixes and updates from previous versions, this release (5.0) includes the following enhancements:

  • Updated Data Sync components in order to avoid hitting Progress Worker Quota limits introduced in ServiceNow Jakarta.
  • Added Initiator to the “Engage with xMatters” form.
  • Added targeted recipient and ServiceNow initiator information to the event notification (requires the 5.0 communication plan).

The 4.2 version of this integration includes the following fixes and enhancements:

  • Implemented the new Event Comments trigger, which allows the integration to update the ServiceNow ticket with comments added to the event in xMatters (requires the 4.2 communication plan).
  • Added support for the ServiceNow Compact User Interface.
  • Updated the group data sync so any supervisors you've set up for a group in xMatters are preserved in future data syncs.
  • Addressed an issue where a new incident was created even if the original incident was deleted before the outbound integrations ran.
  • Cleaned up some console errors that were appearing in the Engage with xMatters dialog.
  • Updated the response actions on the Engage with xMatters "Acknowledge" response and the Conference Bridge "Join" response so your second line of on-call users aren't notified if the first line responds with either of these options.

The 4.1 version of this integration includes the following fixes and enhancements:

  • The data sync feature has been updated to address a minor flaw that could potentially cause the user sync to stop processing if it encountered an error. 
  • Addressed an issue where dynamically syncing a ServiceNow group with multiple inherited roles would not sync those roles to added users.

The 4.0 version of the integration includes several updates and enhancements:

  • The xMatters application is now certified for use with ServiceNow Jakarta (in addition to Helsinki and Istanbul).
  • The data sync feature has been updated to preserve roles for existing users. When initiating a sync, the process compares a user’s existing roles in xMatters, and will add any new roles assigned in ServiceNow. (Previously, the sync process would replace a user’s existing roles with whatever roles were indicated in ServiceNow.)
  • The configuration pages for the xMatters application now target the inbound integrations on the communication plan, rather than the forms. This enables access to enhanced authentication and more customization options in the Integration Builder.
  • Logging of xMatters events within ServiceNow has been improved, and a new setting on the Common Configuration page allows you to turn debugging-level logging on or off. 
  • The Engage with xMatters feature now allows you to add users to conference bridges already in progress for the related incident (in addition to creating new hosted or external conference bridges).
  • You can now choose to sync group managers from ServiceNow even if they do not have the xMatters sync role (x_xma_xmatter.xmatters). To use this feature, select the Always Sync Group Managers option on the xMatters Configuration - Data Sync page. 
  • Some minor issues with the data sync process have been addressed, leading to performance and reliability enhancements.

This version also includes all of the features available in the previous version of the xMatters integration:

  • All web services calls are now REST based. Events are injected via the Integration Builder and data sync calls use the xM API.
  • Within ServiceNow, all operations happen asynchronously, improving performance by queuing events.
  • The configuration pages and user interface for the xMatters application within ServiceNow have been redesigned to provide a better user experience.
  • Instead of callbacks being passed in from ServiceNow, outbound integration webhooks are now configured in xMatters to allow for ease of use, improved customization, and faster troubleshooting.

Note: Our integration boffins have been hard at work experimenting with ways to extend the functionality and features offered in this integration. For more information, see the Extended functionality section.

Engage with xMatters

This integration includes the Engage with xMatters feature, which allows users with the x_xma_xmatters.xmatters_engage role to leverage xMatters to call in additional members from other teams to assist with an existing incident.

For example, imagine that a support team member has taken ownership of a ticket, but needs help from the database team to resolve part of the problem. Instead of assigning the ticket to someone else and losing the benefits of incident ownership, the support team member can use the Engage with xMatters feature to contact the on-call person in the database group. xMatters continues to update the work notes of the ServiceNow incident so the support team member can still receive real-time updates on whether someone else has started work on the incident and who that person is.

Alternately, the support team member could use the Engage with xMatters conference bridges to bring multiple groups together through xMatters hosted or external conference bridges to work on a solution together.

The Engage with xMatters features also provides the ability for ServiceNow users to get help from or notify users of xMatters that don't exist in ServiceNow. In previous versions, this was only available via subscriptions on the Configuration Item List property. With this version, if there is a group or person that does not exist in ServiceNow, you can still find them using the Engage with xMatters feature and get them up to speed directly.

How to use the integration with Kingston

The Kingston release of ServiceNow introduces a new data policy, installed with the "Incident Management Best Practice - Kingston" plug-in, that requires both the Resolution code and Resolution notes fields to be completed before the incident can be resolved or closed.

Currently, xMatters does not support completing both these fields when you select the Resolve response option. We're working on addressing this issue, but in the meantime, you can use one of the following workarounds:

  • Remove the "Resolve" response from the Incident Notifications tab in the xMatters Configuration screen in Service Now,
    OR
  • Deactivate the "Make close info mandatory when resolved or closed" data policy installed with the plug-in in ServiceNow (see the ServiceNow documentation for instructions). 

Upgrading from a previous integration version

If you already have a working xMatters - ServiceNow integration, use the following steps to upgrade your instance. (If you are installing the integration for the first time, or creating a new integration, start with Install the xMatters application section, below.)

Upgrading a customized integration

If you have any customizations (either from work with an xMatters consultant or self-made), we strongly recommend attempting the upgrade in a non-production or staging environment first. That way you can run the necessary tests to ensure that integration functionality will not be affected.

If you encounter any problems or want to get some help before attempting your upgrade, please contact xMatters Client Assistance and we can help come up with a migration plan.

Upgrading a standard (out-of-box) integration

Note: If you're upgrading from integration version 3.4 (or older), refer to the caveats in this article before attempting to upgrade your instance. You may find it easier to disable your current integration and install this version as a fresh installation.

If you're upgrading from integration version 3.5, disable the data sync feature before beginning the upgrade process described below.

To upgrade your integration:

  1. Download the latest communication plan (attached to this article), and import it into your xMatters instance.
  2. Make sure your REST user has access permission to the plan, and sender permissions on the form.
  3. Open the Integration Builder tab in the imported plan, and set each of the inbound integrations to use Basic Authentication.
  4. Copy the URL for each inbound integration to a safe place, such as a text file.
  5. Copy the UUID for each of the response choices on the form to the same text file.
  6. Log in to ServiceNow and disable the Incident and Engage with xMatters features for your existing integration.
  7. Update the xMatters application to the latest version from the Applications listing screen in ServiceNow.
    • If you installed your integration using an update set, make sure you reach out to the Client Assistance team.
  8. Update the configuration pages with the inbound integration URLs and response UUIDs from your text file.
  9. Re-enable the Incident and Engage with xMatters features.

Upgrading to the latest version of the xMatters app

There's been some changes to how our app is listed with ServiceNow. This means that ServiceNow needs to enable entitlement to the app in production environments, which also means an extra step for you if you want to upgrade from a previous version. 

See the next section for more information on how to install the latest version of the app.

Install the xMatters application

To begin, you need to install the free xMatters app in ServiceNow. The application includes all of the batch loading utilities, configuration pages, business rules, scripts, web services, and other components required for ServiceNow to communicate with xMatters.

To install the xMatters application:

  1. Do one of the following:
    • If you are installing the xMatters app into your non-production ServiceNow environment for the first time so you can check it out and see how great it is, go to the xMatters page in the ServiceNow store, and click Try.
    • If you are installing into your production ServiceNow environment or upgrading an existing app, contact Client Assistance with your ServiceNow production instance and ServiceNow Admin. Our team will work with ServiceNow to enable entitlement in your production environment as soon as possible. Then you can go to the xMatters page in the ServiceNow store. 
  2. Log in with your HI credentials and click Complete Purchase (we know it says 'Purchase' but, yes, the app is free).
  3. Review the contract details and click the Accept checkbox, then click Complete Purchase.
  4. Log into your ServiceNow instance as a system administrator, and navigate to System Applications > Applications.
  5. Click Downloads.
  6. Search for "xMatters", and then click Install.

ServiceNow API user

You also need the user name and password for a ServiceNow API user to handle REST web service calls in ServiceNow. To successfully access the REST endpoint and execute the required integration requests, this user must have the x_xma_xmatters.xmatters_rest role that is added with the xMatters application. (For additional security, select the Web service access only check box on the user's details page.)

Note: You should also assign the x_xma_xmatters.xmatters_engage role to this user so they can update the Engage with xMatters records.

For information about adding users and assigning roles in ServiceNow, refer to the ServiceNow documentation.

Configure xMatters On-Demand

Now that you've done the basic configuration in ServiceNow, you can configure xMatters. After you configure xMatters and copy some specific IDs and URLs, you'll need to return to ServiceNow to finish the setup.

Download the communication plan

The communication plan (.zip file) attached to this article contains pre-configured integrations, forms, properties, and messages specifically designed for ServiceNow. Download the attached .zip file to a location on your local machine.

Create an integration user

This integration requires a user who can authenticate REST web service calls when injecting events.

This user needs to be able to work with events, but does not need to update administrative settings. While you can use the default Company Supervisor role to authenticate REST web service calls, the best method is to create a user specifically for this integration with the "REST Web Service User" role that includes the permissions and capabilities.

Note for trial: If you are installing this integration into an xMatters trial instance, you don't need to create a new user. Instead, locate the "Integration User" sample user that was automatically configured with the REST Web Service User role when your instance was created and assign them a new password then skip ahead to the next section.

To create an integration user:

  1. Log in to the target xMatters system.
  2. On the Users tab, click Add.
  3. Enter the appropriate information for your new user. Because this user affects how messages appear for recipients and how events are displayed in the reports and Communication Center, you may want to identify the user as specific to ServiceNow. For example:
    • First Name: ServiceNow
    • Last Name: Integration
    • User ID: servicenow
  4. Set the user ID and password.
    • Make a note of these details; you'll need them when configuring other parts of the integration.
  5. Assign the user to the REST Web Service User role.
  6. Click Add.

Import the communication plan

Next, import the ServiceNow communication plan attached to this article into xMatters.

To import the ServiceNow communication plan:

  1. In xMatters, click the Developer tab, and then click Import Plan.
  2. Click Choose File, and then locate the plan you downloaded from this article.
  3. Click Import Plan.
    • Once the import is finished, the plan should be automatically enabled. If it isn't, click Plan Disabled to enable the plan.
  4. Click the Edit drop-down list for the plan, and select Access Permissions.
  5. Add the integration user you created above, and then click Save Changes.
  6. In the Edit drop-down list for the plan, select Forms.
    • The forms should be automatically deployed. If they aren't, click Not Deployed beside each form and select Enable for Web Service.
  7. For the Incident Alerts form, click the Web Service drop-down list and select Sender Permissions.
  8. Add the integration user you created above, and then click Save Changes.
  9. Repeat steps 7-8 for the Engage with xMatters and Conference Bridge forms.

Configure endpoint

After you have imported the communication plan, you need to set the URL and authentication for the ServiceNow endpoint. You'll need the user name and password for your ServiceNow API user.

To configure the endpoint:

  1. In the Integration Builder, click Edit Endpoints.
  2. Click the ServiceNow endpoint to open its details.
  3. Update the Base URL to that of your ServiceNow system.
  4. Click the Authentication drop-down list and select Basic.
  5. Enter the credentials for the ServiceNow API user, and then select the Preemptive check box.
  6. Click Save Changes, and then close the Endpoints dialog box.

ServiceNowEndpoint.png

Configure inbound integrations

You need to update each of the inbound integrations to use basic authentication, and retrieve the URLs to configure the app in ServiceNow.

To configure an inbound integration and retrieve its URL:

  1. Navigate to the Integration Builder tab and expand the list of inbound integrations.
  2. Click the name of an integration to view its details.
  3. In the Select authentication method step, select Basic in the drop-down list.
  4. Click Update Inbound Integration.
  5. Scroll down to the bottom of the page, and click Copy URL beside the field:

CopyURL.jpg

Determine identifiers

Some configuration fields require a UUID (Universal Unique Identifier) for a specific component or property in a communication plan. To retrieve the identifier for an element, look for the API icon in the xMatters user interface:

APIIcon.png

Clicking this button displays the identifier for the component in a dialog box. You can then copy and paste the string to the appropriate location in ServiceNow.

As an example, the following instructions describe how to retrieve the UUID for a specific response choice; the process is similar for any identifier you want to determine.

To retrieve the identifier for a response choice:

  1. In xMatters, open the ServiceNow communication plan.
  2. On the Incident Alerts form, click Edit > Responses.
  3. Beside the Accept response, click the API icon:

ResponseOptions.png

Configure ServiceNow

To configure ServiceNow to integrate with xMatters, you need to specify the assignment, synchronization, web services, and other settings on the configuration forms that are installed with the xMatters application, as described in the following sections. You can also seed your users and groups into xMatters using the data sync feature.  

Note: Only users with the ServiceNow x_xma_xmatters.xmatters_admin role (added by the xMatters application) can modify xMatters components within the ServiceNow interface. 

Complete the xMatters Configuration pages

The xMatters application installs four configuration pages into ServiceNow:

  • Common Configuration: Configures the connection, credentials, and logging level for the communication between xMatters and ServiceNow.
  • Incident Notifications: Enables or disables the incident notification features, and configures when and how ServiceNow sends an incident to xMatters for notification.
  • Engage with xMatters: Enables or disables the Engage with xMatters action in the ServiceNow user interface, and sets the connection parameters for the feature.
  • Data Sync: Configures the user and group seeding, and the data synchronization between xMatters and ServiceNow.

You need to update most of the settings on these pages with information specific to your xMatters deployment.

To access the configuration pages in ServiceNow:

  1. Log into ServiceNow as a user with the "admin" role, and open the Navigator.
  2. Locate and expand the Integration - xMatters entry in the All Applications list, and then click xMatters Configuration.
  3. Click the tabs at the top of the window to switch between pages.
Each setting on the pages includes a description of the required content for that setting; move your mouse pointer over the blue help icon beside a field to see more information.

SNOWConfigCommon.png

Note: After saving your settings on the Common Configuration tab, you may notice that the password fields appear to be empty. This is because ServiceNow saves your password values and then clears the contents of these fields as a security measure. 

Integration URLs

The Incident Notifications and Engage with xMatters pages require you to enter the URLs for the inbound integrations included in the communication plan. For instructions on how to retrieve these URLs, see Configure inbound integrations, above.

UUIDs

Some fields require you to enter the identifier or UUID for a property or other element in xMatters. For instructions on how to retrieve these identifiers, see Determine identifiers, above.

Data Sync Supervisors

On the xMatters Configuration > Data Sync configuration page, the Supervisor field displays a list of supervisors available in xMatters. You can select a user name from the list or enter your own. In either case, the selected user MUST be in ServiceNow and must have the "x_xma_xmatters.xmatters" role.

If a selected supervisor does not exist as a user in ServiceNow, or does not have the "x_xma_xmatters.xmatters" role, the user and group data sync will not be completed properly.

Add Engage with xMatters records to a related list

You can use the Related Lists feature in ServiceNow to have any related Engage with xMatters records included on the incident details.

To set up a related list:

  1. Open an existing incident record, click the menu button, and then select Configure > Related Lists.
    • If the current application is not global, you will see a read-only screen with several options for editing. Select the Edit this view in Global link.
  2. In the Available list, select xMatters Engage Records, and move it to the Selected list.
  3. Click Save.

The xMatters Engage Records tab at the bottom of the incident details screen now displays the related Engage with xMatters records for that incident.

EngageRelatedList.png

Seed user, group and incident property information into xMatters

Once you have established the configuration settings for you integration, you can use the Batch Load features to seed xMatters with your ServiceNow users, groups, and configuration items.

The xMatters application includes a pre-configured role, x_xma_xmatters.xmatters. Assign this role to any users or groups you want to synchronize into xMatters. Assigning this role to a group automatically assigns it to all users within the group, or you can add this role to an existing role to automatically assign it to multiple users.

In previous versions of this integration, the "itil" role was required for all users you wanted to notify via xMatters; now the x_xma_xmatters.xmatters role controls both the synchronization and whether a user can be notified.

Changes to default shift name

Since this version of the integration was released, we changed the name given to the default shift created for every new group in xMatters. This requires a minor code change to the configuration script.

NOTE: If you are upgrading an existing ServiceNow installation, check out the knowledge base article here for more information and suggested workarounds.

If you're installing a new version of the integration:

  1. In ServiceNow, open the xMattersConfig Script Include, and locate the following line (should be line 107):
    this.SHIFTNAME = '24x7';
  2. Change the value of the parameter to 'Default Shift':
    this.SHIFTNAME = 'Default Shift';
  3. Save your changes.

Batch load vs. dynamic sync

There are some fundamental differences between batch data load and dynamic synchronization that you should consider when designing your integration between xMatters and ServiceNow.

  • A dynamic sync is initiated by a business rule, and typically involves a single object, such as a user with a specific role.
  • The process for a dynamic sync occurs in background worker processes while business rules run in the foreground.
  • Batch loads deal with collections of objects, such as ALL users with a specific role, and run entirely in the background.

What this means is that if you add a role flagged for sync to 300 users, the integration will fire the business rule 300 times - once for each affected user - and in turn will perform processing and REST requests to xMatters individually for each user. These business rules run independently from each other, and thus no economies of scale are possible. If the integration needs to determine if a specific user or group in ServiceNow is set as a person or group supervisor in xMatters, all of the logic, look-ups, and updates must be performed each time the business rule fires. The same is true for determining group memberships: even if all members are part of the same group, the integration needs to query the group membership from xMatters once for each time the business rule fires.

Also, the business rule itself must be run in the foreground, even though the REST calls and actual synchronization of data occurs in the background processes during a dynamic sync. This allows current values to be compared against previous values to determine if the sync is necessary.

Batch loads reduce much of this redundancy by performing fewer data lookup queries, and caching the results for re-use. By minimizing redundant network traffic (REST requests) and database look-ups, a batch of user updates can be run much more efficiently, and entirely in background processes.

NOTE: Running a batch load script is a resource-intense process that can significantly affect server performance. This feature processes every user and group in your ServiceNow instance to determine whether they should be synchronized to xMatters. It is recommended that you run the batch load process only when the integration is initially installed, and only during non-peak server times to minimize the server strain and processing time required to complete the synchronization.

Batch load users and groups

The batch data load processes all users, groups, and group members in ServiceNow and attempts to update them in xMatters. If the user or group does not exist in xMatters, it is added; if the user or group already exists in xMatters, it is updated. A user or group that exists in xMatters but not in ServiceNow is not modified by the batch process; updates to these items are handled by the user and group synchronization process based on individual changes only after the initial data load is complete.

NOTE: To prevent groups from attempting to add users that do not yet exist in xMatters, always run Batch Load Users before Batch Load Groups.

To initiate a batch data load:

  1. In the ServiceNow Navigator, under the Integration - xMatters heading, click Batch Load Users.
  2. On the Batch Load Users page, click Load Users.
  3. When the process is complete, click Batch Load Groups.
  4. On the Batch Load Groups page, click Load Groups.

Batch load incident properties

You can populate the configuration_item_list property in the xMatters integration with the configuration items available in ServiceNow. This allows users to subscribe to incidents that occur on a specific Configuration item.

By default, this property is set to include only the value NONE; to use this property, you must seed it with values using the Batch Load Incident Properties script. This retrieves the configuration items as defined by the "Configuration Item Property Query" in the Data Sync configuration page, and sends them to the configuration_item_list property in xMatters.

The code to populate a value in the configuration_item_list property is disabled when the xMatters integration is first installed because, once enabled, the integration validates the entries in all of the list properties, and rejects the event if a configuration item is sent that is not in the list. To enable this feature, open the xMattersConfig Script Include, and change line 46 from:

"SEND_CONFIGURATION_ITEM_LIST: false,"

to

"SEND_CONFIGURATION_ITEM_LIST: true,"

To initiate a batch load of configuration items:

  1. In the ServiceNow Navigator, under the Integration - xMatters heading, click Batch Load Incident Properties.
  2. On the Batch Load Incident Properties page, click Load Properties.

Notifying non-synchronized users

By default, the integration is configured so that ServiceNow only sends incidents to users who are synchronized with xMatters. If you want ServiceNow to be able to send incidents to xMatters users who are not part of the data sync, open the xMattersConfig Script Include, and change line 52 from:

"SEND_TO_SYNCED_ONLY: true"

to

"SEND_TO_SYNCED_ONLY: false"

How to use the integration

After you complete the configuration steps and perform the initial batch data load, you can test notification delivery and response, and the synchronization between xMatters and ServiceNow.

Validate synchronization

The user and group synchronizations work in an identical way, but you should still validate each synchronization independently.

Synchronize a user

When you create, modify, or remove a user in ServiceNow, the system activates a business rule and adds, updates, or deletes the corresponding user in xMatters, along with their device details. 

To test the user synchronization:

  1. In the ServiceNow Navigator, open User Administration > Users.
  2. On the Users page, click New.
  3. Enter the details for a new user on the User page, including first and last names, a user ID, and an email address that you can access (so you can use this user to test the notification portion of the integration in the following sections):

NewSNOWUser.png

  1. Click Submit.
  2. In the Users list, locate the user you just added and click their name.
  3. On the User page, in the Roles area, click Edit.
  4. On the Edit Members page, in the Collection list, select x_xma_xmatters.xmatters and then click Add.
    • As explained above, this role is required for all ServiceNow users that you want to be synchronized with or receive notifications from xMatters.
  5. Click Save

Now log in to your xMatters instance and navigate to the Users page. If the synchronization was correctly configured, it will have added a matching user to xMatters using the settings on the Data Sync configuration page, and the email address as their email device.

Synchronize a group

When you create, modify, or remove a group in ServiceNow, the system activates a business rule and adds, updates, or deletes the corresponding group in xMatters. 

To test the group synchronization:

  1. In the ServiceNow Navigator, open User Administration > Groups.
  2. On the Groups page, click New.
  3. Enter the details for a new group on the groups page, and then click Submit.

NewSNOWGroup.png

  1. In the Groups list, locate the group you just added and click its name.
  2. On the Group page, in the Roles area, click Edit.
  3. On the Edit Members page, in the Collection list, select x_xma_xmatters.xmatters and then click Add.
    • As explained above, this role is required for all ServiceNow groups that you want to be synchronized with xMatters.
  4. Click Save

Now log in to your xMatters instance and navigate to the Groups page. If the synchronization was correctly configured, a group with a matching name is created automatically in xMatters, with a default schedule and an empty roster. To further test the synchronization, add the test user you created for the user synchronization to the new group in ServiceNow, and confirm that the matching user is added to the group in xMatters.

Trigger a notification

To test the incident notification portion of the integration, you can create an incident in ServiceNow and assign it to the user you created for the synchronization test.

To trigger a notification:

  1. In the ServiceNow Navigator, open Incident > Create New.
  2. On the Incident Details page, enter the details for a test incident with a Priority setting of "High" or "Critical".
  3. In the Assigned To field, enter the name of your test user.
  4. Click Submit to trigger the notification.

CreateIncident.png

Respond to a notification

When the notification for the test user arrives on your device, open the message to view its details. For example, the following illustrates how a ServiceNow notification via xMatters might appear in the xMatters mobile app:

Screenshot_20160817-121206.png

You can respond to the message simply by tapping one of the response choices. Other devices use similar methods.

View response results

After you respond to the notification, you can see how the integration automatically updates the Activity section in the incident Notes:

Screen_Shot_2016-08-17_at_12.02.36_PM.png

Engage with xMatters

You can test the Engage with xMatters feature using an existing incident.

To engage with xMatters:

  1. In the ServiceNow navigator, open Incident > Open.
  2. In the list of incidents, click an incident's number to open it.
  3. On the incident's details page, click Engage with xMatters.

EngageWithxMatters.png

  1. In the Engage with xMatters dialog box, enter additional details about the incident in the provided fields, and use the Recipients area to add the people or groups you want to notify.

EngagewithxMattersDetails.png

  1. Click Submit.

View Engage with xMatters responses

 To view responses to Engage with xMatters notifications, use the ServiceNow Navigator to open Integration - xMatters > Miscellaneous > Engage with xMatters Records. Click the number of the record you want to view.

Screen_Shot_2016-08-17_at_12.04.34_PM.png

Troubleshooting

If you are encountering difficulties with the integration and want to view more detailed information, select the Enable Debugging check box on the xMatters Common Configuration page in ServiceNow. This increases the level of detail contained in the log messages for the integration.

To access the xMatters logs in ServiceNow, look in the Integration - xMatters menu, under Miscellaneous > xMatters Logs.

You can also find more information in the Activity Stream for each inbound and outbound integration: while on the Integration Builder tab, expand the inbound or outbound section, click the gear icon beside an integration service, and then click Activity Stream. The Activity Stream contains the incoming (and for outbound integrations, the outgoing) request, any logging statements, and the final event creation messages.  

Extended functionality

The unofficial/official Integration Research and Development wing of xMatters (those clever elves over at the xMatters Labs) devised a couple of cool ways to extend and enhance this integration:

  • Inform with xMatters - An "add-on" for ad-hoc FYI type notifications from ServiceNow.
  • CI Support Groups - An "add-on" for including the upstream and downstream CI groups to the Engage with xMatters form.

Check out each of these enhancements at the links provided, and keep an eye out for future improvements, too! (Remember that these features are in-progress or experimental additions to this integration, and as such we can provide only limited support should you choose to implement them.) 

Download resources

Have more questions? Submit a request

11 Comments

  • 3
    Avatar
    David Wilcher

    Just an FYI

    In ServiceNow, when you're on the xMatters configuration page, you need to be sure to not include any trailing '/' after the URL of your xMatters instance. 

    So your xMatters Hostname value should look like

    https://<yourcompany>.<servername>.xmatters.com

    NOT like
    https://<yourcompanny>.<servername>.xmatters.com/

    The integration doesn't check for a trailing slash in this input, so if you include it you'll see errors in the xMatters log in ServiceNow showing 404's and an endpoint value with two slashes after your hostname.

    Edited by David Wilcher
  • 0
    Avatar
    Don Clark

    Updated the integration to version 4.1.

  • 1
    Avatar
    Don Clark

    I've added a new section explaining the recent changes to the default shift name in xMatters. For more information about this issue, see the knowledge base article here: https://support.xmatters.com/hc/en-us/articles/115005917243

  • 0
    Avatar
    Christine Astle

    Updated the integration to version 4.2

  • 0
    Avatar
    Christine Astle

    Updated version 4.2 communication plan

  • 0
    Avatar
    Christine Astle

    Updated the instructions for installing or upgrading the xMatters app for ServiceNow.

  • 0
    Avatar
    Christine Astle

    Updated the integration to version 5.0.

  • 0
    Avatar
    Jay Uttanoor

    we had an issue seems like as we have this running we found some issues where one of the business rules is effecting core functionality

    'xMatters User Role Sync' this BR seems to run and not associate any child roles. example if itil role has few child roles. when adding this role to user, system only adds itil role 

     

    Solution from servicenow is to update the order of this BR to 101 or higher than 100. Please let us know if this is going to be fixed in a new patch

    Edited by Jay Uttanoor
  • 0
    Avatar
    Christine Astle

    Hi Jay, that sounds like an interesting issue - can you file a support request (click Submit a Request at the top of the support site) so we can dig into this?

  • 0
    Avatar
    Jay Uttanoor

    Thanks have submitted a request

  • 1
    Avatar
    Sonu Sekhon

    Hi Jay,

    As per our discussion via the support ticket, this issue is present in your environment as you're using version 4.0.2 of the integration. The issue was resolved in version 4.1.1. We are now on version 5.0. Furthermore, another workaround to this issue is to use the Role Management V2 plugin in ServiceNow.

Please sign in to leave a comment.
Powered by Zendesk