VOOZH about

URL: https://www.cdata.com/kb/tech/simplesat-excel-cdataquery.rst

⇱ Excel Spreadsheet Automation on Simplesat Data with the QUERY Formula


Excel Spreadsheet Automation on Simplesat Data with the QUERY Formula

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Pull data from Simplesat, automate spreadsheets, and more with the QUERY formula.

The CData Excel Add-In for Simplesat provides formulas that can query Simplesat data. The following three steps show how you can automate the following task: Search Simplesat data for a user-specified value and then organize the results into an Excel spreadsheet.

The syntax of the CDATAQUERY formula is the following:

=CDATAQUERY(Query, [Connection], [Parameters], [ResultLocation]);

This formula requires three inputs:

  • Query: The declaration of the Simplesat data records you want to retrieve, written in standard SQL.
  • Connection: Either the connection name, such as APIConnection1, or a connection string. The connection string consists of the required properties for connecting to Simplesat data, separated by semicolons.

    Using API Key Authentication

    Simplesat uses API Key authentication. To obtain your API key, log in to your Simplesat account and navigate to Workspace Settings > API. Copy the API key value for use in the connection string.

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Simplesat API key obtained from workspace settings.
  • ResultLocation: The cell that the output of results should start from.

Pass Spreadsheet Cells as Inputs to the Query

The procedure below results in a spreadsheet that organizes all the formula inputs in the first column.

  1. Define cells for the formula inputs. In addition to the connection inputs, add another input to define a criterion for a filter to be used to search Simplesat data, such as .
  2. In another cell, write the formula, referencing the cell values from the user input cells defined above. Single quotes are used to enclose values such as addresses that may contain spaces.
  3. =CDATAQUERY("SELECT * FROM Surveys WHERE = '"&B5&"'","Profile="&B1&";AuthScheme="&B2&";ProfileSettings="&B3&";Provider=API",B6)
    👁 Formula inputs used in this example. (Google Apps is shown.)
  4. Change the filter to change the data. 👁 The outputs of the formula. (Google Apps is shown.)