Connect to Postmark Data in CloverDX (formerly CloverETL)

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Transfer Postmark data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Postmark enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Postmark as sources. In this article, you will use the JDBC Driver for Postmark to set up a simple transfer into a flat file. The CData JDBC Driver for Postmark enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Postmark as sources. In this article, you will use the JDBC Driver for Postmark to set up a simple transfer into a flat file.

Connect to Postmark as a JDBC Data Source

  1. Create the connection to Postmark data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

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

Query Postmark Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Postmark JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example:
    SELECT ,  FROM Bounces WHERE  = ''

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Bounces table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.

Ready to get started?

Connect to live data from Postmark with the API Driver

Connect to Postmark