Excel Spreadsheet Automation on Close Data with the QUERY Formula
The CData Excel Add-In for Close provides formulas that can query Close data. The following three steps show how you can automate the following task: Search Close 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 Close 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 Close data, separated by semicolons.
Start by setting the Profile connection property to the location of the Close Profile on disk (e.g. C:\profiles\Close.apip). Next, set the ProfileSettings connection property to the connection string for Close (see below).
Close API Profile Settings
Locate your API key through Close's Settings menu under Your API Keys and create a new key if needed.
- 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.
- 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 Close data, such as Type.
- 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.
- Change the filter to change the data.
=CDATAQUERY("SELECT * FROM Activities WHERE Type = '"&B4&"'","Profile="&B1&";ProfileSettings="&B2&";Provider=API",B5)