Publish Reports with TaxJar Data in Crystal Reports

Ready to get started?

Download for a free trial:

Download Now

Learn more:

TaxJar JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with TaxJar.



Use the Report Wizard to design a report based on up-to-date TaxJar 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 TaxJar brings this capability to Crystal Reports. This article shows how to create a report on TaxJar data that refreshes when you run the report.

Deploy the JDBC Driver

Install the CData JDBC Driver for TaxJar 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 TaxJar Data

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

  1. Click File -> New -> Standard Report.
  2. Expand the JDBC node under Create New Connection and double-click Make a New Connection.
  3. In the wizard, enter the JDBC connection URL:

    jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;

    To authenticate to the TaxJar API, you will need to first obtain the API Key from the TaxJar UI.

    NOTE: the API is available only for Professional and Premium TaxJar plans.

    If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API. After obtaining the API Key, you can set it in the APIKey connection property.

    Additional Notes

    • By default, the CData connector will retrieve data of the last 3 months in cases where the entity support date range filtering. You can set StartDate to specify the minimum creation date of the data retrieved.
    • If the API Key has been created for a sandbox API account please set UseSandbox to true, but not all endpoints will work as expected. For more information, refer to the TaxJar developer documentation.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.taxjar.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.

  4. Set the driver class name:

    cdata.jdbc.taxjar.TaxJarDriver
  5. Select the tables and fields needed in the report. This example uses the TransactionID and UserID columns from the Orders table.

You can then configure grouping, sorting, and summaries. For example, this article groups on TransactionID and summarizes on UserID. 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 TransactionID column.

  1. In the Standard Report Creation Wizard, select the Bar Chart option and select the column you grouped by, TransactionID in this example, 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.

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.

  1. Click File -> Report Options and select the 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.

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.