Integrate Nuclia Data in the Pentaho Report Designer

The CData JDBC driver for Nuclia data enables access to live data from dashboards and reports. This article shows how to connect to Nuclia data as a JDBC data source and publish reports based on Nuclia data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Nuclia connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:api: and is followed by a semicolon-separated list of 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.

     Below is a typical JDBC URL:

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

   • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   

Add Nuclia Data to a Report

You are now ready to create a report with Nuclia data.

1. Add the Nuclia source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT ,  FROM KnowledgeBox WHERE  = ''

   
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the KnowledgeBox table.
4. Finally, run the report to see the chart.