Integrate PhantomBuster Data in the Pentaho Report Designer

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

     To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Phantombuster API key from the account settings page.

     Multi-Organization Accounts

     If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

     Example connection string:

     Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"
     

     Built-in Connection String Designer

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

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

Add PhantomBuster Data to a Report

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

1. Add the PhantomBuster 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 Agents 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 Agents table.
4. Finally, run the report to see the chart.