Important: Version 15-10-2015 deprecation
This version of the JIRA integration will be deprecated on April 17, 2019 and no longer be formally supported by the Stitch Support Team.
Connections created from October 15, 2015 to February 26, 2019 use this version. Upgrade to the latest version (1.0) to take advantage of the new enhancements.
JIRA feature snapshot
A high-level look at Stitch's JIRA (v15-10-2015) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Deprecated |
Supported By | |
Stitch Plan |
Paid |
||
DATA SELECTION | |||
Table Selection |
Unsupported |
Column Selection |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Unsupported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Unsupported |
Loading Reports |
Supported |
Connecting JIRA
JIRA setup requirements
To set up JIRA in Stitch, you need:
- A paid Stitch plan. While those currently in the Free Trial will also be able to set up JIRA, replication will be paused until a paid plan is selected after the trial ends.
-
Adminstrator permissions in JIRA. This is required to complete parts of the setup process.
Step 1: Whitelist Stitch's IP addresses
Whitelist all of the following IP addresses:
-
52.23.137.21/32
-
52.204.223.208/32
-
52.204.228.32/32
-
52.204.230.227/32
Be sure to do this before continuing through the rest of the setup or you may encounter errors when saving the integration.
Step 2: Verify your protocol support
If your JIRA instance is self-hosted, you’ll also need to verify that your server uses HTTPs
as the protocol. Stitch does not support HTTP
for security reasons.
When you complete the JIRA setup in Stitch, you’ll be asked to enter your JIRA base URL. If Stitch determines that the protocol is not HTTPs
, connection errors will arise.
Step 3: Retrieve your Stitch public key
In this case, when you add the public key to your JIRA instance, it allows Stitch to access and extract data from the account.
- On the Stitch Dashboard page, click the Add Integration button.
- Click the JIRA icon.
- Locate the Public Key field.
Leave this page open for now - you’ll need this to set up the application access in JIRA in the next step.
Step 4: Grant Stitch application access to JIRA
Note that you need Administrator permissions to complete the steps in this section. If you’re not an Admin, loop in someone who can help you before continuing.
- Sign into your JIRA account.
- Click the Settings (gear) icon in the top-right corner.
- In the drop-down menu, click Applications.
- Click the Application link in the Integrations section of the menu on the left side of the page.
- In the Application field, enter
stitchdata.com
. - Click Create new link.
A few ‘Configure Application URL’ messages might display after clicking the Create new link button. If you see these, don’t worry - everything is still on track.
Click Continue to keep going.
Step 4.1: Define the first set of link application settings
- When the Link Applications window displays, enter
stitch
into the following fields:- Application Name
- Service Provider Name
- Set the Application Type field to Generic Application.
- Enter
rjmetrics
into the following fields:- Consumer Key
- Shared Secret
- Enter
stitchdata.com
into the following fields:- Request Token URL
- Token URL
- Authorize URL
- Check the Create incoming link box.
- Click the Continue button and a second Link Applications window will display.
Step 4.2: Define the second set of link application settings
- In the Consumer Key field, enter
rjmetrics
. - In the Consumer Name field, enter
stitch
. - In the Public Key field, paste the entire Public Key from the Stitch JIRA credentials page.
- Click the Continue button.
If the link configuration was successful, you’ll see a Success! message on the Configure Application Links page.
Step 5: Add JIRA as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the JIRA icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch JIRA” would create a schema called
stitch_jira
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Base URL field, enter the base URL for your JIRA site. Remember: If you’re connecting a self-hosted instance, your server must use the
HTTPs
protocol or Stitch will be unable to successfully connect.
Step 6: Define the historical sync
The Sync Historical Data setting will define the starting date for your JIRA integration. This means that:
- For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond JIRA’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 7: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
JIRA integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up JIRA, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
JIRA table schemas
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 15-10-2015 of this integration.
jira_issues
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
jira_issues
table contains info about the issues in your JIRA account.jira_issues & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
Accounting for Deleted Issues
When an issue is hard-deleted in JIRA, the record for the issue will remain in your data warehouse. This happens because of the Replication Method the jira_issues
table uses and how JIRA’s API functions.
- The
jira_issues
table is incrementally replicated based on theupdated_at
column. This means that rows with values in this column that are greater than or equal to the last recorded MAX value will be selected for replication. If a record is hard-deleted, there won’t be a value to check and thus no way to detect changes to the record. - JIRA’s API doesn’t include a flag to indicate deletes.
The suggested workaround (although it may be a bit cumbersome) is to use the fields__status__name
column - which indicates the current status of an issue - to track deletes. Before deleting the issue, you could change the status to something that would only indicate a delete and then use that status as a filter in your queries.
jira_issues Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Issue ID (
id
)self
key
expand
changelog
description
attachment
*
subtasks
*
labels
*
fixversions
*
comments
*
Creator Info
Status Info
Summary
Votes
Reporter
Priority
Issue Type
jira_projects
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
jira_projects
table contains info about individual projects in your JIRA account.jira_projects & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
jira_projects Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project ID (
id
)avatarurls
description
expand
key
lead__active
lead__avatarurls
lead__displayname
lead__key
lead__name
lead__self
name
projecttypekey
projectkeys
*
self
jira_project_categories
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
jira_project_categories
table contains info about the categories assigned to the projects in your JIRA account.jira_project_categories Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Category ID (
id
)self
name
description
jira_project_roles
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
jira_project_roles
table contains info about the roles that can be assigned to projects in your JIRA account.jira_project_roles & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
jira_project_roles Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Role ID (
id
)self
name
description
jira_project_types
Replication Method: Full Table
Primary Key: key
Contains Nested Structures?:
No
jira_project_types
table contains info about the project types defined in your JIRA account.jira_project_types Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Project Type Key (
key
)formattedkey
description18nkey
icon
color
jira_resolutions
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
jira_resolutions
table contains info about the resolutions in your JIRA account.jira_resolutions Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
Resolution ID (
id
)self
name
description
jira_users
Replication Method: Full Table
Primary Key: key
Contains Nested Structures?:
No
jira_users
table contains info about the users in your JIRA account.jira_users Attributes
While we try to include everything JIRA has here, this may not be a full list of attributes. Refer to JIRA's documentation for a full list and description of each attribute.
User Key (
key
)active
avatarurls
displayname
emailaddress
key
locale
name
self
timezone
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.