Understand the integration types, advanced settings, alert actions, action filters, and more.
https://support.atlassian.com/opsgenie/docs/the-integration-framework/
...
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
A Jira Service Management integration is a connection between your Jira Service Management account and other apps in your IT environment. When they’re connected, you’ll you get alerts from your IT apps, all centralized inside in Jira Service Management, and you can also access an the alert bucket that’ll be that’s created. Create You can create custom automation rules for each integration to update and edit data , or take custom actions by triggering the connected apps.
Creating the integration
To create an integration, you must first select Add integration by going to Settings > Integrations. Here you’ll get Jira Service Management’s current integrations. Learn Jira Service Management’s integration types. Currently, Jira Service Management’s new integration framework is only available for Jira Software Cloud and Jira Service Management Cloud, which are highlighted with New tag.
To start setting the integration, select the app:
Integration name: Add a name for your integration.
Assigned to team: Jira Service Management will set this team as an alert responder. This means that integration will send the alert notifications according to this team’s rules.
Connection: This is your connected Jira site. Jira Service Management can automatically detect your connected sites. You can also connect Jira sites manually.
Learn how to connect Opsgenie with a Jira Software Cloud (link)Project: The integration will be triggered with the issues of the selected project. You can select projects from the connected Atlassian sites.
Suppress notifications: This mutes notifications. When you mute alert notifications, the responders won’t receive email, SMS or voice notifications.
...
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 aname 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
Jira Service Management offers two rule sets; Incoming automation rules and Outgoing automation rules.
...
:
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 Jira Service Management behaves when it receives data from Jiraan integrated application. In other words, it’s a way to automate the behavior of new or existing alerts in Jira Service Management when they are triggered by a Jira actionan 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 a new alert through Jira issues.
There are five action types to an incoming automation rule. You can set the integration based on these actions and design the alert fields depending on your requirements. Alert fields vary according to the capability of each action. Learn more about dynamic fields.
The action types to the incoming automation rules are:
Ignore alert: Overrides the rules for the selected conditions. Select this option for the actions that you don’t want to receive an alert for.
Create alert: Creates an alert each time your pre-defined action occurs in your Jira projectalerts.
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.
| Expand | ||
|---|---|---|
| ||
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. Learn more about action 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 |
...
When you first create the integration we’ll provide some default rules. Unless you disable or delete them, they’ll start working when you enable the integration. These rules are:
...
Create Alert: Whenever a Jira issue is created in your selected project, Jira Service Management creates a new alert.
...
Close Alert: Whenever the Jira issue that created the alert is updated to Resolved, Closed, or Done, Jira Service Management closes the alert.
...
Acknowledge Alert: When the Jira issue that created the alert is updated to ‘Work In Progress’ or ‘Pending’, Jira Service Management acknowledges the alert.
...
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. Learn more about dynamic fields. |
You can edit the default rules or add more rules to an in the incoming automationsection. Once you set your rules and enable turn on the integration, Jira Service Management will apply applies the rule from top to bottom, in its set order . This means that, - if your first rule is for “Ignore” action and second is “Create alert”, and, if the data you receive from Jira the integrated application matches the conditions of both rules, Jira Service Management will stop 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 Jira Service Management alerts affect your Jira project. There are integrated application. You can create two types of automation rules you can create for an outgoing automationrules in the outgoing section:
Send alert updates back to
...
the integrated application
Choose Select this rule type to update a Jira issue when the alert triggered by that issue gets an update in Jira Service Management. When an alert is created with an Incoming Automation rule, through an issue created in Jira, and when that alert gets an 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 Jira Service Management for some event occurring in the integration application
Something about the alert changes in Jira Service Management
Jira Service Management sends this update
...
back to
...
the integrated application and updates
...
an associated entity.
In this section, the alert actions and their corresponding Jira actions in a sentence structureactions 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 perform work properly. If you leave the input field empty, the rule will apply 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
Similar to the previous rule type, you can choose Select this rule typeto trigger a Jira issue with an alertdefine actions for alerts that are either manually created or by other integrations you have set up in Jira Service Management. However, with this option, you’re triggering Jira issues with taking actions in an integrated application against alerts you received from your other integrated tools.
To define this rule type, first create Create a filter to choose select which alerts you wish to apply this rule for. Then, define properties of the issue you want to trigger. The fields you can edit change depending on the issue type. Later, you can define the actions you want to take for the issue. Later, when Jira Service Management receives an alert matching your filter, it will trigger your Jira to take your chosen action (adding a comment, changing the issue status…etc.). You can enable and disable You can turn on and turn off each of these rules at any time, even when the integration is enabledturned on. Similar to incoming automation rules, Jira Service Management will apply applies the rule from top to bottom and stop stops once it matches with a rule. So, how you order the rules matter. Unlike incoming automation rulesVery 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
...
Share your feedback
We would love to receive feedback about this documentation, the product experience, functionality, or anything you’ve got to share.
(Simpler: Do you have any feedback about this documentation, your product experience, or any functionality? We'd love to hear from you.)
...
page
...
.