How to integrate Jira with SSRS

Integrate SSRS and Jira
Integrate SSRS and Jira

Learn how to quickly and efficiently connect Jira with SSRS for smooth data access.

Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required. You can do it all using the high-performance Jira ODBC Driver for SSRS (often referred to as the Jira Connector). We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Video Tutorial

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Jira integration in SSRS
  • How to configure the connection for Jira
  • Features of the ZappySys API Driver (Authentication / Query Language / Examples / Driver UI)
  • How to use the Jira in SSRS

Create data source in ZappySys Data Gateway

In this section we will create a data source for Jira in the Data Gateway. Let's follow these steps to accomplish that:

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

    Open ZappySys Data Gateway Service Manager

  3. Go to the Users tab and follow these steps to add a Data Gateway user:

    • Click the Add button
    • In the Login field enter a username, e.g., john
    • Then enter a Password
    • Check the Is Administrator checkbox
    • Click OK to save
    Data Gateway - Add User

  4. Now we are ready to add a data source:

    • Click the Add button
    • Give the Data source a name (have it handy for later)
    • Then select Native - ZappySys API Driver
    • Finally, click OK
    JiraDSN
    ZappySys API Driver
    Data Gateway - Add data source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "Jira" from the list of Popular Connectors. If "Jira" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    JiraDSN
    Jira
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    API Key based Authentication

    Jira authentication
    Firstly, login into your Atlassian account and then go to your Jira profile:

    1. Go to Profile > Security.
    2. Click Create and manage API tokens.
    3. Then click Create API token button and give your token a label.
    4. When window appears with new API token, copy and use it in this connection manager.
    5. That's it!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to API Key based Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    JiraDSN
    Jira
    API Key based Authentication [Http]
    https://[$Subdomain$].atlassian.net/rest/api/3
    Required Parameters
    Subdomain Fill-in the parameter...
    Atlassian User Name (email) Fill-in the parameter...
    API Key Fill-in the parameter...
    Optional Parameters
    CustomColumnsRegex
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

    Personal Access Token (PAT) Authentication

    Jira authentication
    Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRA
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Personal Access Token (PAT) Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    JiraDSN
    Jira
    Personal Access Token (PAT) Authentication [Http]
    https://[$Subdomain$].atlassian.net/rest/api/3
    Required Parameters
    Subdomain Fill-in the parameter...
    Token (PAT Bearer Token) Fill-in the parameter...
    Optional Parameters
    CustomColumnsRegex
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

    OAuth (**Must change API Base URL to V3 OAuth**)

    Jira authentication

    OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [API reference]

    Firstly, login into your Atlassian account and then create Jira application:

    1. Go to Atlassian Developer area.

    2. Click Create and select OAuth 2.0 integration item to create an OAuth app:

      Create OAuth integration app in Atlassian

    3. Give your app a name, accept the terms and hit Create:

      Name OAuth app in Atlassian

    4. To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears:

      Enable scopes in OAuth app in Atlassian

    5. Continue by hitting Edit Scopes button to assign scopes for the application:

      Edit scopes in OAuth app in Atlassian

    6. Select these scopes or all of them:

      Add Jira scopes in OAuth app in Atlassian

    7. Then click Authorization option on the left and click Add button:

      Add authorization in OAuth app in Atlassian

    8. Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:

      Set callback URL for OAuth app in Atlassian

    9. Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step):

      Get Jira data via REST API and OAuth

    10. Now go to SSIS package or ODBC data source and in OAuth authentication set these parameters:

      • For ClientId parameter use Client ID value from the previous steps.
      • For ClientSecret parameter use Secret value from the previous steps.
      • For Scope parameter use the Scopes you set previously (specify them all here):
        • offline_access (a must)
        • read:jira-user
        • read:jira-work
        • write:jira-work
        • manage:jira-project
        • manage:jira-configuration
        NOTE: A full list of available scopes is available in Atlassian documentation.
      • For Subdomain parameter use your Atlassian subdomain value (e.g. mycompany, if full host name is mycompany.atlassian.net).
    11. Click Generate Token to generate tokens.
    12. Finally, select Organization Id from the drop down.
    13. That's it! You can now use Jira Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    JiraDSN
    Jira
    OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]
    https://[$Subdomain$].atlassian.net/rest/api/3
    Required Parameters
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    Scope Fill-in the parameter...
    ReturnUrl Fill-in the parameter...
    Organization Id (Select after clicking [Generate Token]) Fill-in the parameter...
    Optional Parameters
    Custom Columns for output (Select after clicking [Generate Token])
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration

  7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    ZappySys API Driver - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    JiraDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API

  8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in SSRS to retrieve data from Jira. Hit OK button to use this query in the next step. 

    SELECT * FROM Issues

