Ready to get started?

Publish Reports with Couchbase Data in Crystal Reports

Use the Report Wizard to design a report based on up-to-date Couchbase data.

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

Deploy the JDBC Driver

Install the CData JDBC Driver for Couchbase 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 CRConfig.xml is usually located at 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 Couchbase Data

After deploying the JDBC Driver for Couchbase, you can then use the Report Wizard to add Couchbase data to a new report.

Click File -> New -> Standard Report.

Expand the JDBC node under Create New Connection and double-click Make a New Connection.

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Set the driver class name:

cdata.jdbc.couchbase.CouchbaseDriver

Select the tables and fields needed in the report. This example uses the FirstName and TotalDue columns from the Customer table.

You can then configure grouping, sorting, and summaries. For example, this article groups on FirstName and summarizes on TotalDue. 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 that aggregates the values in the FirstName column.

In the Standard Report Creation Wizard, select the Bar Chart option and select the column you grouped by, FirstName in this example, in the On Change Of menu.

In the Show Summary menu, select the summary you created.

Select filters and a template, as needed, to finish the wizard.

Preview the finished report to view the chart, populated with your data. If you want to filter out null values, use a SelectionFormula.

Working with Remote Data

To ensure that you see updates to volatile 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 will need to have selected a column to group on in the report creation wizard.

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, instead of the entire table.