Access Live BambooHR Data in TIBCO Data Virtualization

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the CData TIBCO DV Adapter for BambooHR, you get federated access to live BambooHR data directly within TIBCO Data Virtualization. This article walks through deploying an adapter and creating a new data source based on BambooHR.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live BambooHR data. When you issue complex SQL queries to BambooHR, the adapter pushes supported SQL operations, like filters and aggregations, directly to BambooHR. Its built-in dynamic metadata querying allows you to work with and analyze BambooHR data using native data types.

Deploy the BambooHR TIBCO DV Adapter

1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name API
   

2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.api.jar) to the server from the extract location.

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.api.jar
   

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Create a BambooHR Data Source in TDV Studio

With the CData TIBCO DV Adapter for BambooHR, you can easily create a data source for BambooHR and introspect the data source to add resources to TDV.

Create the Data Source

1. Right-click on the folder you wish to add the data source to and select New -> New Data Source.
2. Scroll until you find the adapter (e.g. BambooHR) and click Next.
3. Name the data source (e.g. CData BambooHR Source).

4. Fill in 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, 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.

5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected BambooHR tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with BambooHR data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.