Manage EmailOctopus Data in DBArtisan as a JDBC Source

The CData JDBC Driver for EmailOctopus seamlessly integrates EmailOctopus data into database management tools like DBArtisan by enabling you to access EmailOctopus data as a database. This article shows how to create a JDBC source for EmailOctopus in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate EmailOctopus Data into DBArtisan Projects

Follow the steps below to register EmailOctopus data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Start by setting the Profile connection property to the location of the EmailOctopus Profile on disk (e.g. C:\profiles\EmailOctopus.apip). Next, set the ProfileSettings connection property to the connection string for EmailOctopus (see below).

   EmailOctopus API Profile Settings

   Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

   Built-in Connection String Designer

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

6. Finish the wizard to connect to EmailOctopus data. EmailOctopus entities are displayed in the Datasource Explorer.

You can now work with EmailOctopus data as you work with any other database. See the driver help documentation for more information on the queries supported by the EmailOctopus API.