Understand the integration framework

1 Overview
2 Add integration
3 Define rules for the integration
- 3.1 Incoming | Rules for creating and processing alerts
- 3.2 Outgoing | Rules for taking actions in the integrated applications

Overview

A Compass integration is a connection between your Compass account and other apps in your IT environment. When they’re connected, you get alerts from your IT apps, all centralized in Compass, and you can also access the alert bucket that’s created. You can create custom automation rules for each integration to update and edit data or take custom actions by triggering the connected apps.

Add integration

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select an application of interest.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
On the next page, expand the Steps to configure the integration section.
Follow the instructions to configure the integration for either end (if it’s an incoming or outgoing integration) or for both ends (if it’s a bidirectional integration) as applicable.
Define rules for creating alerts and processing them and define actions to take actions against alerts.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Define rules for the integration

Compass offers two rule sets:

Rules for the incoming part of the integration to define rules for creating and processing alerts
Rules for the outgoing part of the integration to define rules for taking actions in the integrated applications

Incoming | Rules for creating and processing alerts

These rules define how Compass behaves when it receives data from an integrated application. In other words, it’s a way to automate the behavior of new or existing alerts in Compass when they are triggered by an event that occurs in the integrated application. You can acknowledge or update an alert, add a note to an alert, close an alert, or create alerts.

When you first create the integration, some rules become available by default (Create alert, Close alert, Acknowledge alert, and Add note to alert). Unless you turn them off, they start working the moment you turn on the integration.

Create alert: Select this option to create an alert each time your predefined action occurs in the integrated application. For example, you can have an alert created for an incident raised in the application or when the status of an incident changes. For each action, you can customize the alert Jira Service Management creates. Read more about alert filters.

Close alert: Closes the alert each time a predefined action occurs in the integrated application.

Acknowledge alert: Acknowledges the alert each time a predefined action occurs in the integrated application.

Add note to alert: Adds note to the alert each time a predefined action occurs in the integrated application.

Ignore: Select this option for the actions that you don’t want to receive alerts.

You can set the integration based on these rules and modify the alert fields depending on your requirements. Alert properties vary according to the capability of each rule type. Read more about dynamic properties.

You can edit the default rules or add more rules in the incoming section. Once you set your rules and turn on the integration, Compass applies the rule from top to bottom, in its set order - if your first rule is for “Ignore” action and second is “Create alert”, and, if the data you receive from the integrated application matches the conditions of both rules, Compass stops at the first match – the “Ignore” action. It won’t create an alert.

Outgoing | Rules for taking actions in the integrated applications

Rules in the outgoing section define how Compass alerts affect your integrated application. You can create two types of rules in the outgoing section:

Send alert updates back to the integrated application

Select this rule type to update the data in the integrated application. The following is what the flow looks like:

A rule in the incoming section creates an alert in Compass for some event occurring in the integration application
Something about the alert changes in Compass
Compass sends this update back to the integrated application and updates an associated entity.

In this section, the alert actions and their corresponding actions to be taken in the integrated application are presented in a natural language. Some actions such as “a tag is added to alert” might require user input to work properly. If you leave the input field empty, the rule applies to all values. If you want to limit the input, enter the values manually, then press Enter. This is similar to how you add tags to an alert.

Define actions for alerts manually created or by other integrations

Select this rule type to define actions for alerts that are either manually created or by other integrations you have set up in Compass. However, with this option, you’re taking actions in an integrated application against alerts you received from your other integrated tools.

Create a filter to select which alerts you wish to apply this rule to. You can turn on and turn off each of these rules at any time, even when the integration is turned on. Similar to incoming automation rules, Compass applies the rule from top to bottom and stops once it matches with a rule. So, how you order the rules matter. Very much like in the incoming section, you can order these rules by dragging and dropping them. When you’re done with setting all the rules, turn on the integration from the top of the page.

Operations