Manage Pipeline CRM Data in DBArtisan as a JDBC Source

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

Integrate Pipeline CRM Data into DBArtisan Projects

Follow the steps below to register Pipeline CRM 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 Pipeline CRM Profile on disk (e.g. C:\profiles\Pipeline.apip). Next, set the ProfileSettings connection property to the connection string for Pipeline CRM (see below).

   Pipeline CRM API Profile Settings

   Retrieve your API Key via Account Settings > Pipeline API > Enable API Access > New API Key, and generate an APP Key at https://app.pipelinecrm.com/admin/modern/api by creating a new Integration.

   Built-in Connection String Designer

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

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

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