Feed Superchat Data into FineReport

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

Set Up a JDBC Data Source of Superchat Data

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

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Superchat 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.

   Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

   Authentication

   To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

   Using API Key Authentication

   You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Superchat API key.

   Example connection string:

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

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Superchat 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\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
     


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 Superchat set up, you can use it as FineReport data source.

Select Superchat 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 Superchat entities will appear as tables on the left pane.
4. Write a SELECT statement for the Superchat data tables and columns that you want to load.

5. Click preview and data is shown as table.

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