Publish Reports with Salesforce 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 Salesforce brings this capability to Crystal Reports. This article shows how to create a report on Salesforce data that refreshes when you run the report.

Getting Started

---

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 Salesforce 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.

👁 Add JDBC File Path into CRConfig.xml file

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

Connect to Salesforce Data

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

1. Click File -> New -> Standard Report. 👁 Create a 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 Salesforce.

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

java -jar cdata.jdbc.salesforce.jar

There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

Multi-Factor Authentication (MFA)

If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

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 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:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode
   

5. Set the driver class name:

   cdata.jdbc.salesforce.SalesforceDriver
   

   👁 Create a new JDBC (JNDI) Connection
   
6. Select the tables needed in the report. 👁 Add the table.
   
7. You can also link tables from the Salesforce data in SAP Crystal Reports. Click on NEXT after adding the links between tables. 👁 Add multiple tables.
   👁 Link the tables.
   
8. 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.
   
9. Select the "Group By" field to group the information on the report. 👁 Add the Group By field.
   
10. Sort the groups based on summarised totals and click on NEXT. 👁 Group Sorting
    

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 Industry 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 initially specified.

👁 The final report.

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. 👁 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 Salesforce data using SAP Crystal Reports and a CData JDBC Driver. Learn more about the CData JDBC Driver for Salesforce and download a free trial from the Salesforce JDBC Driver page. Let our Support Team know if you have any questions.