Integrate PayPal Data in the Pentaho Report Designer

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

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

     The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

     • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
     • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

     See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

     To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

     For testing purposes you can set UseSandbox to true and use sandbox credentials.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.paypal.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:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
   • Custom Driver Class Name: Enter cdata.jdbc.paypal.PayPalDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add PayPal Data to a Report

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

1. Add the PayPal 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 Date, GrossAmount FROM Transactions
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 Transactions table.
4. Finally, run the report to see the chart.