VOOZH about

URL: https://www.cdata.com/kb/tech/salesforcedc-jdbc-jreport-designer.rst

⇱ Integrate with Salesforce Data Cloud Data in JReport Designer


Integrate with Salesforce Data Cloud Data in JReport Designer

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create charts and reports based on Salesforce Data Cloud data in JReport Designer.

The CData JDBC Driver for Salesforce Data Cloud data enables access to live data from dashboards and reports as if Salesforce Data Cloud were a relational database, allowing you to query Salesforce Data Cloud data using familiar SQL queries. This article shows how to connect to Salesforce Data Cloud data as a JDBC data source and create reports based on Salesforce Data Cloud data in JReport Designer.

Connect to Salesforce Data Cloud Data

  1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:
    ...
    set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Salesforce Data Cloud 2016\lib\cdata.jdbc.salesforcedatacloud.jar;
    ...
    
  2. Create a new data source by clicking File New Data Source.
  3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Salesforce Data Cloud), select JDBC, and click OK.
  4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
    • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
      cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver
    • URL: Enter the JDBC URL. This starts with jdbc:salesforcedatacloud: and is followed by a semicolon-separated list of connection properties.

      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.

        Below is a typical JDBC URL:

        jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;
    • User: The username to authenticate with; typically left blank.
    • Password: The password to authenticate with; typically left blank.
    πŸ‘ Configuring the connection to the JDBC Driver (Salesforce is shown.)
  5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

    πŸ‘ Adding Tables. (Salesforce is shown.)

    Click Done once the dialog has completed loading the tables.

  6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Salesforce Data Cloud), right-click on Queries, and select Add Query. πŸ‘ Adding a query for data to be used in the report. (Salesforce is shown.)
  7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK. πŸ‘ Selecting a table for the query. (Salesforce is shown.)
  8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
    SELECT [Account ID], [Account Name] FROM Account WHERE EmployeeCount > 250
    
    πŸ‘ Editing the query. (Salesforce is shown.)

    With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Salesforce Data Cloud data to a new or existing report.

    NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Salesforce Data Cloud Data to a Report

You are now ready to create a report with Salesforce Data Cloud data.

  1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
  2. Select the Query (or create a new one; see above).
  3. πŸ‘ Selecting the query to use. (Salesforce is shown.)
  4. Assign a Category and Value for the chart from the columns in your Query and click Finish.
  5. πŸ‘ Assigning columns to define the chart. (Salesforce is shown.)
  6. Click the View tab for your report to see the chart.
πŸ‘ Sample chart based on live data. (Salesforce is shown.)

Ready to get started?

Download a free trial of the Salesforce Data Cloud Driver to get started:

 Download Now

Learn more:

πŸ‘ Salesforce Data Cloud Icon
Salesforce Data Cloud JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Salesforce Data Cloud.