Sync alerts with service and software projects
This article highlights a new alerting feature that's natively available in Compass which is gradually rolling out to some Compass Cloud customers. It may not yet be visible or available on your site.
Sync is available only on Compass’s Standard and Premium plans at a team level and only on Premium plan at a site level.
On the Sync page, either in your on-call team or Compass site, select Create sync.
Fill in some important details for your sync:
Choose your project’s Jira site: You can choose projects that exist in the same site or in a different site.
Name: Name your sync to easily find it later.
Assignee team: You can select a team to own this sync. It’s optional, so you can skip selecting an assignee team.
Project: Select the project on the current site (a Jira project or a Jira Service Management project) you want to use for this sync. Once the sync is created, you can only change to another project of the same nature. So, a sync created for a software project can’t be switched to a service project later on.
Project type: Select the type of the project on the different site (a Jira project or a Jira Service Management project) you want to use for this sync.
Turn off notifications: Select this option if you wish to mute notifications for alerts created by this sync. When notifications are off, you won’t receive notifications.
Select Continue to save the sync.
The sync is OFF by default. When you’re ready, select Turn on sync to proceed or Close to leave without turning on the sync.
Once the sync is saved, you’ll be able to see it on the Sync page, where you can select the use More actions to directly manage your sync.
Configure the sync
To configure your sync as per your team’s preferences, select Edit in Sync settings to change any values you previously set for the sync.
Set rules for creating and processing alerts
Select Add rule to create a rule that creates or updates alerts that match certain conditions. You can define rules to create an alert, acknowledge an alert, add a note, or close an alert. Some rules are added by default when you create a sync.
Name: Name your rule to easily identify it later.
Rule type: Select the action you want this rule to perform when the rule is run.
Alert filters: You can add alert filters to set the conditions that the alert must match for the rule to run.
All the alerts: No conditions are in effect, so all alerts will cause this rule to run. This is the default setting.
Only alerts that match any condition: When there are alerts that match one or more conditions, the rule will run and execute the selected action.
Only alerts that match all the conditions: When there are alerts that match all the conditions, the rule will run and execute the selected action.
Alert properties: Fill in the details you want to add to the corresponding alerts. This isn’t applicable if the selected action is Ignore.
Select the Turn on now setting if you want to immediately turn on the rule, and select Add to continue.
You can edit, turn off, and duplicate the rule from the More actions.
You can drag and drop the rules within a group to rearrange the order of execution.
Set rules for taking actions against alerts
Select Update issues against alerts created by this sync and Add rule to set up a rule that updates existing issues in your project based on alert events caused by this sync.
Project type | Events to run the rule | Actions to be run by the rule |
---|---|---|
Software (Server) |
|
|
Software (Cloud) |
|
|
Service (Server) |
|
|
Service (Cloud) |
|
|
Select Create and update issues against alerts created by integrations or other syncs and select Add rule to set up a rule that creates an issue based on alert events caused by integrations or other syncs.
Create issue when: Select the alert event that must create the issue.
Issue properties: Select the Issue type and the Issue fields you wish to use in the new Issue.
Select Add actions to define update actions to perform on the newly created issue based on alert events caused by this rule.
Select the Turn on now setting if you want to immediately turn on the rule, and select Add to continue.
You can edit, turn off, and duplicate the rule from the More actions.
Set up outgoing authentication
If you’re syncing with a project that exists on a different Jira site, then you need to set up outgoing authentication for the rules to take actions against alerts to work, with a Jira Edge Connector, a Compass account, or both.
In Sync settings, select Edit. In the Authenticate for sending alert updates to service project section, select an authentication method.
To authenticate with your Compass account, fill in the following information:
Project's Jira site URL: Enter the full URL of your Jira site, including
https://
orhttp://
.Service project key: Enter the KEY of the service or software project.
Issue type name: Enter the name of the issue type you want to use to create your issue.
Email address: Enter the email address you use to log in to your Jira Service Management account.
API token: Enter Atlassian account API token. View your API tokens or read how to create a new API token.