| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
This page will walk through how to integrate K with JIRA Issue Management.Note: Currently JIRA integration is one direction. Updates in JIRA are not currently synchronised back to K. This will be addressed in an upcoming release. (JIRA Software or Jira Service Management)
Step 1) Set up your Jira Project to enable K integration
Step 2) Connect K to JIRA
Step 3) Create Access Key for Jira integration
Step 4) Synchronise JIRA updates with K through a WebHook
More than 1 Jira Project can be integrated to K by repeating this process for each project.
| Info |
|---|
You will need a Jira administrator access to complete the following steps |
...
Step 1) Set up your Jira Project to enable K integration
...
Create a custom field to enable K to connect with
Obtain key Jira project details to help with setup the integration
...
...
You will need Jira administrator access to complete the following steps
Confirm the JIRA Project you want to use
Open the JIRA Project that you want to use manage data quality issues. This can be a project in Jira Software or Jira Service Management.
Click on Project Settings
In the URL field, copy down the Project ID for future use (e.g. the below 10203)
This information will help K locate the your JIRA Project
In the side panel under Issues, click on Types
Click on the Issue Type you will be managing your Data Issues, e.g. Bug or Task
In the URL field, copy down the Issue Type ID for future use (e.g. the below 10100)
This information will help K to configure the integration
...
Click on Project Settings
In the side panel under Issues, click on Fields
Click on the Edit Fields button
In the side panel, click on Custom Fields
Click on the Create Custom Field button, select Short Text (plain text only) option and click Next
Name the field K Integration
In the Description paste the following text: “Custom field that K will automatically populate with a URL to the linked K Issue Page”
Search for the new custom field you created and click on Contexts and default value
In the URL field, copy down the custom field ID name for future use (e.g. the below customFieldId=10353)
This information will help K locate the custom field in your JIRA Project
Note: You currently need to copy the entire text string. We are working on simplifying this step and hope to improve the integration process soon.
...
| Info |
|---|
Make sure you’ve copied the Project ID, Issue Type ID and Custom Field IDName for use in the next step. For example:
|
...
Step 2) Connect K to JIRA
Select Platform Settings in the side bar
In the pop-out side panel, under Integrations click on Integrations
Click Issue Management
Click on the New Integration button and complete the fields in the New Integration Page
Integration Type: Select JIRA
Integration Name: Type the name that you want to call this integration e.g. JIRA Data Quality Issue Management
JIRA details:
JIRA URL: Type in the URL of your JIRA cloud
Project ID: Enter the project ID you copied in Step 1 (e.g. 10203)
Jira Type ID: Enter the Type ID you copied in Step 1 (e.g. 10100)
Custom Field ID: Enter the Custom Field ID Name you copied in Step 1 (e.g. customFieldID=10353)
Click Create
Click on the link to test your new integration
Copy the Source ID of the new Jira integration you just created. This will be used to create the WebHook in JIRA
| Info |
|---|
Make sure you’ve copied the Source ID. For example:
|
...
Step 3) Create Access Key for Jira integration
...
Select Platform Settings in the side bar
In the pop-out side panel, under Integrations click on Access Keys
Click New Access Key
Follow the instructions to create a new access key
Select the new integration you want to connect
Enter a new access key name so that you can easily identify which JIRA project the access key relates to
Click Create Key
Copy and save the Access Key to a secure location you can easily access for a later step
Note: Once you hit Close you will no longer be able to see the access key again. If you lose the access key you will need to regenerate the access key and update the Jira webhook.
| Info |
|---|
Make sure you’ve copied the Access Key. For example:
|
...
Step 4) Synchronise JIRA updates with K through a new WebHook
Access your JIRA System Settings and scroll down to the Advanced Settings to click on WebHooks
Click Create a WebHook
Complete the fields to create a new WebHook
Create a Name so that you will be able to easily recognise the WebHook is for a K integration
Enter the URL using the following format
https://[K domain]/api/webhooks/[K Source ID]?api_key=[Access Key]
The K domain is your k instance URL
K Source ID was copied in Step 2
Access Key was copied in Step 3
Example URL: https://CompanyABC.kada.ai/api/webhooks/1038?api_key=3b55f8c624a67c4997eed1a061dca537
In the Issue Related Events section
Specify a JQL query to ensure that only the right issues are synchronised with K. We recommend including the Project name that was copied in Step 1
Under the Issue column, tick the created, updated and deleted box
Click Create