Excel Spreadsheet Automation on JobNimbus Data with the QUERY Formula
The CData Excel Add-In for JobNimbus provides formulas that can query JobNimbus data. The following three steps show how you can automate the following task: Search JobNimbus 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 JobNimbus 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 JobNimbus data, separated by semicolons.
Using API Key Authentication
JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:
- Log in to your JobNimbus account.
- Navigate to Settings > Integrations > API.
- Generate or copy your existing API key from this page.
After obtaining your API key, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your JobNimbus API key.
Example Connection String
Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_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.
- 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 JobNimbus data, such as .
- 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 AccountUsers WHERE = '"&B5&"'","Profile="&B1&";AuthScheme="&B2&";ProfileSettings="&B3&";Provider=API",B6)