VOOZH about

URL: https://www.cdata.com/kb/tech/placid-jdbc-finereport.rst

⇱ Feed Placid Data into FineReport


Feed Placid Data into FineReport

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
How to set Placid data as a JDBC data source in FineReport.

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

Set Up a JDBC Data Source of Placid Data

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

  1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Placid 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.
  3. πŸ‘ 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.

    Placid uses API Key authentication to control access to the API. API tokens are project-specific and can be obtained from your project settings on placid.app.

    Using API Key Authentication

    To obtain your API key, log in to placid.app, navigate to your project, open the project settings, and generate an API token from the API section. Note that each API token is scoped to a specific project.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Placid project API token.

    Example connection string:

    Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
    

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Placid 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\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
     
  4. πŸ‘ FineReport data connection definition window (Salesforce is shown.)
  5. Click Connection pool attributes and set Test before getting connections to No.
  6. πŸ‘ FineReport connection pool (Salesforce is shown.)

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

Select Placid 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. πŸ‘ Adding a new DB query.
  3. Choose the JDBC connection that you created from the dropdown list.
  4. The Placid entities will appear as tables on the left pane.
  5. Write a SELECT statement for the Placid data tables and columns that you want to load.
  6. πŸ‘ FineReport database query (Salesforce is shown.)
  7. Click preview and data is shown as table.
  8. πŸ‘ FineReport database query preview (Salesforce is shown.)

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