Manage Smartsheet Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Smartsheet seamlessly integrates Smartsheet data into database management tools like DBArtisan by enabling you to access Smartsheet data as a database. This article shows how to create a JDBC source for Smartsheet in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Smartsheet Data into DBArtisan Projects

Follow the steps below to register Smartsheet data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   Below is a typical connection string:

   jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
6. Finish the wizard to connect to Smartsheet data. Smartsheet entities are displayed in the Datasource Explorer.

You can now work with Smartsheet data as you work with any other database. See the driver help documentation for more information on the queries supported by the Smartsheet API.