How to Export Sheet (to PDF, Excel, CSV file) — Smartsheet Connector for SQL Server

Introduction

In this article we will delve deeper into Smartsheet and SQL Server integration, and will learn how to export sheet (to pdf, excel, csv file). We are continuing from where we left off. By this time, you must have created ODBC Data Source and connected to Smartsheet. So, let's not waste time and begin.

Use Query Builder to generate SQL query

  1. The first thing you have to do is open Query Builder:

    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
    Open Query Builder in API ODBC Driver to read and write data to REST API
  2. Then simply select the Export Sheet (to PDF, Excel, CSV file) endpoint (action).

  3. Continue by configuring the Required parameters. You can also set optional parameters too.

  4. Move on by hitting Preview Data button to preview the results.

  5. If you see the results you need, simply copy the generated query:

    Export Sheet (to PDF, Excel, CSV file)
    Required Parameters
    SheetId Select the value from the dropdown
    Optional Parameters
    RawOutputDataRowTemplate {"Id": "[$SheetId$]", "Status":"Done", "TargetFilePath":"[$TargetFilePath,FUN_JSONENC$]"}
    Advanced Properties
    RawOutputDataRowTemplate {"Id": "[$SheetId$]", "Status":"Done", "TargetFilePath":"[$TargetFilePath,FUN_JSONENC$]"}
    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
    )
    Query Builder
  6. That's it! You can use this query in SQL Server.

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

SQL query examples

Use these SQL queries in your SQL Server data source:

How to Export Sheet (as PDF, Excel, CSV)

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
)

Stored Procedures and Views

Create Custom Stored Procedure

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

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. 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>';
    

    ZappySys Driver - Create Custom Stored Procedure

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

    ZappySys Driver - Execute Custom Stored Procedure

  5. 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([LS_TO_SMARTSHEET_IN_GATEWAY], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

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

    ZappySys Driver - Create Custom Table

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

    ZappySys Driver - Execute Custom Virtual Table Query

  6. 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([LS_TO_SMARTSHEET_IN_GATEWAY], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Export Sheet (to PDF, Excel, CSV file) in SQL Server

We are at the point where we can reiterate on how to use the SQL query, Stored Procedures or Views in SQL Server:

  1. First of all, copy the generated SQL query from the previous step.

  2. Then open Microsoft SQL Server Management Studio.

  3. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([LS_TO_SMARTSHEET_IN_GATEWAY], 'SELECT * FROM Sheets --Where Id=''5815807987847055''')
    Execute query at Linked Server to ZappySys Data Gateway in SSMS

    SELECT * FROM OPENQUERY([LS_TO_SMARTSHEET_IN_GATEWAY], 'SELECT * FROM Sheets --Where Id=''5815807987847055''')

More integrations

Other application integration scenarios for Smartsheet

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications