Smartsheet Connector for SSIS Read / 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 SSIS without coding. We will use high-performance Smartsheet Connector to easily connect to Smartsheet and then access the data inside SSIS. Let's follow the steps below to see how we can accomplish that! Download Documentation Smartsheet Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them).

Connect to Smartsheet in other apps Connect to Smartsheet in SQL Server Connect to Smartsheet in Power BI Connect to Smartsheet in SSRS Connect to Smartsheet in Informatica Connect to Smartsheet in MS Access Connect to Smartsheet in MS Excel Connect to Smartsheet in SSAS Connect to Smartsheet in C# Connect to Smartsheet in Python Connect to Smartsheet in JAVA Connect to Smartsheet in Tableau Connect to Smartsheet in SAP Crystal Reports Connect to Smartsheet in Azure Data Factory (Pipeline) Connect to Smartsheet in Azure Data Factory (SSIS) Connect to Smartsheet in Talend Studio Connect to Smartsheet in UiPath Connect to Smartsheet in PowerShell Connect to Smartsheet in ODBC

Video Tutorial - Integrate Smartsheet data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

• How to download and install the required PowerPack for Smartsheet integration in SSIS
• How to configure the connection for Smartsheet
• Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
• How to use the Smartsheet in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Smartsheet in SSIS (Export data)

1. Begin with opening Visual Studio and Create a New Project.

2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

3. In the new SSIS project screen you will find the following:

   1. SSIS ToolBox on left side bar
   2. Solution Explorer and Property Window on right bar
   3. Control flow, data flow, event Handlers, Package Explorer in tab windows
   4. 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.

4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

   

5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
   

6. Select New Connection to create a new connection:
   

7. 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

   

8. 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.

    OAuth (Dynamic Token) [OAuth]

   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:

   1. 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.
   2. In "Developer Tools", complete any required fields in your developer profile.
   3. In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
   4. 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.
   5. After you've worked through these steps, you'll be ready to implement the OAuth Flow.

   Open Developer Tools

   1. Log in to Smartsheet with your developer account.
   2. Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
   3. 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

   1. Log in to Smartsheet with your developer account.
   2. Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
   3. 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".

   
   Configuring authentication parameters
   

   Smartsheet

   OAuth (Dynamic Token) [OAuth]

   https://api.smartsheet.com/2.0

   Required 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

   

    Static Token [Http]

   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:

   1. Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
   2. Click the "API Access" tab.
   3. 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.

   
   Configuring authentication parameters
   

   Smartsheet

   Static Token [Http]

   https://api.smartsheet.com/2.0

   Required Parameters
   Access Token	Fill-in the parameter...
   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429|503
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

   API Source - Smartsheet

   Read / 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

   

10. 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)

    

Write data to Smartsheet using SSIS (Import data)

Step-by-step instructions

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.

1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

2. 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.
   

3. Select New Connection to create a new connection:
   

   API Destination - Smartsheet

   Read / 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

   

4. 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

   

5. 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.

    OAuth (Dynamic Token) [OAuth]

   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:

   1. 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.
   2. In "Developer Tools", complete any required fields in your developer profile.
   3. In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
   4. 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.
   5. After you've worked through these steps, you'll be ready to implement the OAuth Flow.

   Open Developer Tools

   1. Log in to Smartsheet with your developer account.
   2. Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
   3. 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

   1. Log in to Smartsheet with your developer account.
   2. Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
   3. 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".

   
   Configuring authentication parameters
   

   Smartsheet

   OAuth (Dynamic Token) [OAuth]

   https://api.smartsheet.com/2.0

   Required 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

   

    Static Token [Http]

   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:

   1. Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
   2. Click the "API Access" tab.
   3. 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.

   
   Configuring authentication parameters
   

   Smartsheet

   Static Token [Http]

   https://api.smartsheet.com/2.0

   Required Parameters
   Access Token	Fill-in the parameter...
   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429|503
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

   API Destination - Smartsheet

   Read / 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

   

7. Finally, map the desired columns:

   API Destination - Smartsheet

   Read / 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

   

8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Smartsheet API call using ZappySys Smartsheet Connector

   

Load Smartsheet data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Smartsheet data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

2. Connect your SSIS source component to Upsert Destination.

3. Double-click on Upsert Destination component to open configuration window.

4. Start by selecting the Action from the list.

5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

   

9. Click OK to save the configuration.

10. Run the package and Smartsheet data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    

11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

• How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog)

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

• Preparing ADF instance to use SSIS PowerPack

Actions supported by Smartsheet Connector

Smartsheet Connector supports following actions for REST API integration:

Conclusion

In this article we showed you how to connect to Smartsheet in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download Smartsheet Connector for SSIS 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 SSIS Documentation

More integrations

Other connectors for SSIS

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Google Analytics

HTML Table

Build your own Custom API Connector

Other application integration scenarios for Smartsheet

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC