Connect to BambooHR Data in CloverDX (formerly CloverETL)

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

Connect to BambooHR as a JDBC Data Source

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

   BambooHR API Profile Settings

   In order to authenticate to BambooHR, you'll need to provide your API Key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient permissions, there will be an "API Keys" option in that menu to go to the page, where you can create a new API Key. Additionally, you will need to set the Domain, found in the domain name of your BambooHR account. For example if your BambooHR account is acmeinc.bamboohr.com, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the BambooHR 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\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';

Query BambooHR 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 BambooHR JDBC data source from the drop-down menu.
3. Enter the SQL query. For example: SELECT Id, DisplayName FROM Employees WHERE Department = 'Sales'

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 Employees table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.