Smartsheet Connector for Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) without coding. We will use high-performance Smartsheet Connector to easily connect to Smartsheet and then access the data inside Azure Data Factory (Pipeline). Let's follow the steps below to see how we can accomplish that! Download Documentation Smartsheet Connector for Azure Data Factory (Pipeline) 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 Connect to Smartsheet in SSIS 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 (SSIS) Connect to Smartsheet in Talend Studio Connect to Smartsheet in UiPath Connect to Smartsheet in PowerShell Connect to Smartsheet in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Smartsheet using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from Smartsheet. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
   Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN.

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

   SmartsheetDSN

   Smartsheet

   

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

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

   Fill in all required parameters and set optional parameters if needed:

   SmartsheetDSN

   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.

   Fill in all required parameters and set optional parameters if needed:

   SmartsheetDSN

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

   SmartsheetDSN

   

7. 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 Azure Data Factory (Pipeline) 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 data much faster.

8. 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 Azure Data Factory (Pipeline):

   

   ZappySys API Driver - 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

   SmartsheetDSN

   SELECT * FROM Sheets --Where Id='5815807987847055'

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole 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).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in Azure Data Factory (ADF) from ODBC datasource (Smartsheet)

1. To start press New button:

   

2. Select "Azure, Self-Hosted" option:

   

3. Select "Self-Hosted" option:

   

4. Set a name, we will use "OnPremisesRuntime":

   

5. Download and install Microsoft Integration Runtime.

6. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

   

7. After finishing registering the Integration Runtime node, you should see a similar view:

   

8. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

   

9. Go to Linked services section and create a new Linked service based on ODBC:

   

10. Select "ODBC" service:

    

11. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    SmartsheetDSN

    DSN=SmartsheetDSN

    

12. For created ODBC service create ODBC-based dataset:

    

13. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    

14. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    

15. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    

Actions supported by Smartsheet Connector

Learn how to perform common Smartsheet actions directly in Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) Documentation

More integrations

Other connectors for Azure Data Factory (Pipeline)

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

Build your own Custom API Connector

Other application integration scenarios for Smartsheet

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: