Connect to BugHerd Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for BugHerd enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with BugHerd as sources. In this article, you will use the JDBC Driver for BugHerd to set up a simple transfer into a flat file. The CData JDBC Driver for BugHerd enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with BugHerd as sources. In this article, you will use the JDBC Driver for BugHerd to set up a simple transfer into a flat file.

Connect to BugHerd as a JDBC Data Source

1. Create the connection to BugHerd data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
3. Enter 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.

   

   A typical JDBC URL is below:

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

Query BugHerd Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the BugHerd JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT Id, Title FROM Tasks WHERE ProjectId = '519666'

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Tasks table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.