Smartsheet Connector for SSAS
In this article you will learn how to integrate Using Smartsheet Connector you will be able to connect, read, and write data from within SSAS. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Smartsheet in other apps
|
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys 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 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".
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 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.
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 Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read Smartsheet data in SSAS cube
With the data source created in the Data Gateway (previous step), we're now ready to read Smartsheet data in an SSAS cube. Before we dive in, open Visual Studio and create a new Analysis Services project. Then, you're all set!
Create data source based on ZappySys Data Gateway
Let's start by creating a data source for a cube, based on the Data Gateway's data source we created earlier. So, what are we waiting for? Let's do it!
- Create a new data source:
- Once a window opens, select Create a data source based on an existing or new connection option and click New...:
-
Here things become a little complicated, but do not despair, it's only for a little while.
Just perform these little steps:
- Select Native OLE DB\SQL Server Native Client 11.0 as provider.
- Enter your Server name (or IP address) and Port, separated by a comma.
- Select SQL Server Authentication option for authentication.
- Input User name which has admin permissions in the ZappySys Data Gateway.
- In Database name field enter the same data source name you use in the ZappySys Data Gateway.
- Hopefully, our hard work is done, when we Test Connection.
SmartsheetDSNSmartsheetDSNIf SQL Server Native Client 11.0 is not listed as Native OLE DB provider, try using these:- Microsoft OLE DB Driver for SQL Server
- Microsoft OLE DB Provider for SQL Server
- Indeed, life is easy again:
Add data source view
We have data source in place, it's now time to add a data source view. Let's not waste a single second and get on to it!
- Start by right-clicking on Data Source Views and then choosing New Data Source View...:
- Select the previously created data source and click Next:
- Ignore the Name Matching window and click Next.
-
Add the tables you will use in your SSAS cube:
For cube dimensions, consider creating a Virtual Table in the Data Gateway's data source. Use the
DISTINCT
keyword in theSELECT
statement to get unique values from the facts table, like this:SELECT DISTINCT Country FROM Customers
For demonstration purposes we are using sample tables which may not be available in Smartsheet. - Review your data source view and click Finish:
- Add the missing table relationships and you're done!
Create cube
We have a data source view ready to be used by our cube. Let's create one!
- Start by right-clicking on Cubes and selecting New Cube... menu item:
- Select tables you will use for the measures:
- And then select the measures themselves:
- Don't stop and select the dimensions too:
- Move along and click Finish before the final steps:
- Review your cube before processing it:
- It's time for the grand finale! Hit Process... to create the cube:
- A splendid success!
Execute MDX query
The cube is created and processed. It's time to reap what we sow! Just execute an MDX query and get Smartsheet data in your SSAS cube:
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
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 |
|
Smartsheet Connector Examples for SSAS Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Tables - Sheets [Read more...]
SELECT * FROM Sheets --Where Id='5815807987847055'
Tables - Contacts [Read more...]
SELECT * FROM Contacts --Where Id='abcd1234abc'
Get sheet rows [Read more...]
This example shows how to query any Smart Sheet by its name. If you have space in the sheet name or column name then use bracket ( [my name] ) or double quotes ("my name") around it.
SELECT Id,RowNumber,[Some Column 1],[Some Column 2] FROM [My Sheet Name] --Where Id='5815807987847044'
Get Sheet Rows by Id(s) (single or multiple) [Read more...]
This example shows how to list multiple Sheet Rows by its Id(s). Supply Comma Separated List of Row IDs (Upto 100 recommended). You can also supply Row Number(s) instead of ID(s). If you supply both Id(s) and Row Number(s) then only common rows are selected.
SELECT * FROM get_sheet_rows_by_ids
WITH (
SheetId=3482072521854852
, Id='1312208360476548,6941707894689668,5815807987847044'
--OR-- (If you supply both Id and RowNumber then only Common Rows selected
--, RowNumber='1,2,100'
)
Get sheet rows by row number(s) (single or multiple) [Read more...]
This example shows how to list multiple Sheet Rows by its Row Number(s). Supply Comma Separated List of Row Numbers (Upto 100 recommended). You can also supply Row Id instead of Row Number(s). If you supply both Id(s) and Row Number(s) then only common rows are selected.
SELECT * FROM get_sheet_rows_by_ids
WITH (
SheetId=3482072521854852
, RowNumber='1,2,100'
--OR-- (If you supply both Id and RowNumber then only Common Rows selected
--, Id='1312208360476548,6941707894689668,5815807987847044'
)
Create a new sheet row [Read more...]
This example shows how to create a new Sheet Row by calling INSERT statement. Optionally specify location where you like to insert new row (default is at bottom).
INSERT INTO [My Sheet]
( [Some Text Number Column], [Some Checkbox Column], [Some Contact List Column], [Some Date Column], [Some PickList Column], [Some Multi PickList Column], [Some Symbol Column] )
VALUES
('Updated at <<FUN_NOW>>', true, 'something@abc.com', '2024-12-31','Not Started','Value2,Value4','Green,Yellow')
/*
WITH(
RowLocation='"toTop": true' --insert at the top
--OR--
--RowLocation='"siblingId": 1231234567' --insert after some sibling row id
)
*/
Update a new sheet row [Read more...]
This example shows how to update specific columns of a Sheet Row by calling UPDATE statement.
UPDATE [My Sheet]
SET [Some Text Number Column]='Updated - <<FUN_NOW>>',
[Some Checkbox Column] = true,
[Some Contact List Column] = 'something@abc.com',
[Some Date Column] = '<<FUN_NOW>>',
[Some PickList Column] = 'Not Started',
[Some Multi PickList Column] = 'Value2,Value4',
[Some Symbol Column] = 'Green,Yellow'
WHERE Id=7522710866202500
WITH(Output=1)
Delete sheet row(s) - single or multiple [Read more...]
This example shows how to delete single or multiple sheet rows by calling DELETE statement. You can supply a single Row Id or a comma-separated list of row Ids (Upto 100 recommended).
DELETE FROM [My Sheet] WHERE Id=7522710866202500
--WITH(IgnoreRowsNotFound='true' --or false)
--Or
--DELETE FROM [My Sheet] WHERE Id='7522710866202500,7522710866202501,7522710866202502'
--WITH(IgnoreRowsNotFound='true' --or false)
Export Sheet (as PDF, Excel, CSV) [Read more...]
This example shows how to export Sheet to PDF, CSV or Excel file). If you export to PDF then you can also supply Paper size.
SELECT * FROM export_sheet WITH(
SheetId=1592926391979908,
,TargetFilePath='c:\temp\exported_sheet_as_excel_file.xlsx' --or .pdf, .csv
,Format='application/vnd.ms-excel' --or-- application/pdf --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize='LETTER' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)
Export Report (as PDF, Excel, CSV) [Read more...]
This example shows how to export Report to PDF, CSV or Excel file). If you export to PDF then you can also supply Paper size.
SELECT * FROM export_report WITH(
ReportId=2972339541069700,
,TargetFilePath='c:\temp\exported_report_as_excel_file.xlsx' --or .pdf, .csv
,Format='application/vnd.ms-excel' --or-- application/pdf --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize='LETTER' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)
Send Report via Email to Users or Groups (as PDF, Excel) [Read more...]
This example shows how to send Report via Email (PDF or Excel format) to list of emails or groups.
SELECT * FROM send_report_email
WITH(
ReportId='2972339541069700'
, Subject='Test report'
, Message='This email contains report attachment'
, CcMe='true'
, PaperSize='LETTER'
, SendToEmails='bob@mycompany.com~sam@mycompany.com'
--OR (Emails or Group only - one allowed)
--, SendToGroups='10022222001~10333330002'
)
Send Sheet via Email to Users or Groups (as PDF, Excel) [Read more...]
This example shows how to send Sheet via Email (PDF or Excel format) to list of emails or groups.
SELECT * FROM send_sheet_email
WITH(
SheetId='1592926391979908'
, Subject='Test report'
, Message='This email contains report attachment'
, CcMe='true'
, PaperSize='LETTER'
, SendToEmails='bob@mycompany.com~sam@mycompany.com'
--OR (Emails or Group only - one allowed)
--, SendToGroups='10022222001~10333330002'
)
Conclusion
In this article we discussed how to connect to Smartsheet in SSAS and integrate data without any coding. Click here to Download Smartsheet Connector for SSAS 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 SSAS
Documentation
More integrations
Other application integration scenarios for Smartsheet
Other connectors for SSAS
Download Smartsheet Connector for SSAS
Documentation
How to connect Smartsheet in SSAS?
How to get Smartsheet data in SSAS?
How to read Smartsheet data in SSAS?
How to load Smartsheet data in SSAS?
How to import Smartsheet data in SSAS?
How to pull Smartsheet data in SSAS?
How to push data to Smartsheet in SSAS?
How to write data to Smartsheet in SSAS?
How to POST data to Smartsheet in SSAS?
Call Smartsheet API in SSAS
Consume Smartsheet API in SSAS
Smartsheet SSAS Automate
Smartsheet SSAS Integration
Integration Smartsheet in SSAS
Consume real-time Smartsheet data in SSAS
Consume real-time Smartsheet API data in SSAS
Smartsheet ODBC Driver | ODBC Driver for Smartsheet | ODBC Smartsheet Driver | SSIS Smartsheet Source | SSIS Smartsheet Destination
Connect Smartsheet in SSAS
Load Smartsheet in SSAS
Load Smartsheet data in SSAS
Read Smartsheet data in SSAS
Smartsheet API Call in SSAS