Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift

Feed Drift Data into FineReport



How to set Drift data as a JDBC data source in FineReport.

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

Set Up a JDBC Data Source of Drift Data

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

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

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

    Drift API Profile Settings

    Drift uses OAuth-based authentication.

    You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

    After setting the following options in the ProfileSettings connection property, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to the Client Id that is specified in your app settings.
    • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Drift 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\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  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 Drift set up, you can use it as FineReport data source.

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

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