Excel Spreadsheet Automation on AgileCRM Data with the QUERY Formula

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

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

  AgileCRM API Profile Settings

  Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.

• 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 AgileCRM data, such as IsDisabled.
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 Campaigns WHERE IsDisabled = '"&B6&"'","Profile="&B1&";ProfileSettings="&B2&";Domain="&B3&";User="&B4&";Provider=API",B7)


3. Change the filter to change the data.