Feed Smartsheet Data into FineReport

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Smartsheet JDBC Driver

Easy-to-use Smartsheet client enables Java-based applications to easily consume Smartsheet Sheets, Contacts, Folders, Groups, Users, etc.



How to set Smartsheet data as a JDBC data source in FineReport.

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

Set Up a JDBC Data Source of Smartsheet Data

Follow the instruction below to set Smartsheet data as a FineReport database connection.

  1. Copy the cdata.jdbc.smartsheet.jar file from the lib folder in the CData JDBC Driver for Smartsheet installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.smartsheet.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.smartsheet.Smartsheet Driver
  3. URL: A standard JDBC connection string using semicolon-separated connection properties.

    Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

    However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.smartsheet.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:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;
  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 Smartsheet set up, you can use it as FineReport data source.

Select Smartsheet 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 Smartsheet entities will appear as tables on the left pane.
  4. Write a SELECT statement for the Smartsheet data tables and columns that you want to load.
  5. Click preview and data is shown as table.

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