Manage Aha! Data in DBArtisan as a JDBC Source

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

Integrate Aha! Data into DBArtisan Projects

Follow the steps below to register Aha! 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.

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

   Aha! API Profile Settings

   The Aha! API uses OAuth-based authentication.

   You will first need to register an OAuth app with Aha!. This can be done from your Aha! account under 'Settings' > 'Personal' > 'Developer' > 'OAuth Applications'. Additionally, set the Domain, found in the domain name of your Aha account. For example if your Aha account is acmeinc.aha.io, then the Domain should be 'acmeinc'.

   After setting the following in the connection string, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the client_id that is specified in you app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.
   • Domain: Set this in the ProfileSettings to your Aha domain.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Aha! 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.

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

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

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