https://support.atlassian.com/opsgenie/docs/action-filters-in-opsgenie-integrations/
...
Table of Contents | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Overview
A filter is a set condition. Many features of Jira Service Management use filters to provide action execution based on some conditions. You can customise customize to process integration actions with certain incoming data, fire callbacks for particular types of alerts, apply policies to certain alerts, and do a lot more.
For example, Jira Service Management processes all incoming data from integrations, and then it checks them against your integration's actions for execution. Remember that integration Integration actions have a processing order. At most one action can execute on a single webhook. A filter has a condition set. If the first action's Filter alert filter does not match the incoming webhook data, Jira Service Management moves to the next action in line. It then evaluates this action's Filteralert filter. If an action's Filter alert filter matches the data, Jira Service Management executes that action. Then it ends the processing on of that particular webhook. If it finds no matching action, nothing happens. The figure below shows a Create Alert action's Filter. Its In an alert filter, if the condition match type is set to 'Match one or more conditions below'. In “Only alerts that match any condition”, then in the incoming data if the variable 'Status ‘Status Message is equal to ‘Failed' Failed' or 'Still Failing', then Jira Service Management creates an alert according to the setup specified in the Alert Fieldsalert fields. The processing will end ends there. But if an the incoming data with 'Status Message' equal to something other than these comes to Jira Service Management, it will check checks it against the 'Create Alert alert’ action. When that doesn't match, the Filter next filter of the Close Alert below will process.
...
'Close alert’ is processed.
Jira Service Management provides default actions with pre-configured Filter filters and Alert Fields alert fields for every integration. However, you You can customize them any the way you like : - you can edit them, delete them, or add new actions of your own.
There are different three types of 'condition match type' that you can choose select from:
Match all alerts: When this option is selected, the integration action will match All the alerts (no conditions in use): The integration action matches every data that's evaluated against it and cause executes the action to be executed. No specific condition is specified when this option is selected.Match one or more conditions below: With this option selected, if any . You don't need to specify any condition.
Only alerts that match any condition: If even one of the conditions that are specified in the condition set matches the incoming data, it's sufficient for Jira Service Management to go on and execute executes the integration action.
Match Only alerts that match all the conditions below: With this option selected, it's required for the : The webhook data has to match every specified condition in the condition set. If any of them fails, the action will not be executed and isn't executed. Jira Service Management will move moves on to process the next integration action to process, if there is any.
If 'Match one or more conditions below' or 'Match all conditions below' is selected, you will need to you select either option with conditions, specify a list of conditions to evaluate. A single condition looks like:
View file | ||
---|---|---|
|
The four boxes denote in order:
...
for evaluation.
...
The variable in the specific integration's webhook data to evaluate.
The clause of 'Is' or 'Is Not'
...
The functional operation that the variable is expected to comply. The set of operations you can
...
select from changes according to the type of the variable.
The value
...
You can add new conditions to the condition set by clicking on the plus sign, or delete using the bin sign. Remember that all the changes you make will be applied after you save changes.
Condition Operations
Equals
...
of the variable.
Select + Add condition to add more conditions or X icon to delete them.
Condition operations
Equals: Applicable to string, boolean, and number variable types. It returns true if the specified variable's value and the expected value are the same.
ContainsIt is applicable for String, List and Map : Applicable to string, list, and map types. It returns true if the specified variable's value contains the expected string. For maps, the expected value can be contained by key or by value fields.
Is EmptyIt is applicable for String, List and Map empty: Applicable to string, list, and map types. It returns true if the specified variable is empty. For string, it checks character count, for list and map, it checks the size.
Matches (Regex)It is applicable for String, List and Number : Applicable to string, list, and number types.
For String string and Number number types, it returns true if the specified value matches the given regular expression.
For List list types, it returns true if any of the given values matches the given regular expression.
Info |
---|
Regex match operations has 10 seconds timeout limit. If it takes more than 10 seconds, it returns false. |
Contains KeyIt is applicable for Map key: Applicable to map type. It returns true if the specified variable contains the expected value in keys.
Contains ValueIt is applicable for Map value: Applicable to map type. It returns true if the specified variable contains the expected value in values.
Starts WithIt is applicable for String with: Applicable to string type. It returns true if the specified variable starts with the expected value.
Ends WithIt is applicable for String with: Applicable to string type. It returns true if the specified variable ends with the expected value.
Greater Thanthan: It is applicable for Number type. It returns true if the specified variable is greater than the expected value.
Less ThanIt is applicable for Number than: Applicable to number type. It returns true if the specified variable is less than the expected value.
Equals Ignore WhitespaceIt is applicable for String ignore whitespace: Applicable to string type. It returns true if the specified variable is equal to the expected value after removing all whitespace(space, tab, new line, carriage return characters) from both the specified and the expected value.
Alert
...
properties
For any action set up for an integration, an Alias must be defined you must define an Alias and match exactly in it exactly in order for the action to be executed. The An Alias field is a user-defined unique identifier for "open" alerts. Also used in de-duplication, integrations are unable to be saved if an you cannot save the integrations if the Alias field is left empty , nor will are the actions be functional.
View file | ||
---|---|---|
|
Was this helpful?
YesNoProvide feedback about this article
Additional Help
Learn how to use Jira Service Management’s integration framework
Show more
Action filters in Jira Service Management integrations
String processing methods in Jira Service Management integrations
Show more
On this pageCondition OperationsAlert Fields section
CommunityQuestions, discussions, and articles
Info |
---|
Share your feedbackWe 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.) You can either add comments to this page or add a card on the Trello board. |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Criteria for checks |
- Replacing OG with JSM
- Basic grammar & spell check
- US English
- Positive language
- Removing passive voice (wherever necessary)
- Simplifying sentences
- Change V&T
- Replacing old links with new ones