Sonatype for Jira Data Center

Sonatype for Jira Data Center

Sunsetting Notice

For details on what “Extended Maintenance” and “Sunsetted” mean, see Sonatype Sunsetting Information.

Sonatype for Jira Data Center is an Atlassian Jira plugin that automates the creation of Jira issues for new policy violations.

The Sonatype for Jira Data Center integration is available on the Atlassian Marketplace.

Workflow overview

  1. The plugin is integrated by the Jira Administrator to communicate with the Lifecycle server
  2. Jira Administrators associate projects with applications in Lifecycle
  3. Administrators identify the policies to create Jira issues
  4. Tickets are created for new violations in Jira projects
  5. Remediated violations are updated in the corresponding tickets

Release Notes

iq-jira-plugin

Changelog

Version 3.0.1 (April 08, 2026) Anchor

Version 3.0.0 (September 03, 2025) Anchor

Version 2.2.0 (April 21, 2025) Anchor

Version 2.1.0 (December 03, 2024) Anchor

Version 2.0.3 (September 30, 2024) Anchor

Version 2.0.2 (September 30, 2024) Anchor

Version 2.0.0 (September 27, 2024) Anchor

Version 1.11.0 (March 11, 2024) Anchor

Version 1.10.2 (February 8, 2024) Anchor

Version 1.10.0 (February 2, 2024) Anchor

Version 1.9.1 (June 15, 2023) Anchor

Version 1.9.0 (November 23, 2022) Anchor

Version 1.8.1 (July 29, 2022) Anchor

Version 1.8.0 (July 15, 2022) Anchor

Version 1.7.1 (June 16, 2022) Anchor

Version 1.7.0 (March 23, 2022) Anchor

Version 1.6.0 (September 28, 2020) Anchor

Compatibility

iq-jira-plugin

Compatibility

Plugin Version IQ Server Version Jira Version Java Runtime
3.x 98 and higher Data Center 11.x JDK 21
2.1.0 98 and higher Data Center 10.5 to 10.7 JDK 17
2.0 to 2.1.0 98 and higher Data Center 10.0 to 10.4 JDK 17
1.x 98 and higher Server and Data Center 8.x and 9.x JDK 11

Requirements

For details on the Jira Data Center versions supported, please check the plugin's Atlassian Marketplace listing.

Note
The Sonatype for Jira plugin is verified by Sonatype to work on the Jira Data Center

Installation

The initial installation is only required once and will apply to all Jira projects. This configuration enables the integration between Jira and Sonatype IQ Server.

Important
When migrated from Jira Server to Jira Data Center from version 1.10.2 or previous versions, uninstall the previous plugin and re-install a data center-compatible version. The server-compatible plugin versions cannot be automatically upgraded to data center-compatible versions.

Configure the plugin

Configuration of the Sonatype for Jira Data Center plugin is done at the global Jira instance level.

  1. In Jira, navigate to the settings icon.
  2. Click Applications.
  3. Under Integrations, click Sonatype for Jira.
  4. Enter the Sonatype for Jira Configuration parameters.
  5. Click Save.
  6. Click Test to confirm connection to the Lifecycle server.
  7. Click Create webhook to add a webhook.

Manually configuring the Lifecycle server webhook

Manually configure a webhook using these configure webhook steps

Jira project to Lifecycle server associations

Sonatype Lifecycle organizations/applications are associated with a specific Jira project. Follow the steps below for each Jira project intended to receive policy violation notifications from the Sonatype IQ Server.

Configure mapping between a Jira project and an organization and/or application within the Lifecycle server

  1. Navigate to the desired project in Jira.
  2. Click on the Project Settings gear icon in the lower left of your screen.
  3. Click on the Sonatype menu option. If the page is empty after clicking the link, sign into Jira with a user with Administer Project permissions for the project.

A Jira project can be mapped to one or more Lifecycle organizations or applications. When new violations occurs, new issues are created.

#### Issue Type The form fields will vary based on the selected issue Jira issue ticket type to be created
#### Issue Aggregation - By Component - creates a parent issue and adds each component in the report as a sub-task\n

- By IQ Evaluation - creates a single issue for all violations from the report
#### IQ Applications Set the applications associated with the project
#### IQ Organizations Set the organizations associated with the project
#### Labels Specify one or more Jira labels for the tickets created
#### Automate Workflow Transition Apply workflow transition when the violations are remediated
#### Workflow Transition The workflow transition to be applied when the violations are remediated
#### Reporter The account associated with the automatically created tickets

Automate Workflow Transition

Sonatype for Jira will attempt to apply the selected Workflow Transition to issues when policy violations are successfully remediated.

Configure Notifications to Jira

The Jira notification creates a Jira issue when new policy violations are discovered. To create Jira notifications, install the Jira plugin and configure its communication with the Lifecycle server via a webhook (see above). To configure Jira notifications:

  1. Select the policy for which notifications will be created upon its violation.
  2. Click Webhook from the Recipient Type option.
  3. Select the appropriate Webhook from the Select Webhook option.
  4. Select Add.
  5. Specify the stages to create notifications.

Review violation tickets within the plugin

When Lifecycle detects violations, new issues are created on the project board with the New status. Example of issue aggregation of By IQ Evaluation

A subtask is created for each of the components attached to the primary report scan ticket for the issue aggregation of By Component

The following fields are populated as follows:

Threat Level Jira Priority
9-10 Highest
7-8 High
4-6 Medium
2-3 Low
0-1 Lowest

Note
Priority names for your organization can be different if they've been customized in Jira settings by a Jira admin.

Supported and unsupported field types

Default values are required for mandatory fields in Jira. The plugin will ignore the unsupported fields if they are marked optional in Jira. The supported fields are: Number, Paragraph, Short text, Select list (single choice), Select list (multiple choices), URL, Radio, Labels

Supported Custom Field Types

Jira Integration troubleshooting tips

Jira logging

Error messages are sent to Jira's default log4j logger of levels WARN or higher. Log levels can be temporarily changed by navigating to the SystemLogging and Profiling tab on the Jira administration page. To make log changes permanent or for advanced log4j settings, edit 'WEB-INF/classes/log4j.properties'. The logging of the Jira plugin can be customized using the following log levels:

Package Description
Plugin events have the following prefix:
com.sonatype.jira
iq.data.service.WebhookService Events with Webhooks.
Log levels used are INFO for success messages and ERROR for failures.
iq.data.service.ConfigurationService Configuration errors are displayed directly in Jira's web interface.
Currently, this is only used for logging internal errors at ERROR level.
iq.data.service.IqClientImpl Errors communicating with the IQ Server are logged at ERROR level.
iq.data.service.PolicyAlertTrackingServiceImpl Policy violations are stored for de-duplication in Jira's local database as logged at DEBUG level.
iq.rest.IqIssueResource HTTP messages are logged at DEBUG level.
iq.rest.AdminResource User interactions in the 'Project settings' are logged at INFO level and failures at WARN level.
iq.issue.IssueResolverImpl Workflow transitions that could not be successfully applied are logged at INFO level.
Issue resolution and transitions are logged at DEBUG level.