Jira Cloud

Jira is a project management tool from Atlassian, used for tracking tasks, issues, and bugs, and work progress of teams. Jira has two platforms: Jira Server and Jira Cloud. Each of these has various flavours, such as Jira Service Desk, Jira Software, and Jira Core. Jira Cloud is the cloud platform for Jira.

Note: For Pipelines created with this Source, Hevo provides you a fully-managed BigQuery data warehouse Destination if you do not already have one set up. You are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data in the Hevo Managed Google BigQuery.

You can replicate data from your Jira Cloud account to the Destination database or data warehouse using Hevo Pipelines.

Prerequisites

  • An Atlassian Jira Cloud instance.

  • READ permissions on the data to be ingested for the authenticated user.

Configuring Jira Cloud as a Source

Perform the following steps to configure Jira as a Source in Hevo:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipeline List View page.

  3. In the Select Source Type page, select Jira Cloud.

  4. In the Configure Your Jira Cloud Source page, specify the following: Jira Cloud settings

    1. Pipeline Name: A unique name for your Pipeline.

    2. API Key: The API token that you created in your Atlassian account  to enable Hevo to read data from your Jira account.
    3. User Email: The Email ID linked to your Jira account.
    4. Site Name: Your Jira site name.
    5. Click TEST & CONTINUE.
  5. Proceed to configuring the data ingestion and setting up the Destination.

Creating the API Token

Create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage/api-tokens.

  2. In the API Tokens page, click Create API token.

  3. In the dialog that appears, specify a short and easy to remember Label for your token and click Create.

  4. Click Copy to copy the token to the clipboard, and paste the token somewhere to save it securely like any other password. API token

  5. Click Close. You can now see the new token in the API Tokens list.

Note: For security reasons it is not possible to view the token after closing the creation dialog. If necessary, you can create a new token.

Data Replication

  • Historical Data: In the first run of the Pipeline, Hevo ingests the data from the beginning of time for all the objects in your Jira Cloud account.

  • Incremental Data: Once the historical load is completed, every subsequent run of the Pipeline fetches the entire data for the objects you select. In case of the Issue object though, only the new and modified data is ingested.

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline.

Table Name Description
board A board displays issues from one or more projects, giving you a flexible way of viewing, managing, and reporting on the work in progress.
All the boards that the user has permission to view.
board_issue IDs of all issues within a given board ID, which the user has permission to view.
Note: Epic issues do not belongs to the scrum boards.
board_project All the projects, ordered by name, that are associated with a given board ID. If you do not have permission to view the board, no project is loaded.
component All components in a project.
issue All work-related information relating to a unit of work. This includes the description of the work to be done, its duration, type, assignee, and importance.
Note: The custom fields created in an issue have the prefix custom_ in the field name.
issue_changelog A paginated list of all change logs for an issue, starting from the oldest. This also includes the meta data related to the changes.
issue_comment All comments logged by users for an issue.
issue_component The mapping between issues and project components.
This is a custom table generated by Hevo to maintain data sanity.
issue_fix_version The mapping between issues and project versions.
This is a custom table generated by Hevo to maintain data sanity.
issue_label All the labels assigned to an issue.
issue_link All the relational information between two issues.
issue_link_type The definitions of all relations that exist between two issues.
Note: The issue linking option must be enabled.
issue_subtask All the subtasks related to a particular issue ID.
issue_type All issue types, such as bug, task, or story.
issue_version The mapping between issues and project versions.
This is a custom table generated by Hevo to maintain data sanity
issue_watcher The users who are watching the developments for an issue.
Note: The Allow users to watch issues option must be enabled.
issue_worklog The work logs for an issue, starting from the oldest work log or from the work log started on or after a date and time.
Whenever an issue is updated, the work log object related to it is ingested from the beginning of time.
Note: Time tracking must be enabled in Jira for this data to be fetched.
priority The list of all priorities that are assigned to an issue.
project The collection of issues that share a common project lead.
project_category The list of all project categories.
resolution The list of all resolution values that are assigned to an issue.
status The list of all statuses associated with workflows.
status_category The list of all status categories.
Each status belongs to a status category.
sprint All sprints for a given board ID. This only includes sprints that you have permission to view.
user The list of all (active and inactive) users.
version All versions in a project.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:

Jira Cloud ERD

Limitations

  • Only Jira Core and Jira Software are currently supported.
Last updated on 26 Oct 2020