Connect to JobNimbus Data in Aqua Data Studio

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

     Using API Key Authentication

     JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

     1. Log in to your JobNimbus account.
     2. Navigate to Settings > Integrations > API.
     3. Generate or copy your existing API key from this page.

     After obtaining your API key, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     Set the following in the ProfileSettings connection property:
     • APIKey: Set this to your JobNimbus API key.

     Example Connection String

     Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
     

     Built-in Connection String Designer

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

   

Query JobNimbus Data

You can now query the tables exposed.