VOOZH about

URL: https://www.cdata.com/kb/tech/smartsheet-jdbc-rsql.rst

⇱ Connect to Smartsheet Data in RazorSQL


Connect to Smartsheet Data in RazorSQL

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Smartsheet from wizards and query Smartsheet data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Smartsheet enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Smartsheet using wizards in RazorSQL.

About Smartsheet Data Integration

CData provides the easiest way to access and integrate live data from Smartsheet. Customers use CData connectivity to:

  • Read and write attachments, columns, comments and discussions.
  • View the data in individuals cells, report on cell history, and more.
  • Perform Smartsheet-specific actions like deleting or downloading attachments, creating, copying, deleting, or moving sheets, and moving or copying rows to another sheet.

Users frequently integrate Smartsheet with analytics tools such as Tableau, Crystal Reports, and Excel. Others leverage our tools to replicate Smartsheet data to databases or data warehouses.


Getting Started


Create a JDBC Data Source for Smartsheet Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.smartsheet.SmartsheetDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:smartsheet: and is followed by a semicolon-separated list of connection properties.

      Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, 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.

      👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

      A typical JDBC URL is the following:

      jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;
👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. Connection properties are defined in the JDBC URL. (QuickBooks is shown.)

Query Smartsheet Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.

👁 The resuls of a query in RazorSQL. (QuickBooks is shown.)

Ready to get started?

Download a free trial of the Smartsheet Driver to get started:

 Download Now

Learn more:

👁 Smartsheet Icon
Smartsheet JDBC Driver

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