Excel Spreadsheet Automation on Teamwork Data with the QUERY Formula
The CData Excel Add-In for Teamwork provides formulas that can query Teamwork data. The following three steps show how you can automate the following task: Search Teamwork 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 Teamwork 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 Teamwork data, separated by semicolons.
Start by setting the Profile connection property to the location of the Teamwork Profile on disk (e.g. C:\profiles\Teamwork.apip). Next, set the ProfileSettings connection property to the connection string for Teamwork (see below).
Teamwork API Profile Settings
Register an OAuth application on the Teamwork Developer Portal to obtain your Client ID and Secret. Set the Domain property to your Teamwork site's subdomain.
- 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 Teamwork data, such as ChatEnabled.
- 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 Account WHERE ChatEnabled = '"&B6&"'","Profile="&B1&";Authscheme="&B2&";OAuthClientId="&B3&";OAuthClientSecret="&B4&";CallbackUrl="&B5&";Provider=API",B7)
