Excel Spreadsheet Automation on Helpscout Data with the QUERY Formula

The CData Excel Add-In for Helpscout provides formulas that can query Helpscout data. The following three steps show how you can automate the following task: Search Helpscout 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 Helpscout 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 Helpscout data, separated by semicolons.

  Start by setting the Profile connection property to the location of the Helpscout Profile on disk (e.g. C:\profiles\Helpscout.apip). Next, set the ProfileSettings connection property to the connection string for Helpscout (see below).

  Helpscout API Profile Settings

  Generate an API key in Help Scout by going to Your Profile > Authentication > Generate an API Key.

• 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 Helpscout data, such as Visibility.
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.

=CDATAQUERY("SELECT * FROM Categories WHERE Visibility = '"&B4&"'","Profile="&B1&";ProfileSettings="&B2&";Provider=API",B5)


3. Change the filter to change the data.