Feed X-Cart Data into FineReport

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with X-Cart.



How to set X-Cart data as a JDBC data source in FineReport.

The CData JDBC Driver for X-Cart fully implements the JDBC standard and can provide X-Cart data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set X-Cart data as JDBC data source in FineReport and view X-Cart data as a table in the Report Designer.

Set Up a JDBC Data Source of X-Cart Data

Follow the instruction below to set X-Cart data as a FineReport database connection.

  1. Copy the cdata.jdbc.xcart.jar file from the lib folder in the CData JDBC Driver for X-Cart installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.xcart.lic file as well.
  2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

  1. Database: Others
  2. JDBC Driver: cdata.jdbc.xcart.XCart Driver
  3. URL: A standard JDBC connection string using semicolon-separated connection properties.

    An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

    • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
    • Search for REST API Module. Install the Module.
    • After the module has been installed, you need to set it up.
      • Go to the Settings section for the REST API Module.
      • On the settings page specify the API Key (only read)
    • Set the ApiKey and Url to the connection property to connect to data.

    Built-in Connection String Designer

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

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

    A typical JDBC URL is below:

    jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;
  4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to X-Cart set up, you can use it as FineReport data source.

Select X-Cart Data in the Report Designer.

  1. Click to add a new template data set and select DB query to open the database query window.
  2. Choose the JDBC connection that you created from the dropdown list.
  3. The X-Cart entities will appear as tables on the left pane.
  4. Write a SELECT statement for the X-Cart data tables and columns that you want to load.
  5. Click preview and data is shown as table.

With these simple steps, X-Cart can be used as a JDBC data source in FineReport.