Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Integrate with Bitbucket Data in JReport Designer
Create charts and reports based on Bitbucket data in JReport Designer.
The CData JDBC Driver for Bitbucket data enables access to live data from dashboards and reports as if Bitbucket were a relational database, allowing you to query Bitbucket data using familiar SQL queries. This article shows how to connect to Bitbucket data as a JDBC data source and create reports based on Bitbucket data in JReport Designer.
Connect to Bitbucket Data
- Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:
... set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Bitbucket 2016\lib\cdata.jdbc.bitbucket.jar; ...
- Create a new data source by clicking File New Data Source.
- In the resulting dialog, create a name for the data source (CData JDBC Driver for Bitbucket), select JDBC, and click OK.
- In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
- Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
cdata.jdbc.bitbucket.BitbucketDriver
- URL: Enter the JDBC URL. This starts with jdbc:bitbucket: and is followed by a semicolon-separated list of connection properties.
For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.
Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:
- Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
- Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.
Authenticating to Bitbucket
Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.
Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).
Creating a custom OAuth application
From your Bitbucket account:
- Go to Settings (the gear icon) and select Workspace Settings.
- In the Apps and Features section, select OAuth Consumers.
- Click Add Consumer.
- Enter a name and description for your custom application.
- Set the callback URL:
- For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
- For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
- If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
- Select which permissions to give your OAuth application. These determine what data you can read and write with it.
- To save the new custom application, click Save.
- After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Bitbucket JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.bitbucket.jar
Fill in the connection properties and copy the connection string to the clipboard.
When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Below is a typical JDBC URL:
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
- User: The username to authenticate with; typically left blank.
- Password: The password to authenticate with; typically left blank.
- Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.
Click Done once the dialog has completed loading the tables.
- In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Bitbucket), right-click on Queries, and select Add Query.
- In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
- In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Bitbucket data to a new or existing report.
NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.
Add Bitbucket Data to a Report
You are now ready to create a report with Bitbucket data.
- Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
- Select the Query (or create a new one; see above).
- Assign a Category and Value for the chart from the columns in your Query and click Finish.
- Click the View tab for your report to see the chart.
![Selecting the query to use. (Salesforce is shown.)](../articles/jdbc-jreport-designer-6.png)
![Assigning columns to define the chart. (Salesforce is shown.)](../articles/jdbc-jreport-designer-7.png)
![Sample chart based on live data. (Salesforce is shown.)](../articles/jdbc-jreport-designer-8.png)