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

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

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

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

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.sftp.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 SFTP Data Source in TDV Studio

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

4. Fill in the required connection properties.

   SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

   Set the following connection properties to control the relational view of the file system:

   • RemotePath: Set this to the current working directory.
   • TableDepth: Set this to control the depth of subfolders to report as views.
   • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
   Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

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

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