Build Charts with Bitbucket Data in Clear Analytics

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 use Clear Analytics, a Microsoft Excel Add-In, to connect to Bitbucket as an ODBC source and create queries, tables, and charts (including PivotTables) based on Bitbucket data.

Connect to Bitbucket Data

Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. 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.

Configure the Data Source in Clear Analytics

1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
2. Select Database as the data source.
3. In the Set Connection section, click the option to create a new database.
4. Select Microsoft ODBC Data Source as the data source and click OK.
5. Select the DSN you already configured from the drop-down menu.
6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
10. In the Domain Relations section, add any relational information between tables.
11. In the Domain Tree section, create groups for your data and add the available items to the groups.
12. Review the summary of your data and click Finish.

Create a Chart with Bitbucket Data

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

Create a New Query

1. Click Repository in the CLEAR ANALYTICS ribbon.
2. Create a new query.
3. Select the columns you wish to retrieve.
4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
5. Set filters and formulas by dragging columns to the lower window.
6. Name your query and click Save.

Build a Chart Based on a Query Report

1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
3. Select the query you just created.
4. Name the report and click 'Save and Execute'.
5. Click the Results tab within the Report Explorer
6. Expand your report and drag the chart to the Excel spreadsheet.
7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of Bitbucket data. With the ODBC Driver for Bitbucket and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from Bitbucket.