Create an SAP BusinessObjects Universe on the CData JDBC Driver for Postmark

This article shows how to use the CData JDBC Driver for Postmark to connect to Postmark from SAP BusinessObjects Business Intelligence applications. You will use the Information Design Tool to analyze Postmark data and create a universe on the CData JDBC Driver for Postmark. You will then connect to the universe from Web Intelligence.

Create the JDBC Connection to Postmark

Follow the steps below to create a connection to the Postmark JDBC data source in the Information Design Tool.

1. Copy the CData JAR and .lic file into the following subfolder in the installation directory for BusinessObjects: dataAccess\connectionServer\jdbc\drivers\jdbc. The CData JAR is located in the lib subfolder of the installation directory.
2. Right-click your project and click New -> New Relational Connection.
3. In the wizard that results, click Generic -> Generic JDBC datasource -> JDBC Drivers.
4. On the next page of the wizard enter the connection details.

5. On the next page, set the Authentication Mode option to "Use specified username and password". Enter the username, password, and JDBC URL. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

   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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   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.

   A typical JDBC URL is below:

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

6. Enter the driver class: cdata.jdbc.api.APIDriver
7. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze Postmark Data in the Information Design Tool

You can use the JDBC connection to analyze Postmark data in the Information Design Tool.

1. In the Local Projects view, double-click the connection (the .cnx file) to open the Postmark data source.
2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.
3. On the Analysis tab, you can then analyze data by dragging and dropping columns onto the axes of a chart.

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.
2. Enter the host and port of the repository and connection credentials.
3. Select the folder where the connection will be published.
4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the JDBC Driver for Postmark

You can follow the steps below to create a universe on the JDBC driver. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

1. In the Information Design Tool, click File->New Universe.
2. Select your project.
3. Select the option to create the universe on a relational data source.
4. Select the shortcut to the published connection.
5. Enter a name for the Data Foundation.
6. Import tables and columns that you want to access as objects.
7. Enter a name for the Business Layer.

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.
2. In the Publish Universe dialog, enter any integrity checks before importing.
3. Select or create a folder on the repository where the universe will be published.

Query Postmark Data in Web Intelligence

You can use the published universe to connect to Postmark in Web Intelligence.

1. Copy the cdata.jdbc.api.lic file to the following subfolder in the BusinessObjects installation directory: \dataAccess\connectionServer\jdbc\drivers\jdbc. The license file is located in the lib subfolder of the installation directory.
2. Open Web Intelligence from the BusinessObjects launchpad and create a new document.
3. Select the Universe option for the data source.
4. Select the Postmark universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.