Excel Spreadsheet Automation on Mocean Data with the QUERY Formula

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

  Using API Key Authentication

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

  1. Log in to your Mocean account at https://dashboard.moceanapi.com
  2. Navigate to your account settings or API credentials section
  3. Copy your API Key

  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 Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

  Example Connection String

  Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
  

  Connecting to Mocean

  Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

• 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 Mocean 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 AccountBalance WHERE  = '"&B5&"'","Profile="&B1&";AuthScheme="&B2&";ProfileSettings="&B3&";Provider=API",B6)


3. Change the filter to change the data.