Jira Integration: Onboarding Guide

[prichardson]

The Jira integration in DQM allows you to create Jira tickets directly within the platform. Created Jira tickets are linked to a DQM issue. You can access the created tickets directly in DQM.

The Jira integration therefore offers the following benefits:

• Eliminate manual tasks of copying over information from DQM to Jira tickets
• Simplify project management by creating tasks directly from within DQM
• Improve efficiency and enhance project visibility between your teams

For more information on how to use the integration, take a look at the Jira Integration: User Guide.

Step-by-step instructions

• Create a Jira account/user specifically for the Jira Integration.

• Provide the following information in tables to the Crownpeak support-team (support@crownpeak.com):
  • Email addresses of the dedicated Jira account
  • Your Jira instance URL
  • A list of projects and corresponding issue types you would like to make available in DQM
  • A default project and corresponding issue type

• Once you have provided the necessary information, you will receive a link to input your API token.
  → If the email, Jira URL, and API token you have provided are correct, the connection status will be set to “Connection established.”Connection status
• Inform the Crownpeak team after you have successfully established a connection to Jira.
  → The team will enable the integration for you once the setup is complete.

NOTE
You can find more information on how to create an API token here.

WARNING
When you create an API token ensure that

• you are logged in with the dedicated DQM Jira integration account.
• you provide a well named label for the token, e.g. “DQM Integration Token”.

Creating a dedicated Jira user 

Creating a dedicated Jira user for the Jira integration offers the following benefits:

• All Jira tickets created within DQM will show the dedicated user as reporter.
• A dedicated user increases traceability within the system.
• The dedicated user can be managed by your organization, and the API tokens can be rotated on a schedule to suit your security requirements.
• The dedicated user can be limited within Jira to only have access to an approved list of projects and issues.
• If you do not create a dedicated user and instead set up the connection on your or your colleagues’ email, Jira notification emails might become distracting.

Providing a list of projects and issue types

The list of projects and issue types for each project you provide determine which options are available to DQM users when creating tickets through the Jira integration.

Providing a list of projects and corresponding issue types makes it possible to cater to different workflows, for example:

• You can create a single project dedicated to hold DQM generated Jira issues.
• You can create an issue type specific to DQM which can be used in several different projects.
• You can make use of already existing projects and issue types that are not specifically dedicated to the Jira integration.

Currently subtasks and issue types including custom Jira fields are not supported. If your provided list includes either of these, support will reach out to you.

Required information

Fill out the tables below and send it to the Crownpeak team to ensure a speedy and successful setup of the Jira integration.

Basic integration information

Email address of dedicated Jira user	<email address>
Jira instance URL	<URL>
Default project	<project name>
Default issue type	<issue type>

Project-specific details

Please list all Jira projects and their associated issue types.

Jira project name	Jira issue types
<project 1>	<issue type 1>, <issue type 2>, …
<project 2>	<issue type 1>, <issue type 2>, …
<project ...>	<issue type 1>, <issue type 2>, ...