Connect to BugHerd Data in DBArtisan
The CData ODBC 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 an data source for BugHerd in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate BugHerd Data into DBArtisan Projects
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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:
- Sign in to your BugHerd account at https://www.bugherd.com
- Navigate to Settings > General Settings
- 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.
You can then follow the steps below to register BugHerd data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- 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.
