Jira

This page contains the setup guide and reference information for the Jira source connector.

Prerequisites

• API Token
• Domain
• Email

Setup guide

Step 1: Set up Jira

1. To get access to the Jira API you need to create an API token, please follow the instructions in this documentation.

Step 2: Set up the Jira connector in Calabi Connect

For Calabi Connect:

1. Log into your Calabi Connect account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Jira from the Source type dropdown.
4. Enter a name for the Jira connector.
5. Enter the API Token that you have created. API Token is used for Authorization to your account by BasicAuth.
6. Enter the Domain for your Jira account, e.g. airbyteio.atlassian.net.
7. Enter the Email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
8. Enter the list of Projects (Optional) for which you need to replicate data, or leave it empty if you want to replicate data for all projects.
9. Enter the Start Date (Optional) from which you'd like to replicate data for Jira in the format YYYY-MM-DDTHH:MM:SSZ. All data generated after this date will be replicated, or leave it empty if you want to replicate all data. Note that it will be used only in the following streams: Board Issues, Issue Comments, Issue Properties, Issue Remote Links, Issue Votes, Issue Watchers, Issue Worklogs, Issues, Pull Requests, Sprint Issues. For other streams it will replicate all data.

For Calabi Connect:

1. Navigate to the Calabi Connect dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Jira from the Source type dropdown.
4. Enter a name for the Jira connector.
5. Enter the API Token that you have created. API Token is used for Authorization to your account by BasicAuth.
6. Enter the Domain for your Jira account, e.g. airbyteio.atlassian.net.
7. Enter the Email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
8. Enter the list of Projects (Optional) for which you need to replicate data, or leave it empty if you want to replicate data for all projects.
9. Enter the Start Date (Optional) from which you'd like to replicate data for Jira in the format YYYY-MM-DDTHH:MM:SSZ. All data generated after this date will be replicated, or leave it empty if you want to replicate all data. Note that it will be used only in the following streams: Board Issues, Issue Comments, Issue Properties, Issue Remote Links, Issue Votes, Issue Watchers, Issue Worklogs, Issues, Pull Requests, Sprint Issues. For other streams it will replicate all data.

Supported sync modes

The Jira source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

This connector outputs the following full refresh streams:

• Application roles
• Avatars
• Boards
• Dashboards
• Filters
• Filter sharing
• Groups
• Issue fields
• Issue field configurations
• Issue custom field contexts
• Issue custom field options
• Issue link types
• Issue navigator settings
• Issue notification schemes
• Issue priorities
• Issue properties
• Issue remote links
• Issue resolutions
• Issue security schemes
• Issue transitions
• Issue type schemes
• Issue type screen schemes
• Issue types
• Issue votes
• Issue watchers
• Jira settings
• Labels
• Permissions
• Permission schemes
• Projects
• Project avatars
• Project categories
• Project components
• Project email
• Project permission schemes
• Project roles
• Project types
• Project versions
• Screens
• Screen tabs
• Screen tab fields
• Screen schemes
• Sprints
• Time tracking
• Users
• UsersGroupsDetailed
• Workflows
• Workflow schemes
• Workflow statuses
• Workflow status categories

This connector outputs the following incremental streams:

• Board issues
• Issue comments
• Issue worklogs
• Issues
• Sprint issues

If there are more endpoints you'd like Calabi Connect to support, please create an issue.

Streams on I/O Usage

In the list above, there is a subset of streams which requires to make one HTTP request per issue. Those streams can significantly slow down that a sync given a high number of issues. If you have one or many of those streams and experience slowness, we recommend filtering the list of issues using the list of projects in the configuration or simply removing those streams from the sync.

• Issue comments
• Issue properties
• Issue remote links
• Issue transactions
• Issue votes
• Issue watchers
• Issue worklogs

Entity-Relationship Diagram (ERD)

Experimental Tables

The following tables depend on undocumented internal Jira API endpoints and are therefore subject to stop working if those endpoints undergo major changes. While they will not cause a sync to fail, they may not be able to pull any data. Use the "Enable Experimental Streams" option when setting up the source to allow or disallow these tables to be selected when configuring a connection.

• Pull Requests

note

The experimental Pull Requests stream was removed in version 4.0.0 and is no longer available in the catalog. If you want to sync data using this stream, you must use version <= 3.5.4. This is only possible on self-deployed instances of Calabi Connect, and this stream is no longer supported on Calabi Connect.

Troubleshooting

Check out common troubleshooting issues for the Jira connector on our Calabi Connect Forum here.

Rate Limiting & Performance

The Jira connector should not run into Jira API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.