Design BIRT Reports on Salesforce Data Cloud Data

The CData JDBC Driver for Salesforce Data Cloud integrates connectivity to Salesforce Data Cloud APIs into your data-driven Java applications. You can use the CData JDBC Driver for Salesforce Data Cloud 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.

   Salesforce Data Cloud supports authentication via the OAuth standard.

   OAuth

   Set to OAuth.

   Desktop Applications

   CData provides an embedded OAuth application that simplifies authentication at the desktop.

   You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce Data Cloud console. For further information, see Creating a Custom OAuth App in the Help documentation.

   Before you connect, set these properties:

   • : GETANDREFRESH. You can use to avoid repeating the OAuth exchange and manually setting the .
   • (custom applications only): The Client ID assigned when you registered your custom OAuth application.
   • (custom applications only): The Client Secret assigned when you registered your custom OAuth application.

   When you connect, the driver opens Salesforce Data Cloud's OAuth endpoint in your default browser. Log in and grant permissions to the application.

   The driver then completes the OAuth process as follows:

   • Extracts the access token from the callback URL.
   • Obtains a new access token when the old one expires.
   • Saves OAuth values in so that they persist across connections.

   For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.salesforcedatacloud.jar
   

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

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   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:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;
   

   • Right-click the Data Sets folder and select the JDBC data source for Salesforce Data Cloud.
   • 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 [Account ID], [Account Name] FROM Account WHERE EmployeeCount > 250
     

   • In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
   • After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
   • Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Salesforce Data Cloud data. 👁 A BIRT report that can be refreshed on demand. (Salesforce is shown.)

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.