Manage Suadeo Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Suadeo seamlessly integrates Suadeo data into database management tools like DBArtisan by enabling you to access Suadeo data as a database. This article shows how to create a JDBC source for Suadeo in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Suadeo Data into DBArtisan Projects

Follow the steps below to register Suadeo data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Suadeo data. Suadeo entities are displayed in the Datasource Explorer.

You can now work with Suadeo data as you work with any other database. See the driver help documentation for more information on the queries supported by the Suadeo API.