For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 to connect to JIRA from Dataworkz. Follow the steps below to create an OAuth app in JIRA for Dataworkz.

  1. Log in to the JIRA developer console.

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

  3. Select OAuth 2.0 integration in the dropdown menu.

  4. Enter an App Name and click Create to create the connected app. After the app is created, select Authorization in the left menu.

  5. Next to OAuth 2.0 (3LO), click Configure.

  6. Enter the Callback URL. The callback URL can be found in the Dataworkz UI (see Create Connector for JIRA for details).

  7. Click Save changes.

  8. Select Permissions in the left menu. Add the following permissions for the JIRA API:

  • View JIRA issue data

  • View user profiles

Record the Client ID and Secret. These are required when creating the connector in Dataworkz.

Create Connector for JIRA

  • Log in to the Dataworkz application.

  • Go to Configuration > SaaS Applications > JIRA.

  • Click the + icon to add a new configuration.

  • Enter a name for the configuration.

  • Select the JIRA Installation Type (Cloud or On-premise).

  • Select the Authentication Type:

    • Private Connected App (OAuth App)

  • Custom app already created:

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

    2. Select No. A screen with the redirect URL appears. Copy the redirect URL and go to the Prerequisite section.

  • Enter the Client ID and Secret saved during app creation.

  • Select the scopes to use.

  • Select the Workspace and Collection.

  • Click Save. Dataworkz prompts you to log in to JIRA and authorize access to the JIRA APIs.

The newly created connector appears in the list of JIRA configurations.

Add Configuration

Click the newly created connector, then click the + icon to add a configuration for JIRA.

  1. Enter a name for the dataset.

  2. Select the JIRA project to access.

  3. Select the issue type.

  4. Select the fields to read.

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

  6. Select the incremental pull criteria:

    • created

    • updated

  7. Enable or disable the Recurring Job toggle.

  8. Click Add.

This completes the Dataworkz configuration for JIRA.

Last updated