Feed Keap Data into FineReport

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

Set Up a JDBC Data Source of Keap Data

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

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Keap 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.
👁 FineReport Server Tab (Salesforce is shown.)

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.

   Start by setting the Profile connection property to the location of the Keap Profile on disk (e.g. C:\profiles\Keap.apip). Next, set the ProfileSettings connection property to the connection string for Keap (see below).

   Keap API Profile Settings

   Log into your Keap web app, click the user bubble in the bottom left, choose Settings > API, then generate a new Personal Access Token or Service Account Key.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Keap 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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   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\Keap.apip;ProfileSettings='APIKey=your_api_key';
    

👁 FineReport data connection definition window (Salesforce is shown.)

4. Click Connection pool attributes and set Test before getting connections to No.
👁 FineReport connection pool (Salesforce is shown.)

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

Select Keap Data in the Report Designer.

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

2. Choose the JDBC connection that you created from the dropdown list.
3. The Keap entities will appear as tables on the left pane.
4. Write a SELECT statement for the Keap data tables and columns that you want to load.
👁 FineReport database query (Salesforce is shown.)

5. Click preview and data is shown as table.
👁 FineReport database query preview (Salesforce is shown.)

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