Skip to content

Jira issue exportπŸ”—

Configure Jira issue export to automatically submit Jira issues from one or more AQtive Guard instances. The export creates a Jira issue for each instance that includes the following information:

  • Key: the project key for the target Jira project
  • Issue Type: the configured Jira issue type (Story, Task, Bug, Epic)
  • Priority: assigned to the instance during analysis (High, Med, Low)
  • Title: the cryptographic rule (profile policy) that detected the instance
  • Description:
    • description of the cryptographic rule
    • name of the instance
    • link to the instance in AQtive Guard

Refer to Issues and Instances fundamentals to learn more about the relationship between issues and instances.

PrerequisitesπŸ”—

To enable Jira issue export, you will need:

  • Admin access to AQtive Guard.
  • Coordination with a Jira Administrator to configure the integration and initiate the configuration link.
  • The Jira Project Key for the designated project to receive the exported issues.

Jira project considerationsπŸ”—

Consider the following when selecting a Jira project for the export:

  • You can link to only one Jira project at a time.
  • You can update the project key to switch projects at any time.
  • Issues are sent to the project configured at the time of export.
  • A Jira issue is created for each instance, with bulk export limited to the first 50 highest-severity instances.

Jira Team-managed projectsπŸ”—

A Team-managed project in Jira may require issue type configuration to enable these required export fields:

  • Summary
  • Description
  • Priority
  • Labels

To configure a Jira Issue type, navigate to your Jira project’s sidebar. Select Project settings, then Issue types.

Note

Make sure that these required fields are enabled in the default issue type designated for export. For example, if you’ve set Bug as the default export issue type in AQtive Guard, ensure that the necessary fields are properly configured within the Bug issue type in Jira. You can find more detailed information on setting up issue types in team-managed projects on the Jira Software Support site.

ConfigurationπŸ”—

There are three main steps to configure Jira issue export:

  1. In AQtive Guard: Configure your Jira instance URL.
  2. In Jira: Configure the link.
  3. In AQtive Guard: Specify a Jira project and initiate the link.

Note

This organization-level configuration establishes the default Jira export integration for all AQtive Guard projects. Use the project-level integration to configure the Jira project and Issue type for a specific AQtive Guard project.

The sections that follow provide detailed instructions for each configuration step.

Configure your Jira instance URLπŸ”—

  1. Log in to the AQtive Guard Web Interface as an admin.
  2. Select Integrations from the menu bar.
  3. From the integration options, select Jira, then Jira Issue Export.
  4. Enter the base URL of your organization’s Jira instance where prompted.

    The base URL format is:

    - Jira Cloud - https://organization-domain.atlassian.net/

    - Jira Server - a Jira administrator can find the base URL under system settings.

  5. Select Next to reveal the information you’ll need to configure the link.

Tip

Keep the AQtive Guard window open to Configure Your Jira Instance and Initiate the Link as you configure the link in Jira. This page contains information you must copy to complete the required entries.

  1. Open a new tab and log in to Jira as an administrator.
  2. To configure the application link, carefully follow the on-screen instructions in AQtive Guard as you copy and paste the required information into Jira. Be sure to Save the link when prompted.
  3. After entering the Incoming Authentication fields in Jira, select Link in AQtive Guard to initiate the link.

To finish the configuration, provide a Jira Project Key, and select a default Jira Issue Type for exported instances.

If you don’t know your project key or default issue type, leave them blank for now. You can update them at any time.

Caution

If you leave the project key and issue type blank, the export will not work until those have been configured. See Update export configuration for details.

Be sure to select Finish to save the integration link.

Caution

You must select Finish to save the information you entered. Failure to do so will result in losing all previously entered data, requiring you to restart the integration process from the beginning.

Update export integrationπŸ”—

After establishing a connection with Jira, you can modify the default Jira project key or issue type whenever needed. Issues are sent using the configuration at the time of export:

  • Organization export configuration sets defaults used when no project-level integration has been configured.
  • Project-level export configuration takes precedence over defaults for a configured project.

Organization export configurationπŸ”—

Follow these steps to update the default Jira project key or issue type for all AQtive Guard projects.

  1. Log in to the AQtive Guard Web Interface as an admin.
  2. Select Integrations from the menu bar.
  3. From the integration options, select Jira, then Jira Issue Export.
  4. Provide a Jira Project Key, select a default Jira Issue Type for exported instances, and then Save.

Project-level export configurationπŸ”—

Follow these instructions to update the Jira project key or issue type for a specific AQtive Guard project.

  1. Log in to the AQtive Guard Web Interface as an admin.
  2. Select Projects from the menu bar, then select the desired project name to open the project Overview.
  3. Select the Integrations tab.
  4. Provide a Jira Project Key, select a default Jira Issue Type for exported instances, and then Save.

Unlink the Jira integration only if your organization needs to reconfigure or stop data sharing with Jira.

To unlink the Jira configuration:

  1. Log in to the AQtive Guard Web Interface as an admin.
  2. Select Integrations from the menu bar.
  3. From the integration options, select Jira, then Jira Issue Export.
  4. Select Unlink.

Caution

If you unlink, information transfer between AQtive Guard and Jira will stop, and you’ll need to reconfigure. This action can’t be undone.

UseπŸ”—

Jira issue export can export a Jira issue for an individual AQtive Guard instance, or initiate a bulk Report export of Jira Issues for up to 50 of the highest-priority instances.

Refer to Issues and Instances fundamentals to learn more about the relationship between issues and instances.

Single instance exportπŸ”—

Follow these instructions to export an AQtive Guard instance as an individual Jira issue.

Note

If both Jira form integration and Jira Issue export are configured, form integration is used for single issue export. In that case, instead of creating a link, the following instructions will launch an editable form populated with information about the selected instance.

  1. Select an issue in an AQtive Guard report.
  2. Select an individual instance within the issue to view its details.
  3. Select Export, then Jira to export a Jira issue populated with information about the selected instance.
  4. A link is provided to view and edit the Jira issue.

Important

Selecting Export from a report instead of the instances page launches a bulk export of Jira Issues for the full report.

Bulk instance export from a ReportπŸ”—

To export Jira Issues in bulk from multiple instances in a report:

  1. Navigate to the desired AQtive Guard report and select Export.
  2. In Report export, select Jira.
  3. Follow the prompts to export Jira Issues for up to 50 of the highest-priority instances.