Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Bitbucket Data in Jaspersoft Studio
Execute SQL to remote Bitbucket data in Jaspersoft Studio.
This article shows how to connect to Bitbucket from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for Bitbucket. You will use the standard Jaspersoft wizards to build SQL queries to Bitbucket. The queries are executed directly to the Bitbucket APIs, enabling real-time connectivity to Bitbucket data.
Connect to Bitbucket Data as a JDBC Data Source
To create a JDBC data source in Jaspersoft Studio, create a data adapter:
- In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
- Select Database JDBC Connection.
- Enter a user-friendly name for the driver.
- On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
- On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.bitbucket.BitbucketDriver.
- Enter the JDBC URL.
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 for Bitbucket:
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
Create Reports with Bitbucket Data
Follow the steps below to build an SQL query to Bitbucket, the basis of a simple report:
- Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
- In the Data Adapter menu, select the data adapter you created in the previous section.
- In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example:
SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
- Select the fields you want to include in the dataset. This example uses all fields.
- Skip the Group By step and finish the wizard.
In the Preview tab, you can see the report as it would look with the current Bitbucket data.
![A JasperReport template populated with live data. (Salesforce is shown.)](../articles/jdbc-jaspersoft-studio-3.png)
Create a Chart
The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.
Create a DataSet
Follow the steps below to create a new dataset to populate the chart:
- In the report editing area, click the Design tab.
- In the Outline view, right-click the root node for the report and click Create Dataset.
- Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
- In the Data Adapter menu, select the data adapter you created in the first section.
- Enter a query such as the following:
SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
- Select the fields you want in the dataset. This example uses Title and ContentRaw.
- Skip the step to group by fields and finish the wizard.
Configure the Chart
After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:
- Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
- Drag a chart from the Palette onto the summary. The chart wizard is displayed.
- Select the chart type. This example uses a bar chart.
- In the Dataset menu, select the dataset you created for the chart.
- In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
- Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the Title column to set the expression to $F{Title}.
Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click ContentRaw to set the expression to $F{ContentRaw}.
- Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the Title column to set the expression to $F{Title}. If needed, convert the column type to string, as in the following expression:
$F{Title}.toString()
- Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.
Running the Report
You can now generate reports on Bitbucket data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.
![The finished report's last page, displaying the chart. (Salesforce is shown.)](../articles/jdbc-jaspersoft-studio-7.png)