Connect to Smartsheet Data in CloverDX (formerly CloverETL)

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.



Transfer Smartsheet data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Smartsheet enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Smartsheet as sources and destinations. In this article, you will use the JDBC Driver for Smartsheet to set up a simple transfer into a flat file. The CData JDBC Driver for Smartsheet enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Smartsheet as sources and destinations. In this article, you will use the JDBC Driver for Smartsheet to set up a simple transfer into a flat file.

Connect to Smartsheet as a JDBC Data Source

  1. Create the connection to Smartsheet data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.smartsheet.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

    jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

Query Smartsheet Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Smartsheet JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT TaskName, Progress FROM Sheet_Event_Plan_Budget

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Sheet_Event_Plan_Budget table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.