Feed Nuclia Data into FineReport

The CData JDBC Driver for Nuclia fully implements the JDBC standard and can provide Nuclia data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Nuclia data as JDBC data source in FineReport and view Nuclia data as a table in the Report Designer.

Set Up a JDBC Data Source of Nuclia Data

Follow the instruction below to set Nuclia data as a FineReport database connection.

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Nuclia installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.api.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.api.APIDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Nuclia JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

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


4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Nuclia set up, you can use it as FineReport data source.

Select Nuclia Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.

2. Choose the JDBC connection that you created from the dropdown list.
3. The Nuclia entities will appear as tables on the left pane.
4. Write a SELECT statement for the Nuclia data tables and columns that you want to load.

5. Click preview and data is shown as table.

With these simple steps, Nuclia can be used as a JDBC data source in FineReport.