Integrate JobNimbus Data in the Pentaho Report Designer

The CData JDBC driver for JobNimbus data enables access to live data from dashboards and reports. This article shows how to connect to JobNimbus data as a JDBC data source and publish reports based on JobNimbus 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 JobNimbus 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.

     Using API Key Authentication

     JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

     1. Log in to your JobNimbus account.
     2. Navigate to Settings > Integrations > API.
     3. Generate or copy your existing API key from this page.

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

     • AuthScheme: Set this to APIKey.
     Set the following in the ProfileSettings connection property:
     • APIKey: Set this to your JobNimbus API key.

     Example Connection String

     Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
     

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the JobNimbus 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\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';

   • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   

Add JobNimbus Data to a Report

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

1. Add the JobNimbus 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 ,  FROM AccountUsers WHERE  = ''

   
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 AccountUsers table.
4. Finally, run the report to see the chart.