Manage BugHerd Data in DBArtisan as a JDBC Source

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

Integrate BugHerd Data into DBArtisan Projects

Follow the steps below to register BugHerd 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.
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 BugHerd Profile on disk (e.g. C:\profiles\BugHerd.apip). Next, set the ProfileSettings connection property to the connection string for BugHerd (see below).

   BugHerd API Profile Settings

   BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

   1. Sign in to your BugHerd account at https://www.bugherd.com
   2. Navigate to Settings > General Settings
   3. Locate the API Key section and copy the generated key

   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 BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

   Built-in Connection String Designer

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

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\BugHerd.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

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