Build Dashboards with Bitbucket Data in DBxtra

The CData ODBC driver for Bitbucket enables access to live data from Bitbucket under the ODBC standard, allowing you work with Bitbucket data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to Bitbucket data as a generic ODBC Data Provider and create charts, reports, and dashboards based on Bitbucket data in DBxtra.

Connect to Bitbucket Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
   
   

   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.

   When you configure the DSN, 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.

2. Open the DBxtra application and in the New menu click Project and name the Project. 👁 Creating a New Project.
   
3. Select ODBC Connection as the Data Connection Type. 👁 Creating an ODBC Connection.
   
4. Click the browse option () for the Data Source.
5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab. 👁 Select the Provider
   
6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData). 👁 Select the Provider
   
7. Name the Connection and select the appropriate User Groups. 👁 Connection name and User Groups
   
8. Double-click the Connection from within the Project to connect to the data. 👁 Connecting to the data.
   

Create a Dashboard with Bitbucket Data

You are now ready to create a dashboard with Bitbucket data.

1. Right-click Report Objects under the Project and select New Report Object. 👁 Creating a Report Object for the Project
   
2. In the new Report Object, click the link to create the Query.
3. In the Select Data Connection window, select the newly created data connection. 👁 Select Data Connection
   
4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations. 👁 Selecting the data/building the query.
   
5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.) 👁 Building the Dashboard.
   

With a new Dashboard created, you are ready to begin analysis of Bitbucket data. Thanks to the ODBC Driver for Bitbucket, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date Bitbucket data.