Smartsheet Connector for Talend StudioRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector In this article you will learn how to quickly and efficiently integrate Smartsheet data in Talend Studio without coding. We will use high-performance Smartsheet Connector to easily connect to Smartsheet and then access the data inside Talend Studio. Let's follow the steps below to see how we can accomplish that! Smartsheet Connector for Talend Studio is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Smartsheet in other apps
|
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
SmartsheetDSN
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Smartsheet" from the list of Popular Connectors. If "Smartsheet" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
SmartsheetDSNSmartsheet -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps how to get and use Smartsheet credentials
OAuth Walkthrough
Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.
NOTE: For users of apps like AWS AppFabric, you will need a Tenant ID. You can find your Tenant ID in Admin Center under Security & Controls. There is a Smartsheet Tenant ID pane.
First Steps
Before you can start using OAuth 2.0 with your app, Smartsheet needs the following information:
- You must register with Smartsheet to get a developer account*. The developer account gives you access to "Developer Tools", which is where you manage your app.
- In "Developer Tools", complete any required fields in your developer profile.
- In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
- Review the list of access scopes. You'll need to choose which ones your app needs to get to a user's Smartsheet data, and then ask the user to consent to that access.
- After you've worked through these steps, you'll be ready to implement the OAuth Flow.
Open Developer Tools
- Log in to Smartsheet with your developer account.
- Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
- Do one of the following:
- If you need to register an app, click "Create New App".
- If you need to manage an app, click "view/edit" for the app.
Register Your App Using Developer Tools
- Log in to Smartsheet with your developer account.
- Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
- In the "Create New App" form, provide the following information:
- Name: the name the user sees to identify your app
- Description: a brief description intended for the user
- URL: the URL to launch your app, or the landing page if not a web app
- Contact/support: support information for the user
- Redirect URL: also known as a callback URL. The URL within your application that will receive the OAuth 2.0 credentials After you click "Save", Smartsheet assigns a client Id and secret to your app. Make a note of these Ids for the next steps; however, you can always look them up again in "Developer Tools".
Fill in all required parameters and set optional parameters if needed:
SmartsheetDSNSmartsheetOAuth (Dynamic Token) [OAuth]https://api.smartsheet.com/2.0Required Parameters ClientId Fill-in the parameter... ClientSecret Fill-in the parameter... Scope Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 5 RetryMultiplyWaitTime True Steps how to get and use Smartsheet credentials
Raw Token Requests
If you want to get started quickly, or are developing a standalone application that can run with your credentials, follow these instructions:
- Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
- Click the "API Access" tab.
- Click the "Generate new access token" button to obtain an access token.
The access token must be sent with every API call in an HTTP authorization header (except for therequests to Get Access Token or Refresh Access Token). Once you have an access token, include it in the Authorization header for every request you make:
Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
The header name is Authorization and the value of the header is Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789. Since the access token is being transmitted in clear text, all API calls are done over HTTPS.
NOTE: A best practice is to use a shared account, such as ticket-processor@example.com, rather than your individual work account.
Fill in all required parameters and set optional parameters if needed:
SmartsheetDSNSmartsheetStatic Token [Http]https://api.smartsheet.com/2.0Required Parameters Access Token Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 5 RetryMultiplyWaitTime True -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API ConnectorSmartsheetDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Talend Studio to retrieve data from Smartsheet. Hit OK button to use this query in the next step.
SELECT * FROM Sheets --Where Id='5815807987847055'
Some parameters configured in this window will be passed to the Smartsheet API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Talend Studio:
ZappySys API Driver - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API ConnectorSmartsheetDSNSELECT * FROM Sheets --Where Id='5815807987847055'
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Smartsheet API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Smartsheet servers). -
Click OK to finish creating the data source.
Read Smartsheet data in Talend Studio
To read Smartsheet data in Talend Studio, we'll need to complete several steps. Let's get through them all right away!
Create connection for input
- First of all, open Talend Studio
-
Create a new connection:
-
Select Microsoft SQL Server connection:
-
Name your connection:
-
Fill-in connection parameters and then click Test connection:
SmartsheetDSN
-
If the List of modules not installed for this operation window shows up, then download and install all of them:
Review and accept all additional module license agreements during the process
-
Finally, you should see a successful connection test result at the end:
Add input
-
Once we have a connection to ZappySys Data Gateway created, we can proceed by creating a job:
-
Simply drag and drop ZappySys Data Gateway connection onto the job:
-
Then create an input based on ZappySys Data Gateway connection:
-
Continue by configuring a SQL query and click Guess schema button:
-
Finish by configuring the schema, for example:
Add output
We are ready to add an output. From Palette drag and drop a tFileOutputDelimited output and connect it to the input:
Run the job
Finally, run the job and integrate your Smartsheet data:
Actions supported by Smartsheet Connector
Learn how to perform common Smartsheet actions directly in Talend Studio with these how-to guides:
- Add Sheet Rows
- Delete Sheet Rows
- Export Report (to PDF, Excel, CSV file)
- Export Sheet (to PDF, Excel, CSV file)
- Get Contacts
- Get Sheet Fields
- Get Sheet Row by ID(s)
- Get Sheet Rows
- List Contacts
- List Groups
- List Reports
- List Sheets
- Search (cell data or other object types)
- Send Report via Email (EXCEL, PDF, or PDF_GANTT format)
- Send Sheet via Email (EXCEL, PDF, or PDF_GANTT format)
- update_sheet_rows
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Smartsheet in Talend Studio and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Smartsheet, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Smartsheet Connector for Talend Studio and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Smartsheet Connector for Talend Studio Documentation
More integrations
Other connectors for Talend Studio
Other application integration scenarios for Smartsheet
How to connect Smartsheet in Talend Studio?
How to get Smartsheet data in Talend Studio?
How to read Smartsheet data in Talend Studio?
How to load Smartsheet data in Talend Studio?
How to import Smartsheet data in Talend Studio?
How to pull Smartsheet data in Talend Studio?
How to push data to Smartsheet in Talend Studio?
How to write data to Smartsheet in Talend Studio?
How to POST data to Smartsheet in Talend Studio?
Call Smartsheet API in Talend Studio
Consume Smartsheet API in Talend Studio
Smartsheet Talend Studio Automate
Smartsheet Talend Studio Integration
Integration Smartsheet in Talend Studio
Consume real-time Smartsheet data in Talend Studio
Consume real-time Smartsheet API data in Talend Studio
Smartsheet ODBC Driver | ODBC Driver for Smartsheet | ODBC Smartsheet Driver | SSIS Smartsheet Source | SSIS Smartsheet Destination
Connect Smartsheet in Talend Studio
Load Smartsheet in Talend Studio
Load Smartsheet data in Talend Studio
Read Smartsheet data in Talend Studio
Smartsheet API Call in Talend Studio