How to Connect DBeaver to BambooHR via a JDBC Driver

The CData API Driver for JDBC implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to BambooHR data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for BambooHR Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData API Driver for JDBC).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.api.APIDriver.
   • Set URL Template to jdbc:api:.
   👁 Configure the new driver settings (Salesforce is shown).
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.API.jar). 👁 Loading the JDBC JAR file (Salesforce is shown).
   

Create a Connection to BambooHR Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData API Driver for JDBC) and click "Next >." 👁 Selecting the driver (Salesforce is shown).
   
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   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, 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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';
   

   👁 Configuring the JDBC URL (Salesforce is shown).
   
4. Click "Test Connection ..." to ensure you have configured the connection properly. 👁 A successfully configured connection (Salesforce is shown).
   
5. Click "Finish."

Query BambooHR Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

👁 The results of a query in DBeaver. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live BambooHR data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.