Access Live ADP Data in TIBCO Data Virtualization

Ready to get started?

Learn more:

TIBCO DV Adapters


Use the CData TIBCO DV Adapter for ADP to create a ADP data source in TIBCO Data Virtualization Studio and gain access to live ADP data from your TDV Server.

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

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

Deploy the ADP 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 ADP
    
  2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.adp.jar) to the server from the extract location.

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

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

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

ADPOAuth oauth = new ADPOAuth();  
oauth.generateOAuthSettingsFile("InitiateOAuth=GETANDREFRESH;" + 
                                  "OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123'" + 
                                  "OAuthSettingsLocation=C:\adp\OAuthSettings.txt;");

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

Create a ADP Data Source in TDV Studio

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

    Connect to ADP by specifying the following properties:

    • SSLClientCert: Set this to the certificate provided during registration.
    • SSLClientCertPassword: Set this to the password of the certificate.
    • UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
    • RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

    The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. For more information, refer to the OAuth section in the Help documentation.

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

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