Design BIRT Reports on Webflow Data

The CData JDBC Driver for Webflow integrates connectivity to Webflow APIs into your data-driven Java applications. You can use the CData JDBC Driver for Webflow with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   Authentication

   Webflow uses OAuth 2.0 authentication to ensure secure access to sites, CMS collections, e-commerce data, and other resources. This authentication method allows you to securely connect to your Webflow workspace and manage resources with proper authorization.

   OAuth 2.0 Setup and Configuration

   Step 1: Create a Webflow OAuth Application

   To set up OAuth authentication:

   1. Visit the Webflow Developer Portal
   2. Navigate to "Apps & Integrations" in your Webflow account
   3. Click "Register an App" to create a new OAuth application
   4. Configure the application name, description, and redirect URI (CallbackURL)
   5. Copy the Client ID and Client Secret for use in your connection

   Required Connection Properties

   • AuthScheme: Set this to OAuth (required)
   • OAuthClientId: Client ID from your Webflow OAuth application (required)
   • OAuthClientSecret: Client secret from your Webflow OAuth application (required)
   • CallbackURL: Redirect URI specified in your OAuth application (required)
   • InitiateOAuth: Set to GETANDREFRESH for automatic token management (recommended)

   Required OAuth Scopes

   The Webflow API Profile requires the following OAuth scopes:

   • sites:read - Read access to site information and configuration
   • pages:read - Read access to site pages
   • cms:read - Read access to CMS collections and items
   • forms:read - Read access to forms and form submissions
   • assets:read - Read access to media assets and folders
   • ecommerce:read - Read access to products, orders, and inventory
   • authorized_user:read - Read access to the authorized user

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Webflow 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\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
   

7. Right-click the Data Sets folder and select the JDBC data source for Webflow.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query:

   SELECT , FROM Sites WHERE Id = 'your_site_id'
   

9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Webflow data. 👁 A BIRT report that can be refreshed on demand. (Salesforce is shown.)

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.