Publish Reports with GitHub Data in SAP Crystal Reports

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

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

Deploy the JDBC Driver

Install the CData JDBC Driver for GitHub by including the driver JAR in the Crystal Reports classpath: Add the full file path, including the .jar, to the paths in the ClassPath element under the DataDriverCommonElement.

The default location for the CRConfig.xml file is C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java — the path might be slightly different based on your installation. The driver JAR is located in the lib subfolder of the installation directory.

After you have added the JAR to the ClassPath, restart Crystal Reports.

Connect to GitHub Data

After deploying the JDBC driver for GitHub, you can use the Report Wizard to add GitHub data to a new report.

1. Click File -> New -> Standard Report.
2. Expand the JDBC (JNDI) under Create New Connection and double-click Make a New Connection.
3. Create a connection string using CData JDBC Driver for GitHub.

For assistance constructing the JDBC URL, use the connection string designer built into the GitHub JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.github.jar

GitHub uses the OAuth 2 authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Getting Started chapter of the CData help documentation for an authentication guide.

Fill in the connection properties and copy the connection string to the clipboard.

When configuring the JDBC URL, 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.

4. In the wizard, enter the JDBC connection URL:

   jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH

5. Set the driver class name:

   cdata.jdbc.github.GitHubDriver
6. Select the tables needed in the report.
7. You can also link tables from the GitHub data in SAP Crystal Reports. Click on NEXT after adding the links between tables.
8. After the tables are selected, select the fields you want displayed in the report from the selected table, followed by NEXT.
9. Select the "Group By" field to group the information on the report.
10. Sort the groups based on summarised totals and click on NEXT.

You can then configure grouping, sorting, and summaries. See the following section to use the aggregate and summary to create a chart.

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 Name 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 template for the report to preview the finished report and view the chart populated with your data.

The Final Report

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

Working with Remote Data

To ensure that you see updates to the 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.
2. Click Report -> Section Expert and select the Details section of your report. Select the "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 GitHub data using SAP Crystal Reports and a CData JDBC Driver. Learn more about the CData JDBC Driver for GitHub and download a free trial from the GitHub JDBC Driver page. Let our Support Team know if you have any questions.