Excel Spreadsheet Automation on Workable Data with the QUERY Formula

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

  Using API Key Authentication

  Workable uses API key authentication to control access to the API. To obtain an API Key:

  1. Log in to your Workable account.
  2. Navigate to Settings > Integrations > API Access Tokens.
  3. Click "Generate API Token".
  4. Copy the generated token.

  After obtaining your API Key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your Workable API Key.
  • Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

  Example Connection String

  Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
  

• 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 Workable 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.

=CDATAQUERY("SELECT * FROM Accounts WHERE = '"&B6&"'","Profile="&B1&";ProfileSettings="&B2&";APIKey="&B3&";Subdomain="&B4&";Provider=API",B7)

👁 Formula inputs used in this example. (Google Apps is shown.)

3. Change the filter to change the data. 👁 The outputs of the formula. (Google Apps is shown.)