Access Live Highrise 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 Highrise, you get federated access to live Highrise data directly within TIBCO Data Virtualization. This article walks through deploying an adapter and creating a new data source based on Highrise.

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

Deploy the Highrise 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 Highrise
   

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

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.highrise.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

Authenticate with Highrise Using OAuth

Since Highrise authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to Highrise directly from the adapter.

The following code sample shows how to authenticate with Highrise. You will simply need to execute the Java application with the tdv.highrise.jar file in the class path.

HighriseOAuth oauth = new HighriseOAuth();  
oauth.generateOAuthSettingsFile("InitiateOAuth=GETANDREFRESH;" + 
                                  "OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;" + 
                                  "OAuthSettingsLocation=C:\highrise\OAuthSettings.txt;");

Once you deploy the adapter and authenticate, you can create a new data source for Highrise in TDV Studio.

Create a Highrise Data Source in TDV Studio

With the CData TIBCO DV Adapter for Highrise, you can easily create a data source for Highrise 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. Highrise) and click Next.
3. Name the data source (e.g. CData Highrise Source).

4. Fill in the required connection properties.

   Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

   See the "Getting Started" section in the help documentation for a guide to using OAuth.

   NOTE: Set the OAuthSettingsLocation property in the DV Adapter to the same value you used when performing the OAuth authentication (see above).

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 Highrise tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with Highrise 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.