Learn more
 

Ready to get started?

Connect to live data from BambooHR with the API Driver

Connect to BambooHR

In this article

Related articles

Connect to BambooHR Data from PowerBuilder


This article demonstrates how to access BambooHR data from PowerBuilder using the BambooHR JDBC Driver.

The CData JDBC Driver for BambooHR is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for BambooHR in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for BambooHR to retrieve data.

Connect to BambooHR Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for BambooHR. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.api.APIDriver
    • URL: 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';
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using BambooHR Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve BambooHR data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.api.APIDriver',URL='jdbc:api:Profile=C:\profiles\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';"; CONNECT USING SQLCA; dw_employees.SetTransObject(SQLCA); dw_employees.Retrieve();