Connect to Pipeline CRM Data in RazorSQL

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Pipeline CRM from wizards and query Pipeline CRM data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Pipeline CRM enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Pipeline CRM using wizards in RazorSQL.

Create a JDBC Data Source for Pipeline CRM Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

      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.

      A typical JDBC URL is the following:

      jdbc:api:Profile=C:\profiles\Pipeline.apip;ProfileSettings='APIKey=your_api_key;APPKey=your_app_key';

Query Pipeline CRM Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.

Ready to get started?

Connect to live data from Pipeline CRM with the API Driver

Connect to Pipeline CRM