Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Create Data Visualizations in Cognos BI with Bitbucket Data
Access Bitbucket data as an ODBC data source in Cognos Business Intelligence and create data visualizations in Cognos Report Studio.
You can use the CData ODBC driver for Bitbucket to integrate Bitbucket data with the drag-and-drop style of Cognos Report Studio. This article describes both a graphical approach to create data visualizations, with no SQL required, as well as how to execute any SQL query supported by Bitbucket.
Configure and Publish the Data Source
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
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.
If you are running Cognos from a 64-bit machine and want to modify the DSN or create other Bitbucket DSNs, you must use a system DSN. You will also need to open the 32-bit ODBC Data Source Administrator. You can open it with the following command:
C:\Windows\sysWOW64\odbcad32.exe
After creating a DSN, you can then publish the data source:
- Open Cognos Administration and click Data Source Connections to add a new data source:
-
Select the ODBC option and enter the DSN, CData Bitbucket Sys, and a user-friendly name.
- Click Retrieve Objects and choose the CData Bitbucket database object.
Add Data Visualizations to a Report
You can now create reports on Bitbucket data in Cognos Report Studio by dragging and dropping table columns from the Source Explorer onto report objects. The sections below show how to create a simple report with a chart that shows up-to-date data.
As you build the report, Cognos Report Studio will generate SQL queries and rely on the driver to execute them. The driver will convert queries into requests to the Bitbucket API. To execute queries to the live Bitbucket data, the driver depends on the capabilities of the underlying API.
Create a Chart Based on an Aggregate
You can populate almost any report object in Cognos with Bitbucket data by simply dragging and dropping columns from the Source Explorer onto the dimensions of the object. The column in the Series dimension of the chart is automatically grouped.
Additionally, Cognos sets a logical default aggregate function for the measure dimension based on the data type. For this example, override the default by clicking the ContentRaw column in the Data Items tab and set the Aggregate Function property to Not Applicable. The Rollup Aggregate Function property must be set to Automatic.
![Bitbucket columns used in a pie chart. (Salesforce is shown.)](../articles/odbc-cognos-2.png)
Convert a Query Object to SQL
When you know the query you need, or if you want to adjust the generated query, convert a query object into an SQL statement. After a query has been converted to SQL, the UI controls are not available for the query object. Follow the procedure below to populate a chart with user-defined SQL.
Cognos will rely on the driver to execute the user-defined query. Using the driver's SQL engine ensures that queries will always return up-to-date results, as there is no cached copy of the data.
- Hover over the Query Explorer and click the Queries folder to display the query objects in your report.
-
If you want to edit the autogenerated query, click the button in the Generated SQL property for the query object. In the resulting dialog, click Convert.
If you want to enter a new SQL statement, drop an SQL object in-line with the query object.
- Modify the properties for the SQL object: Select the Bitbucket data source in the SQL properties and set the SQL Syntax property to Native.
Click the button in the SQL property and enter the SQL query in the resulting dialog. This example uses the query below:
SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
Modify the properties for the query object: Set the Processing property to "Limited Local". This value is required to convert a query object to SQL.
Fill a Chart with the Results of a Query
You can now access the results of the SQL query as objects in the Data Items tab. Follow the procedure below to create a chart with the results; for example, the ContentRaw for each Title from the Issues table.
- Return to the page by hovering over the Page Explorer and then clicking the page object.
- Drag a pie chart from the toolbox onto the workspace.
- In the properties for the chart, set the Query property to the name of the query you created above.
- Click the Data Items tab and drag columns onto the x- and y-axes. In this example, drag the Title column to the Series (pie slices) box and the ContentRaw column to the Default Measure box.
-
Modify the default properties for the Default Measure (the ContentRaw values): In the Aggregate Function box, select the Total option.
![A pie chart populated with the result of executing the SQL query. (Salesforce is shown.)](../articles/odbc-cognos-6.png)
Run the report to add the results of the query.
![The rendered report. (Salesforce is shown.)](../articles/odbc-cognos-7.png)