Feed Scrapfly Data into FineReport

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

Set Up a JDBC Data Source of Scrapfly Data

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

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

   The Scrapfly API uses API Key authentication. The API key is passed as the key query parameter on every request.

   Using API Key Authentication

   Your Scrapfly API key is required to create a connection. To obtain your API key:

   1. Log into your Scrapfly account at scrapfly.io.
   2. Navigate to Dashboard and select API Keys.
   3. Copy your API key (begins with scp-live- for production or scp-test- for the test environment).

   After obtaining your API key, set the following connection properties:

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

   Example connection string:

   Profile=C:\profiles\Scrapfly.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 Scrapfly 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\Scrapfly.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 Scrapfly set up, you can use it as FineReport data source.

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

5. Click preview and data is shown as table.

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