Connect to Productboard Data in Aqua Data Studio

The CData JDBC Driver for Productboard integrates Productboard data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Productboard data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Productboard data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Productboard.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     Authentication

     To authenticate to ProductBoard, and connect to your own data or to allow other users to connect to their data, you can use API Key authentication.

     Using API Key Authentication

     To authenticate using an API Key, you need to obtain your API Key from your ProductBoard workspace settings.

     You can then connect by setting the AuthScheme to APIKey and providing your API key:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your API key from ProductBoard.

     Built-in Connection String Designer

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

     jdbc:api:Profile=C:\profiles\Productboard.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

   

Query Productboard Data

You can now query the tables exposed.