JIRA Cloud
The Qlik JIRA Cloud connector lets you bring data about your projects and issues from JIRA, inside your applications.
Ways to access your data
To access your JIRA Cloud data, you need to authenticate the connector using OAuth 2.0.
OAuth authentication
OAuth 2.0 provides secure access to your JIRA Cloud data. When you authenticate with OAuth, you are redirected to Atlassian's login page where you authorize the connector to access your account without storing your password.
Do the following:
- In the Data load editor or Data manager, create a new JIRA Cloud connection.
- In the Account details section, click Authenticate.
- You will be redirected to Atlassian's login page. Log in with your JIRA Cloud account credentials.
- Review and approve the requested permissions. The connector requires the following scopes: jira-user and jira-work (to read JIRA project and issue data, search for issues, and view objects associated with issues like attachments and worklogs) and me (to view your profile details).
- Atlassian will display an authentication code. Copy this code to your clipboard.
- Return to the connector creation page and paste the code in the input field that appears below the Authenticate button.
- Click Verify.
- Once authenticated, select your JIRA Cloud instance from the Cloud ID dropdown.
- Enter a name for this connection and save it.
Token expiration: Your authentication tokens are automatically refreshed while you use the connector. However, your authentication will expire if you do not use the connector for 90 days or longer, or if you change your Atlassian account password. When you try to use the connector again after expiration, you will need to re-authenticate by clicking Authenticate in the connection settings.
Creating a data source connection
Loading data from tables
After you authenticate the connector, you can use the following tables to select and load data.
Some tables are only available in the Data load editor, and are not available in the Add data interface.
| Table | Available in | Description |
|---|---|---|
| CloudInstances | Data load editor | Use this to get a list of all cloud instances visible to the current user. |
| Projects | Data load editor and Data manager | Use this to get a list of projects visible to the authenticated user. |
| Issues | Data load editor and Data manager | Use this to get all the issues for a specific project. |
| Fields | Data load editor | Use this to get a list of fields visible to the authenticated user. Note: The JIRA Cloud API has different field properties than legacy JIRA connectors. Some properties (such as custom, orderable, navigable, and searchable) are not available. |
| CustomFieldsforIssues | Data load editor | Use this to get information about the available fields. Useful for looking up custom field names. |
| Comments | Data load editor | Use this to get all comments made for an issue. |
| History | Data load editor | Use this to get the history of an issue. |
| Worklog | Data load editor | Use this to get a worklog listing for an issue. |
| ServerInfo | Data load editor | Use this to get general information about the specified Jira server. |
To select and load data from a table, enter the required table parameters and click Preview data. Required parameters are marked with an asterisk (*) in the dialog. The table fields are displayed under the Data preview tab. You can select fields individually by selecting the box beside each field name. Select Insert script after you have made your selection.
Creating a connection and selecting data
Working with the JIRA API quota limits
This connector use the JIRA API to extract data from JIRA and load it into your Qlik Cloud application. While reloading your JIRA-based application, you might receive an error message that the connector has reached the JIRA API rate limit and that all subsequent API calls will fail until the connector falls back under the throttling limit. If you receive this error message, then you have exceeded one of the API rate limits.
Reference - JIRA API documentation
You can refer to the JIRA API documentation to learn more about the requirements and restrictions imposed by the JIRA API.
JIRA Cloud OAuth 2.0 documentation
Troubleshooting
OAuth authentication fails or token expires
Possible cause
- You were redirected to Atlassian's login page but did not approve the requested permissions.
- Your authentication has expired because the connector was not used for 90 days or longer.
- You changed your Atlassian account password, which invalidated the current refresh token.
- A network timeout occurred during the redirect to Atlassian's login page.
Proposed action
- Retry the authentication process by clicking Authenticate again.
- Ensure you approve all requested scopes when prompted by Atlassian.
- If you changed your Atlassian account password, authenticate again using your new password.
- If re-authentication fails, delete this connection and create a new one.
You receive an error message that you have reached the API rate limit
Possible cause
You have exceeded the API limits that are imposed by the JIRA API.
Proposed action
To reduce the impact of reaching API rate limits, develop your application with the following in mind:
- Extract only the data you need.
- Reload one JIRA-based application at a time.
- Ensure that loops in your script that make API calls do not result in infinite loops.