Set up Jira Connector

  • 3min

Learn how to set up Jira to use Jira Connector Jira for Workflows. After this setup, you can start using Jira Connector actions in your workflow.

Prerequisites

  • Access to the Jira instance.
  • app-engine:apps:install permission.

Steps

Step 1 Add a New host pattern in External requests

External requests enable outbound network connections from your Dynatrace environment to external services. They allow you to control access to public endpoints from the AppEngine with app functions and functions in Dashboards, Notebooks, and Automations.

  1. Go to Settings and select General > Environment management, External Requests.

  2. Select New host pattern.

  3. Add the domain names.

  4. Select Add.

This way you can granularly control the web services your functions can connect to.

Step 2 optional Configure EdgeConnect

If you are connecting to a self-hosted Jira instance, you might require EdgeConnect to establish a connection behind your firewall.

  1. Go to EdgeConnect Management and select EdgeConnect.
  2. Enter the Name of the connection. It must contain only lowercase alphanumeric characters or '-' (RFC 1123).
  3. Enter the Host patterns. Enter one host pattern per line. A host pattern must be a valid IP, domain name, or wildcard domain name where the leftmost label is '*' followed by at least two non wildcard labels.
  4. Select Create.

Step 3 Grant permissions to Workflows

Some permissions are required by Workflows to run actions on your behalf.

To fine-tune permissions granted to Workflows

  1. Go to Workflows and select Settings > Authorization settings.
  2. Select the following permissions besides the general Workflows permission.
  • app-settings:objects:read
  • state:app-states:read
  • state:app-states:write
  • state:app-states:delete

For more on general Workflows user permissions, see User permissions for workflows.

Step 4 Create connection to Jira

  1. Get credentials for the Jira instance. The following authentication methods are supported:

    • Basic Authentication

      We don't recommend using the basic authentication scheme, but it may still be required to authenticate older Jira Server versions that don't support the personal access token.

    • Personal Access Token (PAT) recommended

      This is the recommended method to use for Jira Server. To learn which versions of Jira Server support personal access tokens and how you can create them, see Using personal access tokens in the Atlassian Jira documentation.

    • Jira API Token (Jira Cloud)

      When connecting to a Jira Cloud instance, use the Jira API tokens.

  2. In Dynatrace, go to Settings and select Connections.
  3. Search for Jira.
  4. Select Connection. The Create new connection dialog opens.
  5. Enter the Connection name. Provide a unique and clearly identifiable connection name for the Jira instance.
  6. Enter Jira URL. This is the URL of the Jira Server.
  7. Enter the Type. It's the type of authentication method that should be used.
  8. Enter the User which is a user name or email address. A User is only required for Basic Authentication and the Jira API Token (Jira Cloud). A User is not needed when using a Personal Access Token (PAT).
  9. Enter the Token for the selected authentication type.
  10. Select Create.

Additional notes

  • To improve traceability and audibility, use a Jira service user to access your Jira instance.

  • To add connection settings, you need the following permissions:

    ALLOW settings:objects:read, settings:objects:write, settings:schemas:read WHERE settings:schemaId = "app:dynatrace.jira:connection"

    For details, see Permissions and access.

  • Be aware that connections are shared and can be used by all users with app-settings read permissions. This is by design, as workflows enable a simplified ticket lifecycle across projects and entities.