Ready to get started?

Learn more about the CData JDBC Driver for Smartsheet or download a free trial:

Download Now

Connect to Smartsheet Data in HULFT Integrate

Connect to Smartsheet as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Smartsheet, HULFT Integrate can work with live Smartsheet data. This article walks through connecting to Smartsheet and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Smartsheet data. When you issue complex SQL queries to Smartsheet, the driver pushes supported SQL operations, like filters and aggregations, directly to Smartsheet and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Smartsheet data using native data types.

Enable Access to Smartsheet

To enable access to Smartsheet data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.smartsheet.jar (and cdata.jdbc.smartsheet.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Smartsheet Data

Once you copy the JAR files, you can create a project with access to Smartsheet data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: SmartsheettoCSV)

Once you create the project, add components to the script to copy Smartsheet data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Smartsheet. Set the following properties:
    • Name: Smartsheet Connection Settings
    • Driver class name: cdata.jdbc.smartsheet.SmartsheetDriver
    • URL: jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

      Built-in Connection String Designer

      For assistance 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.

      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.

  2. Write your SQL statement. For example:
    SELECT TaskName, Progress FROM Sheet_Event_Plan_Budget
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. Sheet_Event_Plan_Budget.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map Smartsheet Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Smartsheet data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Smartsheet and start working with your live Smartsheet data in HULFT Integrate. Reach out to our Support Team if you have any questions.