JIRA

How to configure a JIRA connection

This document describes the Dataworkz connector configuration required to access JIRA.

Prerequisite

You need a JIRA Admin account for connecting to JIRA from Dataworkz. Follow the steps listed below for creating an OAuth App in JIRA for Dataworkz.

  1. Select your app from the list (or create one if you don't already have one)

  2. Select OAuth 2.0 integration in dropdown menu.

  3. Enter App Name and then click Create to create connected App. Select Authorization in the left menu post app creation.

  4. Next to OAuth 2.0 (3LO), select Configure.

  5. Enter the Callback URL. Callback URL can be found in Dataworkz UI (Create Connector for JIRA section for details)

  6. Click Save changes.

  7. Select Permissions in the left menu. Permissions that need to be added for JIRA API are

  • View JIRA issue data

  • View user profiles

Make note of the Client ID & Secret. These details would be required at the time of creating the connector in Dataworkz by the authorized user

Create Connector for JIRA

  • Login to Dataworkz Application

  • Goto Configuration -> SaaS Applications -> JIRA

  • Click the + icon to add a new configuration

  • Enter name for the configuration in the above screen

  • Select JIRA installation type (Cloud/On-premise)

  • Select the authentication type

    • Private Connected App (OAuth App)

  • Custom App already created

    1. Select "Yes" if app has already been created.

    2. Select "No". Screen with the redirect URL would pop-up. Copy the redirect URL and goto Prerequisite section.

  • Enter the Client ID & Secret that was saved during the App creation

  • Select the scopes that need to be used

  • Select the workspace & collection

  • Click Save. This would prompt you to login to JIRA account and authorize Dataworkz to access JIRA APIs

Newly created connector would show up in the list of JIRA configurations

Add Configuration

Click the newly created connector and then click + icon to add configuration for JIRA

  1. Enter name for the dataset

  2. Select the JIRA project that you need to access

  3. Select the issue type

  4. Select the fields that need to be read

  5. Select the appropriate option for reading all the historical data or for a date range

  6. Select the incremental pull criteria

    • created

    • updated

  7. Enable/disable recurring job

  8. Click Add

This would complete the Dataworkz configuration for JIRA

Last updated