About Smartsheet connector
Etlworks Smartsheet connector allows fast, real-time access to Smarthseet data. The connector works just like any other database connector.
Etlworks partnered with CData to provide access to the Smartsheet API using industry-standard JDBC protocol. Read about CData Smartsheet JDBC connector.
When to use Smartsheet connector
1. Enable Smartsheet connector for your Etlworks account. Contact email@example.com to enable connector.
2. Obtain personal API Access token.
Step 1. Log on to Smartsheet.
Step 2. In the Account menu with the user icon at the top right, select the Apps&Integrations... option.
Step 3. In the Personal Settings window, select the API Access option in the menu to the left.
Step 4. Under Manage API Access Tokens, click the Generate new access token button.
Step 5. Name your new access token and click OK.
Step 6. Your access token will now be displayed once. For security reasons, it will not be displayed again.
Creating a connection
Step 1. In the Connections window click the
+ button and type in Smartsheet.
Step 2. Enter connection parameters
- URL - the JDBC connection string. Keep the default value.
- Personal Access Token - the personal API access token obtained in a previous step
Use Other parameters to specify the connection string options. Read about available connection string options.
Working with Smartsheet
Smartsheet data model
Read about the Smartsheet API data model.
Stored Procedures are available to complement the data available from the REST Data Model. Sometimes it is necessary to update the data available from a view using a stored procedure because the data does not provide direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a data set that contains the collection of tuples that constitute the response.
Read about available stored procedures.
To call stored procure from the SQL flow or from Before/After SQL use EXEC sp_name params=value syntax. Example:
EXEC DeleteSheet SheetId = 'id'SheetName = 'name'
Extracting data from Smartsheet
Extracting data from Smartsheet is similar to extracting data from the relational database.
Step 1. Create a Smartsheet connection which will be used as a source (FROM).
Step 3. Create a flow where the source is a database and the destination is a connection created in step 2, for example, a relational database.
Step 4. Add a new source-to-destination transformation.
Step 5. Select Smartsheet connection created in step 1 as a source connection and select the worksheet you are extracting data from:
Step 6. Select TO connection, format (if needed) and object (for example database table) to load data into.
Step 7. Click MAPPING and optionally enter Source Query (you don't need a query if you are extracting data from the Smarthseet worksheet unconditionally).
Step 8. Optionally define the per-field mapping.
Step 9. Add more transformations if needed.
Loading data in Smartsheet
loading data in Smartsheet is similar to loading data into a relational database.
Step 1. Create a source connection and a format (if needed).
Step 2. Create a destination Smartsheet connection.
Step 3. Create a flow where the destination is a database.
Step 4. Add new source-to-destination transformation.
Step 5. Select FROM and TO connections and objects (also a FROM format if needed).
Step 6. Optionally define the per-field mapping.
Step 7. Add more transformations if needed.
Browsing data in Smartsheet
You must have a Smartshseet connection to browse objects and run SQL queries.
Use Explorer to browse data and metadata in Smartsheet as well as execute stored procedures, DML and SELECT queries against Smartsheet connection.