Integrate Humanity Data in the Pentaho Report Designer

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Publish reports based on Humanity data in the Pentaho BI tool.

The CData JDBC driver for Humanity data enables access to live data from dashboards and reports. This article shows how to connect to Humanity data as a JDBC data source and publish reports based on Humanity 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 Humanity connection. In the resulting dialog, configure the connection properties as shown below.

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

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

      Humanity API Profile Settings

      Create an OAuth application from Settings > API V2 in your Humanity account to obtain an App ID and App Secret.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Humanity 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.

      Below is a typical JDBC URL:

      jdbc:api:Profile=C:\profiles\Humanity.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Humanity Data to a Report

You are now ready to create a report with Humanity data.

  1. Add the Humanity 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, Store FROM Budget WHERE Location = 'New York'
  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 Budget table.
  4. Finally, run the report to see the chart.

Ready to get started?

Connect to live data from Humanity with the API Driver

Connect to Humanity