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

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

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

Authenticate with Drift Using OAuth

Since Drift 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 Drift directly from the adapter.

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

APIOAuth oauth = new APIOAuth();  
oauth.generateOAuthSettingsFile("InitiateOAuth=GETANDREFRESH;" + 
                                  "Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;" + 
                                  "OAuthSettingsLocation=C:\api\OAuthSettings.txt;");

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

Create a Drift Data Source in TDV Studio

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

4. Fill in the required connection properties.

   Start by setting the Profile connection property to the location of the Drift Profile on disk (e.g. C:\profiles\Drift.apip). Next, set the ProfileSettings connection property to the connection string for Drift (see below).

   Drift API Profile Settings

   Drift uses OAuth-based authentication.

   You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

   After setting the following options in the ProfileSettings connection property, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • OAuthClientId: Set this to the Client Id that is specified in your app settings.
   • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

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

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