Introduction to the xMattersSyncPack

Download this manual as a PDF file 

This section describes how you can use the xMattersSyncPack to automatically trigger, acknowledge, and resolve SL1 events and xMatters incidents between your xMatters and SL1 systems. The integration is bi-directional and synchronizes SL1 and xMatters.

This SyncPack requires a subscription to ScienceLogic Standard solutions. This SyncPack also requires the Base Steps and SL1 Notifications Base SyncPacks.

The label "SyncPack" is used in place of "SyncPack" in the PowerFlow user interface.

Prerequisites for this SyncPack

This SyncPack requires the following:

  • A subscription to the SL1 Standard solution
  • Base Steps SyncPack version 1.3.2
  • SL1 Notifications Base SyncPack version 1.0.0

The following table lists the port access required by PowerFlow and this SyncPack:

Source IP PowerFlow Destination PowerFlow Source Port Destination Port Requirement
PowerFlow SL1 API Any TCP 443 SL1 API Access
PowerFlow SL1 Database Any TCP 7706 SL1 Database Access

Contents of the SyncPack

This section lists the contents of the xMattersSyncPack.

PowerFlow Applications

  • Bulk Resolve SL1 Events. This application collects resolved incident data from xMatters and clears the corresponding SL1 event. To use this application, the incident description must include the event ID.
  • Get Acknowledged Incidents and Post Data to SL1. This application collects acknowledged incident data from xMatters and acknowledges the corresponding SL1 event. To use this application, the incident description must include the event ID and you must run the "Save Accounts To Cache" application.
  • Get Event Details and Post Incident URL to SL1. This application collects event details from SL1 and creates a new incident in xMatters. This application can optionally populate the External Ticket ID field with a link to the xMattersincident.
  • Get Oncall Details and Post Oncall List to SL1. This application collects xMatters oncall details and populates the corresponding SL1 event notes with oncall details.
  • Pass Acknowledgment details from SL1 to xMatters. This application collects acknowledged event data from SL1 and updates the corresponding xMatters incident. To use this application, the incident description must include the event ID.
  • Pass Resolution to xMatters from RBA. This application collects resolved event data from SL1 and updates the corresponding xMatters incident. To use this application, the incident description must include the event ID.
  • Save Accounts to Cache. This application collects user details from SL1. The user's email address is used by the "Pass Acknowledgment details from xMatters to SL1" application to match the acknowledging user in xMatters to the SL1 user.

For more information about how to configure these applications, see Configuring and Aligning a Configuration Object in PowerFlow.

Configuration Object

  • Xmatters Config Template. This configuration object can be used as a template after the SyncPack is installed on the PowerFlow system. The configuration object includes the following:
  • Details for connecting to the SL1 API, including the URL, username, and password
  • Details for connecting to the xMatters API, including the API webhook, instance URL, group ID, username, and password.
  • Details for connecting to an HTTP Proxy when communicating with xMatters, including the hostname or IP address, username, and password
  • Mapping between SL1 events and xMatters incidents including, the default acknowledged user, whether an xMatters link should be added to the SL1 event, and whether an event should be resolved from xMatters.

Steps

The following steps are included in this SyncPack:

  • Accounts to URI Mapping
  • Create Bulk SL1 Payloads
  • Converting Xmatters Incident Response into SL1 Payload
  • Post Event Details To Xmatters
  • Get Acknowledger Details From XM
  • Get Acknowledgment From SL1 And Pass to Xmatters
  • Get Acknowledged Incidents
  • Get Event Details from SL1 Create Xmatters Alert
  • Get Resolved Incidents And Pass To SL1
  • Get Oncall Details from Xmatters

Installing the SyncPack

A SyncPack file has the .whl file extension type. You can download the SyncPack file from the ScienceLogic Support site.

Downloading the SyncPack

If you are installing or upgrading to the latest version of this SyncPack in an offline deployment, see Installing or Upgrading in an Offline Environment to ensure you install any external dependencies.

To locate and download the SyncPack:

  1. Go to the ScienceLogic Support Site at https://support.sciencelogic.com/s/.
  2. Click the Product Downloads tab and select PowerPack.
  3. In the Search PowerPacks field, search for the SyncPack and select it from the search results. The Release Version page appears.
  4. On the PowerPack Versions tab, click the name of the SyncPack version that you want to install. The Release File Details page appears.
  5. Click the Download File button to start downloading the file.

After you download the SyncPack, you can import it to your PowerFlow system using the PowerFlow user interface.

Importing the SyncPack

To import a SyncPack in the PowerFlow user interface:

  1. On the SyncPacks page () of the PowerFlow user interface, click Import SyncPack. The Import SyncPack page appears.
  2. Click Browse and select the .whl file for the SyncPack you want to install. You can also drag and drop a .whl file to the Import SyncPack page.
  3. Click Import. PowerFlow registers and uploads the SyncPack. The SyncPack is added to the SyncPacks page.
  4. You will need to activate and install the SyncPack in PowerFlow. For more information, see Activating and Installing a Synchronization PowerPack.

You cannot edit the content package in a SyncPack published by ScienceLogic. You must make a copy of a ScienceLogic SyncPack and save your changes to the new SyncPack to prevent overwriting any information in the original SyncPack when upgrading.

Installing the SyncPack

To activate and install a SyncPack in the PowerFlow user interface:

  1. On the SyncPacks page of the PowerFlow user interface, click the Actions button () for the SyncPack you want to install and select Activate & Install. The Activate & Install SyncPack modal appears.

    If you try to activate and install a SyncPack that is already activated and installed, you can choose to "force" installation across all the nodes in the PowerFlow system.

    If you do not see the PowerPack that you want to install, click the Filter icon () on the SyncPacks page and select Toggle Inactive SyncPacks to see a list of the imported PowerPacks.

  1. Click Yes to confirm the activation and installation. When the SyncPack is activated, the SyncPacks page displays a green check mark icon () for that SyncPack. If the activation or installation failed, then a red exclamation mark icon () appears.
  2. For more information about the activation and installation process, click the check mark icon () or the exclamation mark icon () in the Activated column for that SyncPack. For a successful installation, the "Activate & Install SyncPack" application appears, and you can view the Step Log for the steps. For a failed installation, the Error Logs window appears.
  3. If you have other versions of the same SyncPack on your PowerFlow system, you can click the Actions button () for that SyncPack and select Change active version to activate a different version other than the version that is currently running.