Manage BambooHR Data in DBArtisan as a JDBC Source

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

Integrate BambooHR Data into DBArtisan Projects

Follow the steps below to register BambooHR 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. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
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 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

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

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