Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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.


Step 1) Set up your Jira Project to enable K integration

To integrate into K you will need to:

  • Create a custom field to enable K to connect with

  • Obtain key project details to help with 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

  • 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

Create a custom field

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

Make sure you’ve copied the Project ID, Issue Type ID and Custom Field Name for use in the next step. For exmple:

  • Project ID: 10203

  • Issue Type: 10100

  • Field Name: customFieldID=10353


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

      • Type ID: Enter the Type ID you copied in Step 1

      • Custom Field ID: Enter the Custom Field ID you copied in Step 1

    • Click Create

    • Click on the link to test your new integration

  • No labels