Integrate Postmark Data in Pentaho Data Integration

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 Postmark data as a JDBC data source and build jobs and transformations based on Postmark data in Pentaho Data Integration.

Configure to Postmark Connectivity

Using API Key Authentication

Postmark uses server API tokens to authenticate requests. Each Postmark server has its own API token, which controls access to messages, bounces, templates, and statistics associated with that server.

To obtain your Server API Token, log in to your Postmark account and navigate to the server you want to connect to. Go to API Tokens under the server settings and copy the token labeled Server API token.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Postmark Server API Token. This value is sent as the X-Postmark-Server-Token header on every request.

Example connection string:

Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

Connecting to Postmark

Once the authentication is configured, you can connect to Postmark and query data from any of the available tables such as OutboundMessages, Bounces, and Templates.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Postmark 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\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

Save your connection string for use in Pentaho Data Integration.

Connect to Postmark 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. Postmark Connection)
3. Set Connection type to "Generic database"
4. Set Access to "Native (JDBC)"
5. Set Custom connection URL to your Postmark connection string (e.g.
   

   jdbc:api:Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

6. Set Custom driver class name to "cdata.jdbc.api.APIDriver" 👁 Configuring the JDBC Driver connection.
   
7. Test the connection and click "OK" to save. 👁 Saving the connection.
   

Create a Data Pipeline for Postmark

Once the connection to Postmark 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 Postmark connection. 👁 Configuring the Table input object
   
3. Click "Get SQL select statement" and use the Database Explorer to view the available tables and views. 👁 Selecting data (QuickBooks Online is shown).
   
4. Select a table and optionally preview the data for verification. 👁 Previewing the data (QuickBooks Online is shown).
   

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 Postmark data in Pentaho Data Integration today.