VOOZH about

URL: https://www.cdata.com/kb/tech/procore-jdbc-rsql.rst

⇱ Connect to Procore Data in RazorSQL


Connect to Procore Data in RazorSQL

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

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

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

      Procore API Profile Settings

      To authenticate to Procore, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

      First, register an OAuth application with Procore. You can do so by logging to your Developer Account and going to Create New App. Follow all necessary steps to register your app. First create a new version of Sandbox Manifest and then promote it to Production in order to get your Production Crendentials. Your Oauth application will be assigned a client id and a client secret.

      After setting the following connection properties, you are ready to connect:

      • AuthScheme: Set this to OAuth.
      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
      • OAuthClientId: Set this to the client_id that is specified in you app settings.
      • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
      • CallbackURL: Set this to the Redirect URI that is specified in your app settings

      Built-in Connection String Designer

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

      👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

      A typical JDBC URL is the following:

      jdbc:api:Profile=C:\profiles\Procore.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. Connection properties are defined in the JDBC URL. (QuickBooks is shown.)

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

👁 The resuls of a query in RazorSQL. (QuickBooks is shown.)