Skip to content

Jira form integration🔗

Set up Jira form integration to open an editable form from the AQtive Guard instance page, allowing you to modify and export a single Jira issue.

Important

Jira form integration requires the Jira Issue Collector, which is only available in a Jira company-managed project. Consult your Jira Administrator for more information.

Prerequisites🔗

To configure Jira form integration, you will need the following:

  • Admin access to AQtive Guard
  • Coordination with a Jira Administrator to perform the required configuration steps in Jira

Configuration🔗

There are three main steps to configure Jira form integration:

  1. Select (or set up) a company-managed project in Jira.
  2. Configure a Jira Issue Collector form with a custom trigger.
  3. Retrieve the code snippet and embed the issue collector in AQtive Guard.

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 following sections provide detailed instructions for each configuration step.

Identify a company-managed project🔗

Configuration requires a Jira company-managed project to receive AQtive Guard instances. If one is not already available, consult your Jira Administrator to create one. For more information, refer to the Jira support document on team-managed and company-managed projects.

Configure the Issue Collector in Jira🔗

Log in to Jira as an Administrator to complete the following steps.

  1. In your target Jira project, select Project Settings.
  2. Select Issues, then Collectors.
  3. Select Add issue collector and complete the following fields:
Name Specify an <issue-collector-name> to identify the Issue Collector in Jira
Description Enter an issue-collector-descriptionto appear with the Issue Collector name in Jira.
Tip: This description only applies to the issue collector form. When you use the form to export, AQtive Guard will populate a description of the selected instance.
Issue Type Select a default Jira Issue Type for exported instances.
Reporter - Specify a default issue Reporter to be used for Jira issues exported from AQtive Guard.
- Select Always use Issue reporter.
Important: The Issue Reporter must have Create issues project permission for the target Jira project.

Scroll down to the Trigger section and complete the following fields:

Trigger Text This field is required but your entry will not appear on your custom form.
Custom IMPORTANT: You must select the Custom trigger for the configuration to succeed.

Scroll down to Issue Collector Form and complete the following fields:

Template Select Custom.
Custom Fields Select:
- Components
- Description
- Priority

Generate the form embed code🔗

  1. Select Submit to generate the form embed code.
  2. Select the Embed in HTML tab and copy the generated code snippet.

Tip

Save the code snippet. You will need it to embed your issue collector in AQtive Guard.

Embed the issue collector in AQtive Guard🔗

The embed code snippet includes all configuration information for the Jira issue collector, including the Jira project key and default issue type. Where you enter the code snippet determines which AQtive Guard projects use that configuration:

  • 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.

Tip

To change the form configuration, generate a new issue collector embed code in Jira and replace the existing embed code. Issues are sent using the configuration at the time of export.

Organization export configuration🔗

Log in to AQtive Guard as an Administrator to complete the following steps.

  1. Select Integrations from the menu bar.
  2. From the integration options, select Jira, then Jira Form Integration.
  3. Paste the Jira Issue Collector code snippet that you obtained from your Jira project into the designated field, then Save.

Important

You must select Save for the configuration to succeed.

Project export configuration🔗

Log in to AQtive Guard as an Administrator to complete the following steps.

  1. Select Projects from the menu bar, then select the desired project name to open the project Overview.
  2. Select the Integrations tab.
  3. Paste the Jira Issue Collector code snippet that you obtained from your Jira project into the designated field, then Save.

Important

You must select Save for the configuration to succeed.

Use🔗

To launch Jira form export:

  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 launch an Issue collector form populated with information about the selected instance.
  4. Add any desired comments or edits, then Submit to create a Jira issue.

Important

You must select an individual AQtive Guard instance to launch the issue collector form. If you attempt to export from a report without selecting an instance, one of two scenarios may occur:

  • If your organization has configured Jira issue export, selecting Export will initiate a bulk Report export of Jira Issues for up to 50 of the highest-priority instances.
  • If Jira issue export hasn’t been configured, Jira export will be unavailable until you select an individual instance.

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