Smartsheet Connector for SSISRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding using easy to use high performance API Connector If you are new with SSIS and ZappySys SSIS PowerPack then check below links to get started.
|
Connect to Smartsheet in other apps
|
Video Tutorial - Integrate Smartsheet data in SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Smartsheet integration in SSIS - How to configure connection for
Smartsheet - Features about
API Source (Authentication / Query Language / Examples / Driver UI) - Using
Smartsheet Connection in SSIS
Prerequisites
Before we perform steps listed in this article, you will need to make sure following prerequisites are met:- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
- Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages
How to read data from Smartsheet in SSIS (Export data)
In this section we will learn how to configure and use Smartsheet Connector in API Source to extract data from Smartsheet.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled Smartsheet Connector from Popular Connector List or press Search Online radio button to download Smartsheet Connector. Once downloaded simply use it in the configuration:
Smartsheet -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps to get 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".
SmartsheetOAuth (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 Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Steps to get 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.
SmartsheetStatic Token [Http]https://api.smartsheet.com/2.0Required Parameters Access Token Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding using easy to use high performance API Connector -
That's it! We are done! Just in a few clicks we configured the call to Smartsheet using Smartsheet Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Load Smartsheet data in SQL Server using Upsert Destination (Insert or Update)
Once you read data from the desired source, now let's see how to Load Smartsheet data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.
-
From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface
Connect our Source component to Upsert Destination
-
Double click on Upsert Destination component to configure it.
-
Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS -
Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
-
Click on OK to save Upsert Destination settings UI.
-
That's it. Run the SSIS Package and it will read the data from the Smartsheet and load the data in the SQL Server/PostgreSql/Redshift using Upsert Destination.
Video Tutorial - Write or lookup data to Smartsheet using SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for
Smartsheet integration in SSIS - How to configure connection for
Smartsheet - How to Write or lookup data to
Smartsheet - Features about SSIS API Destination
- Using
Smartsheet Connector in SSIS
How to write or lookup data to Smartsheet in SSIS (Import data)
In upper section we learned how to read data, now in this section we will learn how to configure Smartsheet in the API Source to Post data to the Smartsheet.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding using easy to use high performance API Connector -
Use a preinstalled Smartsheet Connector from Popular Connector List or press Search Online radio button to download Smartsheet Connector. Once downloaded simply use it in the configuration:
Smartsheet -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps to get 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".
SmartsheetOAuth (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 Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Steps to get 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.
SmartsheetStatic Token [Http]https://api.smartsheet.com/2.0Required Parameters Access Token Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding using easy to use high performance API Connector -
Finally, map the desired columns:
API Destination - SmartsheetRead / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding using easy to use high performance API Connector -
That's it; we successfully configured the POST API Call. In a few clicks we configured the Smartsheet API call using ZappySys Smartsheet Connector
Advanced topics
Actions supported by Smartsheet Connector
Smartsheet Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Search Query (use double quotes for exact search) |
|
||||||||||||||||||||||||||||||||||||||||
SheetId |
|
||||||||||||||||||||||||||||||||||||||||
Scope |
|
||||||||||||||||||||||||||||||||||||||||
Modified Since |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Modified Since |
|
||||||||||||||||||||||||||||||||||||||||
Include |
|
Parameter | Description |
---|---|
SheetId |
|
Column Ids (Default=All Columns) |
|
Parameter | Description |
---|---|
Row Id(s) - Comma separated (Blank=All Rows) |
|
Row Number(s) - Comma separated list (Blank=All Rows) |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
SheetId |
|
||||||
Row Id(s) - Comma separated |
|
||||||
Ignore If Rows Not Found |
|
Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add Row at Specific Location (Default=toBottom) |
|
||||||||||
Allow Partial Success (Default=False) |
|
||||||||||
Override Validation (Default=False) |
|
Parameter | Description |
---|---|
SheetId |
|
Parameter | Description |
---|---|
ReportId |
|
Parameter | Description |
---|---|
ReportId |
|
Parameter | Description |
---|---|
SheetId |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Modified Since |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Modified Since |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Modified Since |
|
Parameter | Description |
---|---|
ContactId |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Conclusion
In this article we discussed how to connect to Smartsheet in SSIS and integrate data without any coding. Click here to Download Smartsheet Connector for SSIS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Smartsheet Connector for SSIS
Documentation
More integrations
Other application integration scenarios for Smartsheet
Other connectors for SSIS
Download Smartsheet Connector for SSIS
Documentation
How to connect Smartsheet in SSIS?
How to get Smartsheet data in SSIS?
How to read Smartsheet data in SSIS?
How to load Smartsheet data in SSIS?
How to import Smartsheet data in SSIS?
How to pull Smartsheet data in SSIS?
How to push data to Smartsheet in SSIS?
How to write data to Smartsheet in SSIS?
How to POST data to Smartsheet in SSIS?
Call Smartsheet API in SSIS
Consume Smartsheet API in SSIS
Smartsheet SSIS Automate
Smartsheet SSIS Integration
Integration Smartsheet in SSIS
Consume real-time Smartsheet data in SSIS
Consume real-time Smartsheet API data in SSIS
Smartsheet ODBC Driver | ODBC Driver for Smartsheet | ODBC Smartsheet Driver | SSIS Smartsheet Source | SSIS Smartsheet Destination
Connect Smartsheet in SSIS
Load Smartsheet in SSIS
Load Smartsheet data in SSIS
Read Smartsheet data in SSIS
Smartsheet API Call in SSIS