ETL Postmark in Oracle Data Integrator

Leverage existing skills by using the JDBC standard to connect to Postmark: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Postmark connects real-time Postmark data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with Postmark just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Postmark APIs in real time instead of working with flat files.

This article covers a JDBC-based ETL -- Postmark to Oracle. After reverse engineering a data model of Postmark entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR (cdata.jdbc.api.jar) and .lic file (cdata.jdbc.api.lic), located in the installation folder, into the ODI appropriate directory:

• UNIX/Linux without Agent: ~/.odi/oracledi/userlib
• UNIX/Linux with Agent: ~/.odi/oracledi/userlib and $ODI_HOME/odi/agent/lib
• Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
• Windows with Agent: %APPDATA%\odi\oracledi\userlib and %APPDATA%\odi\agent\lib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of Postmark data. After reverse engineering, you can query real-time Postmark data and create mappings based on Postmark tables.

1. In ODI, connect to your repository and click New -> Model and Topology Objects.
2. On the Model screen of the resulting dialog, enter the following information:
   • Name: Enter API.
   • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
   • Logical Schema: Enter API.
   • Context: Select Global.
   
3. On the Data Server screen of the resulting dialog, enter the following information:
   • Name: Enter API.
   • Driver List: Select Oracle JDBC Driver.
   • Driver: Enter cdata.jdbc.api.APIDriver
   • URL: Enter the JDBC URL containing the connection string.

     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.

     

     Below is a typical connection string:

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

   
4. On the Physical Schema screen, enter the following information:
   • Name: Select from the Drop Down menu.
   • Database (Catalog): Enter CData.
   • Owner (Schema): If you select a Schema for Postmark, enter the Schema selected, otherwise enter API.
   • Database (Work Catalog): Enter CData.
   • Owner (Work Schema): If you select a Schema for Postmark, enter the Schema selected, otherwise enter API.
   
5. In the opened model click Reverse Engineer to retrieve the metadata for Postmark tables.

Edit and Save Postmark Data

After reverse engineering you can now work with Postmark data in ODI. To view Postmark data, expand the Models accordion in the Designer navigator, right-click a table, and click View data.

Create an ETL Project

Follow the steps below to create an ETL from Postmark. You will load Bounces entities into the sample data warehouse included in the ODI Getting Started VM.

1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

   Alternatively you can use SQLPlus. From a command prompt enter the following:

   sqlplus / as sysdba
   

2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the Bounces table in Postmark:

   CREATE TABLE ODI_DEMO.TRG_BOUNCES ( NUMBER(20,0), VARCHAR2(255));
   

3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
4. Click Reverse Engineer. The TRG_BOUNCES table is added to the model.
5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
6. Drag the TRG_BOUNCES table from the Sales Administration model onto the mapping.
7. Drag the Bounces table from the Postmark model onto the mapping.
8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
9. Open the Physical tab of the Mapping Editor and click BOUNCES_AP in TARGET_GROUP.
10. In the BOUNCES_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load Postmark data into Oracle.