Create Bitbucket-Connected Visualizations in Klipfolio

Klipfolio is an online dashboard platform designed to create real-time business dashboards, whether for your team or clients. When combined with CData Connect AI, you gain immediate cloud-to-cloud access to Bitbucket data to create visualizations, reports, and more. This article provides step-by-step instructions on connecting to Bitbucket within Connect AI and creating visualizations using Bitbucket data in Klipfolio.

CData Connect AI offers a direct cloud-to-cloud interface for Bitbucket, enabling you to construct reports from real-time Bitbucket data data within Klipfolio—without the need for data replication to a database natively supported by Klipfolio. While building visualizations, Klipfolio generates SQL queries to fetch data. With optimized data processing capabilities out of the box, CData Connect AI efficiently directs all supported SQL operations (such as filters, JOINs, etc.) directly to Bitbucket, harnessing server-side processing to swiftly retrieve the requested Bitbucket data data.

Configure Bitbucket Connectivity for Klipfolio

Connectivity to Bitbucket from Klipfolio is made possible through CData Connect AI. To work with Bitbucket data from Klipfolio, we start by creating and configuring a Bitbucket connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Bitbucket" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Bitbucket.

   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.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Bitbucket Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Bitbucket data from Klipfolio.

Connect to Bitbucket from Klipfolio

The steps below outline connecting to CData Connect AI from Klipfolio to create a new Bitbucket data source.

1. Open Klipfolio
2. Click in Data Sources to add a new data source
3. Search for and select MSSQL as the Service
4. Click "Create a custom MSSQL data source"
5. Configure the data source by setting the MSSQL connection properties:
   • Host: tds.cdata.com
   • Port: 14333
   • Database: your database (e.g., Bitbucket1)
   • Driver: MS SQL
   • Username: a Connect AI user (e.g. [email protected])
   • Password: the above user's PAT
   • SQL Query: any query to retrieve data (e.g. SELECT * FROM Issues )
   • Select the checkbox to "Include column headers"
   • Select the checkbox to "Use SSL/TLS"
   
6. Click "Get data" to preview the Bitbucket data before building a data model.

Build a Data Model

After retrieving the data, click the checkbox to "Model your data" and click "Continue." In the new window, configure your data model.

1. Confirm that the model includes all columns you wish to work with
2. Name your model
3. (optional) Set the Description
4. Set "Header in row" to 1
5. Click the toggle to "Exclude data before row" and set the value to 2
6. Click "Save and Exit"

Create a Metric

With the data modeled, we are ready to create a Metric (or visualization) of the data to be used in the Klipfolio platform for dashboards, reporting, and more.

1. Click "Create metrics"
2. Select a Data source
3. Select a Metric value and default aggregation
4. Select Segmentation(s)
5. Select a Date & time
6. Select a Data shape
7. Configure the Display settings
8. Click Save
9. Navigate to your Metric and further configure the visualization

SQL Access to Bitbucket Data from Cloud Applications

Now you have a Metric built from live Bitbucket data. You can add it to a new dashboard, share, and more. Easily create more data sources and new visualizations, produce reports, and more — all without replicating Bitbucket data.

To get SQL data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI.