Jira Cloud

Last updated on Nov 15, 2023

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.

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, 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. Read Hevo Managed Google BigQuery.

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

Setup

Data Sync

Prerequisites

An Atlassian Jira Cloud instance from which data is to be ingested exists.
READ permissions on the data to be ingested for the authenticated user.
The API token is available to authenticate Hevo on your Jira Cloud account.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Creating the API Token

You require an API token to authenticate Hevo on your Jira Cloud account.

Note: You must log in as a user with READ permissions to perform these steps.

Create an API token from your Atlassian account:

Log in to your account.
In the API Tokens page, click Create API token.
In the dialog that appears, specify a short and easy to remember Label for your token and click Create.
Click Copy to copy the token, and save it securely like any other password. Use this token while configuring your Hevo Pipeline.

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.

Configuring Jira Cloud as a Source

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

Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Jira Cloud.
In the Configure your Jira Cloud Source page, specify the following:
- Pipeline Name: A unique name for your Pipeline.
- API Token: The API token that you created in your Atlassian account. This authorizes Hevo to read data from your Jira account.
- User Email: The email ID linked to your Jira account.
- Site Name: Your Jira site name. Extract this from your dashboard URL. For example, if your dashboard URL is https://mycompany.atlassian.net/jira/dashboards/, your site name is mycompany.
- Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 3 Months.
  
  Note: If you select All Available Data, Hevo ingests all the data available in your Jira Cloud account since January 01, 2000.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Historical Data:
- For existing Pipelines: 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.
- For Pipelines created after Release 1.80: You can select the Historical Sync Duration as per your requirement while creating a Pipeline. Default duration: 3 Months.
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.

Note: From Release 1.86, Hevo ingests only new and updated data for Full Load objects to optimize the quota consumption. This feature is currently available on request only. You need to contact Hevo Support to enable it for your team.

Custom frequency for Full Load objects

Hevo allows you to set the ingestion frequency for Full Load objects separately from the Pipeline ingestion frequency. You can reduce your Events quota consumption by ingesting Full Load objects at a lower frequency without affecting other objects in the Pipeline. Read Query Modes and Events Quota Consumption to know how different query modes affect your Events quota consumption.

You can identify the Full Load objects in the Pipelines Detailed View by the FL tag corresponding to their name. Alternatively, you can view only Full Load objects for your Pipeline by selecting Full Load in the Filter ( ) menu.

Perform the following steps to change the ingestion frequency for Full Load objects:

In the Pipelines Detailed View, click the More ( ) icon to open the Pipeline’s Action menu, and click Change Schedule.
In the Change the Ingestion Schedule pop-up window, enable the Change Full Load Object Schedule option.
Select the ingestion frequency for the Full Load objects from the options displayed, or you can select Custom, and then enter the ingestion frequency in hours as an integer value.
Click SCHEDULE.

The changed schedule is applied immediately.

Schema and Primary Keys

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

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.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Source Considerations

Jira’s REST APIs do not support identifying deleted issues due to which Hevo is unable to update the Events for deleted issues and they continue to remain in your Destination table. As a result, you see more Events in the Destination than in the Source.

Limitations

Only Jira Core and Jira Software are currently supported.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Feb-20-2023	NA	Updated section, Configuring Jira Cloud as a Source to update the information about historical sync duration.
Sep-21-2022	1.98	Added section, Custom frequency for Full Load objects to inform users about the option to change ingestion frequency for Full Load objects.
Jul-27-2022	NA	Updated Note in section, Data Replication.
May-10-2022	NA	Provided additional detail to extract the site name in the Configuring Jira Cloud as a Source section.
Apr-11-2022	1.86	- Added a note in section, Data Replication to inform about optimized quota consumption for Full Load objects. - Added the Source Considerations section to reflect Jira’s REST APIs limitation.
Jan-24-2022	1.80	Added information about configurable historical sync duration in the Data Replication section.