Jira Changes
The Jira Changes integration notifies BigPanda of any new or updated changes in your Jira Change Management.
The BigPanda Jira app creates a Jira webhook that sends BigPanda all new and updated issues matching the customer-provided JQL filter. The change data is processed and normalized according to the configuration provided in the BigPanda Jira app. The prepared change record is then sent to the BigPanda Console.
Once in the console, these changes are available for use in the RCA process with BigPanda's Root Cause Changes feature.
| Supported Versions | Type | Authentication Type |
|---|---|---|
| Jira Cloud Jira Server | Native App Webhook | API Key and Bearer Token |
Key Features
- Native app to easily integrate BigPanda with Jira.
- JQL filters to target your projects and issues for change management.
- Easy configuration via the configuration form located in the BigPanda Jira app, where you can:
- Map custom statuses in Jira to BigPanda statuses.
- Map custom fields in Jira to BigPanda tags.
- Hide any undesired fields from the BigPanda UI.
Data Models
BigPanda converts and organizes Jira issue information into tags.
Default Field Mapping
| BigPanda Tag | Jira Field | Description |
|---|---|---|
identifier | key | The unique identifier for the change. |
status | status.name | The change status. |
start | created | When the change started. |
summary | summary | Summary of the change. |
end | resolutiondate | When the change ended. |
The default mapping between Jira fields and BigPanda tags can be customized in the app configuration.
Default Status Mapping
| BigPanda Status | Jira Statuses | Description |
|---|---|---|
Planned | [none] | A change has been planned but is not yet in progress. |
In Progress | open, reopen, in progress | A change is currently in progress. |
Done | resolved, done, closed | A change was resolved. |
Canceled | [none] | A change was cancelled or aborted. |
The default mapping between Jira and BigPanda statuses can be customized in the app configuration.
Manage the Integration
Jira Cloud
Install the Integration
Administrators can install the integration by following the on-screen instructions in BigPanda.
Configure the Integration
In the main Jira menu, select BigPanda to open the configuration editor.
General Section
The General section allows you to specify the Jira field name for the following BigPanda tags:
startendsummary
Status Names Section
The Status Names section allows you to specify:
- The Jira field for the change status.
- The mapping of Jira statuses to BigPanda statuses.
Field Format
Provide a comma-separated list of Jira statuses for each BigPanda Status (ie: done, resolved, closed, completed)
Tags Section
By default, all Jira issue fields are mapped to tags in BigPanda using their field names.
Customize Jira field names and BigPanda tag names in the Tags section.
Metadata
BigPanda Changes allows you to hide specific tags from the Console without losing the ability to leverage these tags in correlation. To use the Metadata section to hide specific tags, provide a comma-separated list of the field names you wish to exclude.
Jira Server
Configure the webhook
A webhook URL needs to be created with all the necessary query parameters to make sure BigPanda processes the Jira Issues correctly.
This table represents all the required and optional query parameters the webhook can leverage.
| Query Parameter | Value Options | Description |
|---|---|---|
api_key | required BigPanda API Key | |
app_key | required App key for the Change API integration. | |
override_status_field | true/false | required Overrides the default status field. |
status_name | Jira field | If override_status_field is set to true, this parameter is required. |
override_status_mapping | true/false | required Overrides the default status mapping. |
status_mapping | URI encoded Object Object keys: BigPanda Change statuses Object value: Array of Jira statuses to match See example below | If override_status_mapping is set to true, this parameter is required.Reference default status mapping |
start | Jira field | Overrides the default start field |
end | Jira field | Overrides the default end field |
summary | Jira field | Overrides the default summary field |
tags | URI encoded Object Object keys: Jira field Object value: BigPanda tag name | This parameter allows you to provide a user friendly name to any Jira field. |
metadata | URI encoded Array Ex: ["jirafield"] encoded: %5B%22jirafield%22%5D | This list of Jira fields will hide from the BigPanda Console. |
- Start with the base URL: https://inbound.bigpanda.io/jira/changes
- Add the required query parameters to the URL. Below a basic example of a fully formed URL
https://inbound.bigpanda.io/jira/changes?api_key=1234567890&app_key=0987654321&override_status_field=false&override_status_mapping=false - Add any additional query parameters to meet your desired configuration
URL Encoding
For the status_mapping and tags parameters, it is required to URI encode the values. Here is an example of this encoding
Sample Status Mapping
{
"Planned": ["approved", "in review"],
"In Progress": ["pending"],
"Done": ["done", "finished"],
"Canceled": ["cancelled", "rejected"]
}
URI Encoded Object
%7B%22Planned%22%3A%20%5B%22approved%22%2C%22in%20review%22...
Note: All extra spaces must be removed prior to encoding the object
Create the Webhook
- Log into your Jira instance.
- In the left panel, go to Jira Settings > System > Webhooks.
- Click on Create a Webhook
- Enter a name for the webhook
- Add your generated webhook from the previous step.
- Add a JQL Query to the webhook so that only the projects you want are pushed to BigPanda
- Check the Issue
createdandupdatedcheckboxes. - Click create at the bottom.
Uninstall the Integration
Deleting an integration requires changes to both the integrated system and BigPanda. You must uninstall the integration on the integrated system and then delete the integration from BigPanda.
When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.
Stop Sending Data from BigPanda
In BigPanda, disable any settings that send data to the integrated system. This includes modifying or removing AutoShare rules or Environments that are tied to the integration.
Stop Sending Data to BigPanda
Disable any settings that send data to BigPanda.
Jira Cloud
- Uninstall the app by navigating to Jira Settings > Apps > Manage apps.
- Use the Uninstall button for the BigPanda App.
Jira Server
- Uninstall the app by navigating to Jira Settings > System > Webhook.
- Select the BigPanda webhook and click on the delete button
Updated 2 months ago