--//Query single issue by numeric Issue Id
--SELECT * FROM Issues Where Id=101234

--//Query issue by numeric Issue Ids (multiple)
--SELECT * FROM Issues WITH(SearchBy='Key', Key='101234,101235,101236')

--//Query issue by Issue Key(s) (alpha-numeric)
--SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11')
--SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11,PROJ-12,PROJ-13')

--//Query issue by project(s)
--SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ')
--SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ,KAN,CS')

--//Query issue by JQL expression
--SELECT * FROM Issues WITH(SearchBy='Jql', Jql='status IN (Done, Closed) AND created > -5d' )
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Jira API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

  9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in SSRS:

    ZappySys API Driver - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    JiraDSN
    SELECT * FROM Issues

--//Query single issue by numeric Issue Id
--SELECT * FROM Issues Where Id=101234

--//Query issue by numeric Issue Ids (multiple)
--SELECT * FROM Issues WITH(SearchBy='Key', Key='101234,101235,101236')

--//Query issue by Issue Key(s) (alpha-numeric)
--SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11')
--SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11,PROJ-12,PROJ-13')

--//Query issue by project(s)
--SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ')
--SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ,KAN,CS')

--//Query issue by JQL expression
--SELECT * FROM Issues WITH(SearchBy='Jql', Jql='status IN (Done, Closed) AND created > -5d' )
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Jira API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Jira servers).

  10. Click OK to finish creating the data source.

  11. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

    Data Gateway - Add firewall rule for inbound connections
    • This will initially allow all inbound traffic.
    • Click Edit IP filters to restrict access to specific IP addresses or ranges.

  12. Crucial Step: After creating or modifying the data source, you must:

    • Click the Save button to persist your changes.
    • Hit Yes when prompted to restart the Data Gateway service.

    This ensures all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Read data in SSRS from ZappySys Data Gateway

  1. Open Visual Studio and create a new SSRS project.

  2. Then add a new Shared Data Source (you can create a non-shared data source inside report too):

    Adding a Data Source in SSRS project

  3. Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further:

    Configuring a Data Source to access API data in SSRS project

  4. Once a window opens, configure it similarly. Configure "JiraDSN" as database name. Finally, hit Test Connection and OK:

    JiraDSN
    Configuring thoroughly a Data Source to access API data in SSRS project

  5. Another window opens, and it should look similarly to this one below which ends the creation of a Data Source:

    DataSource=localhost,5000;Initial Catalog=JiraDSN
    How Data Source in SSRS project looks like

  6. Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this:

    SELECT * FROM Issues --//Query single issue by numeric Issue Id --SELECT * FROM Issues Where Id=101234 --//Query issue by numeric Issue Ids (multiple) --SELECT * FROM Issues WITH(SearchBy='Key', Key='101234,101235,101236') --//Query issue by Issue Key(s) (alpha-numeric) --SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11') --SELECT * FROM Issues WITH(SearchBy='Key', Key='PROJ-11,PROJ-12,PROJ-13') --//Query issue by project(s) --SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ') --SELECT * FROM Issues WITH(SearchBy='Project', Project='PROJ,KAN,CS') --//Query issue by JQL expression --SELECT * FROM Issues WITH(SearchBy='Jql', Jql='status IN (Done, Closed) AND created > -5d' )
    Specifying a query in SSRS Dataset to access API data #1

  7. Finally, once you complete the report, similar results will show up:

    ZappySys Data Gateway API data source results

Passing Parameters to SSRS Report / Filter data

If you want to parameterize your report, then refer to this article

Supported Jira Connector actions

Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Jira operations directly in SSRS, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:

Conclusion

In this article we showed you how to connect to Jira in SSRS and integrate data without writing complex code — all of this was powered by Jira ODBC Driver.

Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Download Chat

Explore SSRS connectors

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

More Jira integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications