Ready to get started?

Learn more about the CData JDBC Driver for EDGAR Online or download a free trial:

Download Now

Integrate EDGAR Online Data in the Pentaho Report Designer

Publish reports based on EDGAR Online data in the Pentaho BI tool.

The CData JDBC Driver for EDGAR Online data enables access to live data from dashboards and reports. This article shows how to connect to EDGAR Online data as a JDBC data source and publish reports based on EDGAR Online data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new EDGAR Online connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:edgaronline: and is followed by a semicolon-separated list of connection properties.

      1. Navigate to https://developer.edgar-online.com/ and create an account.
      2. Register a new application and retrieve the AppKey. You should select one of the available Web APIs this application will use like HackPack, Insider Trades or Institutional Ownership.
        Note: HackPack is the most important Web API that an application can use since it supports a large number of endpoints. If you are getting the "Access Denied" error you must create a new app and select the correct Web API which supports the resource you are querying.
      3. After successfully creating a new app, you can access your keys through your "my account" area. Set the AppKey connection property value equal to the Key of your application.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the EDGAR Online JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.edgaronline.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.

      Below is a typical JDBC URL:

      jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d
    • Custom Driver Class Name: Enter cdata.jdbc.edgaronline.EdgarOnlineDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add EDGAR Online Data to a Report

You are now ready to create a report with EDGAR Online data.

  1. Add the EDGAR Online source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Subscriptions table.
  4. Finally, run the report to see the chart.