Connect to Suadeo Data in Aqua Data Studio

The CData JDBC Driver for Suadeo integrates Suadeo data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Suadeo 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 Suadeo 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, Suadeo.
   • Driver Location: Click the Browse button and select the cdata.jdbc.suadeo.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.suadeo.SuadeoDriver.

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

     The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

     Set the following connection properties:

     • URL: The base URL of your Suadeo instance.
     • User: Your Suadeo username.
     • Password: Your Suadeo password.
     • AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

     When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Suadeo JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.suadeo.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 below:

     jdbc:suadeo:URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Suadeo Data

You can now query the tables exposed.