Connect to Pipeliner CRM Data in RazorSQL

The CData JDBC Driver for Pipeliner 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 Pipeliner CRM using wizards in RazorSQL.

Create a JDBC Data Source for Pipeliner 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 Pipeliner CRM Profile on disk (e.g. C:\profiles\Pipeliner.apip). Next, set the ProfileSettings connection property to the connection string for Pipeliner CRM (see below).

     Pipeliner CRM API Profile Settings

     Navigate to Administration > Obtain API Key within your Pipeliner CRM workspace to retrieve the API Token, API Password, Space ID, and Service URL.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Pipeliner 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\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';

Query Pipeliner 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.