Create Bitbucket Reports on JasperReports Server



Deploy the CData JDBC Driver on JasperReports Server to provide real-time Bitbucket data access from reports, embedded analytics, and more.

The CData JDBC Driver for Bitbucket enables you to provide access to Bitbucket data across the enterprise. This article shows how to deploy the driver on JasperReports server and create a simple report based on a reporting domain, a business view of Bitbucket data.

Deploy the Driver JAR

Follow the steps below to deploy the driver JAR on JasperReports Server. The instructions below contain specifics for Bitbucket and the Tomcat server bundled with JasperReports Server. If you are using JBoss AS 7 instead of Tomcat, you can follow the standard process to deploy the Bitbucket JDBC Driver on JBoss.

  1. Copy the driver JAR and .lic file, located in the lib subfolder of the installation directory, to the lib subfolder of the apache-tomcat folder, located in the JasperReports Server installation directory.
  2. Navigate to apache-tomcat -> webapps -> jasperserver-pro -> META-INF and add the following resource entry to the context.xml file:

    <Resource name="jdbc/bitbucket" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.bitbucket.BitbucketDriver" url="jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>

    Specify the required connection properties in the JDBC URL -- the url attribute.

    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:

    1. Go to Settings (the gear icon) and select Workspace Settings.
    2. In the Apps and Features section, select OAuth Consumers.
    3. Click Add Consumer.
    4. Enter a name and description for your custom application.
    5. 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.
    6. 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.
    7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
    8. To save the new custom application, click Save.
    9. 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.

  3. Navigate to jasperserver-pro -> WEB-INF and add the following reference to the web.xml file: Bitbucket data JSP jdbc/bitbucket javax.sql.DataSource Container
  4. Restart the server.

Create the Bitbucket JDBC Data Source

Follow the steps below to map the Bitbucket JDBC driver to a JDBC data source:

  1. Log into JasperReports Server and click Create -> Data Source.
  2. In the Type menu, select JNDI Data Source.
  3. In the Service Name box, enter the JDNI lookup defined in the resource definition in the web.xml file. In the example, the lookup is "jdbc/bitbucket".
  4. Click Save to create the Data Source.

Create a Domain

A domain is a metadata and access-control layer that surfaces a relevant business view to report creators. Follow the steps below to select Bitbucket columns, apply filters, and execute SQL to create a domain.

  1. Click Create -> Domain. Enter an Id for the domain and select a save location.
  2. Click Browse in the Data Source section and select the Bitbucket data source you created.
  3. In the Domain Design section, click Create with Domain Designer.
  4. Select the schema containing your tables.
  5. On the Tables tab, select a table in the Data Source pane and then click the arrow to add them to the Selected Tables pane.
  6. On the Derived Tables tab, you can define domains based on SQL queries. For example,
      SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
      
  7. On the Joins tab, you can join tables by selecting the columns you want to build the join condition and selecting the join type.
  8. On the Pre-Filters tab, drag and drop columns to define search criteria that filters the data exposed through the domain.
  9. On the Display tab, select Bitbucket data into the data sets presented to the user.
  10. Click OK to accept your changes and click Submit to create the domain.

Explore Data in Real Time

After you have created a domain, you are ready to connect to data. Follow the steps below to create an Ad Hoc View in the Ad Hoc Editor.

  1. Click Create -> Ad Hoc View.
  2. In the resulting dialog, select the Bitbucket domain you created.
  3. On the Choose Data page, select columns that you want to use in the view. In the Pre-Filters section, you can create filters based on the selected fields. In the Display section, you can modify column information as presented by the domain.
  4. After completing the wizard, select the view type and add columns to the view. JasperSoft uses the metadata of the driver to detect the available dimensions and measures, based on the data type. Drag dimensions and measures onto the Columns and Rows boxes. Right-click a measure to change the summary calculation. Drag the Columns slider to the the desired data level in the Filters section.
  5. To access updates to the data as you design the view, change the menu selection from Sample Data to Full Data in the design mode toolbar. As you make changes, JasperSoft Server executes the underlying SQL queries to the driver.
  6. Save the view.

Create a Real-Time Report

You can now create reports hosted on JasperSoft Server. To do so from the Ad Hoc Editor, click Save Ad Hoc View and click Create Report.

Ready to get started?

Download a free trial of the Bitbucket Driver to get started:

 Download Now

Learn more:

Bitbucket Icon Bitbucket JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Bitbucket.