Integrate PDFMonkey Data in Pentaho Data Integration

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Build ETL pipelines based on PDFMonkey data in the Pentaho Data Integration tool.

The CData API Driver for JDBC enables access to live data from data pipelines. Pentaho Data Integration is an Extraction, Transformation, and Loading (ETL) engine that data, cleanses the data, and stores data using a uniform format that is accessible.This article shows how to connect to PDFMonkey data as a JDBC data source and build jobs and transformations based on PDFMonkey data in Pentaho Data Integration.

Configure to PDFMonkey Connectivity

Using API Key Authentication

PdfMonkey uses API key authentication. To obtain an API key:

  1. Log in to your PdfMonkey account at https://app.pdfmonkey.io
  2. Navigate to your account settings
  3. Open the API Key page
  4. Copy your API key

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 PdfMonkey API key.

Example Connection String

Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Connecting to PdfMonkey

Once the authentication is configured, you can connect to PdfMonkey and query data from any of the available tables such as CurrentUser, DocumentCards, Documents, DocumentTemplateCards, and DocumentTemplates.

Built-in Connection String Designer

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

Save your connection string for use in Pentaho Data Integration.

Connect to PDFMonkey from Pentaho DI

Open Pentaho Data Integration and select "Database Connection" to configure a connection to the CData API Driver for JDBC

  1. Click "General"
  2. Set Connection name (e.g. PDFMonkey Connection)
  3. Set Connection type to "Generic database"
  4. Set Access to "Native (JDBC)"
  5. Set Custom connection URL to your PDFMonkey connection string (e.g.
    jdbc:api:Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
  6. Set Custom driver class name to "cdata.jdbc.api.APIDriver"
  7. Test the connection and click "OK" to save.

Create a Data Pipeline for PDFMonkey

Once the connection to PDFMonkey is configured using the CData JDBC Driver, you are ready to create a new transformation or job.

  1. Click "File" >> "New" >> "Transformation/job"
  2. Drag a "Table input" object into the workflow panel and select your PDFMonkey connection.
  3. Click "Get SQL select statement" and use the Database Explorer to view the available tables and views.
  4. Select a table and optionally preview the data for verification.

At this point, you can continue your transformation or jb by selecting a suitable destination and adding any transformations to modify, filter, or otherwise alter the data during replication.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live PDFMonkey data in Pentaho Data Integration today.

Ready to get started?

Connect to live data from PDFMonkey with the API Driver

Connect to PDFMonkey