Create Reports with Bitbucket Data in SAP Crystal Reports

Crystal Reports has many options for offloading data processing to remote data; this enables real-time reporting. The CData ODBC Driver for Bitbucket brings this capability to Crystal Reports. This article shows how to create a report on Bitbucket data that refreshes when you run the report.

Refer to the given table for the tools and versions used for this article:

Connect to Bitbucket Data

If you have not already, 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:

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.

👁 Create the ODBC DSN connection.

When configuring 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.

Design a Report in SAP Crystal Reports

Follow the procedure below to use the SAP Crystal Reports tool to create the Bitbucket connection and Design a Report.

1. File -> New -> Standard Report. 👁 Create a standard report.
   
2. Expand the ODBC (RDO) node under Create New Connection and double-click on "Make a New Connection". Select CData Bitbucket Sys or any other source to prepare the report. Click on NEXT and FINISH. 👁 Data Source Selection
   
3. Configure the data source by selecting the tables needed in the report and clicking NEXT. 👁 Add the table.
   
4. You can also link tables from the Bitbucket data in SAP Crystal Reports. Click on NEXT after adding the links between tables. 👁 Add multiple tables.
   👁 Link the tables.
   
5. After the tables are selected, select the fields you want displayed in the report from the selected table, followed by NEXT. 👁 Add the fields to display.
   
6. Select the "Group By" field to group the information on the report. 👁 Add the Group By field.
   
7. Sort the groups based on summarised totals and click on NEXT. 👁 Group Sorting
   

Create a Chart

After selecting a column to group by, the Standard Report Creation Wizard presents the option to create a chart. Follow the steps below to create a chart aggregating the Title column's values.

1. In the Standard Report Creation Wizard, select the Bar Chart option and select the column you grouped by in the "On change of" menu.
2. In the Show Summary menu, select the summary you created.
3. Select filters and a template, as needed, to finish the wizard. 👁 Select a chart type.
   

Select a template for the report to preview the finished report and view the chart populated with your data.

👁 Select a template type.

The Final Report

You can now see that the report contains all the fields specified.

👁 The final report.

Working with Remote Data

To ensure that you see updates to data, click File and clear the "Save Data with Report" option. As you interact with the report, for example, drilling down to hidden details, Crystal Reports executes SQL queries to retrieve the data needed to display the report. To reload data you have already retrieved, refresh or rerun the report.

You can offload processing onto the driver by hiding details elements and enabling server-side grouping. To do this, you need to select a column to group by in the report creation wizard.

1. Click File -> Report Options and select the "Perform Grouping On Server" option. 👁 Perform Grouping On Server option.
   
2. Click Report -> Section Expert and select the Details section of your report. Select the "Hide (Drill-Down OK)" option. 👁 Hide (Drill-Down OK) option.
   

When you preview your report with the hidden details, Crystal Reports executes a GROUP BY query. When you double-click a column in the chart to drill down to details, Crystal Reports executes a SELECT WHERE query that decreases load times by retrieving only the data needed.

At this point, you have created a SAP Crystal report built on top of live Bitbucket data using SAP Crystal Reports and CData ODBC driver. Learn more about the CData ODBC Driver for Bitbucket and download a free trial from the CData ODBC Driver for Bitbucket page. Let our Support Team know if you have any questions.