VOOZH about

URL: https://www.cdata.com/kb/tech/sendpulse-jdbc-dbartisan.rst

⇱ Manage SendPulse Data in DBArtisan as a JDBC Source


Manage SendPulse Data in DBArtisan as a JDBC Source

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to create a JDBC data source for SendPulse.

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

Integrate SendPulse Data into DBArtisan Projects

Follow the steps below to register SendPulse 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. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
  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 SendPulse Profile on disk (e.g. C:\profiles\SendPulse.apip). Next, set the ProfileSettings connection property to the connection string for SendPulse (see below).

    SendPulse API Profile Settings

    Log into your SendPulse account, navigate to Profile > Account Settings > API, and retrieve your API ID and Secret to use as your OAuth Client ID and Secret.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SendPulse 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.

    👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\SendPulse.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  6. Finish the wizard to connect to SendPulse data. SendPulse entities are displayed in the Datasource Explorer.

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

👁 The results of a query. (Salesforce is shown.)