Connect to Testmonitor Data in Aqua Data Studio

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Access Testmonitor data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Testmonitor integrates Testmonitor data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Testmonitor 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 Testmonitor 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, Testmonitor.
    • 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.

      Start by setting the Profile connection property to the location of the Testmonitor Profile on disk (e.g. C:\profiles\Testmonitor.apip). Next, set the ProfileSettings connection property to the connection string for Testmonitor (see below).

      Testmonitor API Profile Settings

      Generate a token in TestMonitor by navigating to My Account > API > Create Token. Your Domain is extracted from your account subdomain.

      Built-in Connection String Designer

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

Query Testmonitor Data

You can now query the tables exposed.

Ready to get started?

Connect to live data from Testmonitor with the API Driver

Connect to Testmonitor