Design BIRT Reports on Google Data Catalog Data

The CData JDBC Driver for Google Data Catalog integrates connectivity to Google Data Catalog APIs into your data-driven Java applications. You can use the CData JDBC Driver for Google Data Catalog with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   Google Data Catalog uses the OAuth authentication standard. Authorize access to Google APIs on behalf on individual users or on behalf of users in a domain.

   Before connecting, specify the following to identify the organization and project you would like to connect to:

   • OrganizationId: The ID associated with the Google Cloud Platform organization resource you would like to connect to. Find this by navigating to the cloud console.

     Click the project selection drop-down, and select your organization from the list. Then, click More -> Settings. The organization ID is displayed on this page.

   • ProjectId: The ID associated with the Google Cloud Platform project resource you would like to connect to.

     Find this by navigating to the cloud console dashboard and selecting your project from the Select from drop-down. The project ID will be present in the Project info card.

   When you connect, the OAuth endpoint opens in your default browser. Log in and grant permissions to the application to completes the OAuth process. For more information, refer to the OAuth section in the Help documentation.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Google Data Catalog JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.googledatacatalog.jar

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

   When you configure 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.

   A typical JDBC URL is below:

   jdbc:googledatacatalog:ProjectId=YourProjectId;InitiateOAuth=GETANDREFRESH
7. Right-click the Data Sets folder and select the JDBC data source for Google Data Catalog.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT Type, DatasetName FROM Schemas WHERE ProjectId = 'bigquery-public-data'
9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Google Data Catalog data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.