Excel Spreadsheet Automation on Nuclia Data with the QUERY Formula

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

  Using API Key Authentication

  Nuclia uses API key authentication for accessing Knowledge Box data. To obtain an API key:

  1. Log in to the Nuclia Cloud Dashboard at https://nuclia.cloud
  2. Navigate to your Knowledge Box settings
  3. Go to the Service Accounts section
  4. Create a new service account or copy an existing API key

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Nuclia service account API key.
  • KbId: Set this to your Knowledge Box UUID.
  • Zone: Set this to your Nuclia deployment zone (e.g., aws-us-east-2-1).

  Example Connection String

  Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
  

  Connecting to Nuclia

  Once the authentication is configured, you can connect to Nuclia and query data from any of the available tables such as Resources, KnowledgeBox, LabelSets, and ProcessingStatus.

• 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 Nuclia 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 KnowledgeBox WHERE  = '"&B6&"'","Profile="&B1&";AuthScheme="&B2&";APIKey="&B3&";KbId="&B4&";Zone="&B5&";Provider=API",B7)


3. Change the filter to change the data.