Integrate SFTP Data in Pentaho Data Integration

The CData JDBC Driver for SFTP enables access to live data from data pipelines. Pentaho Data Integration is an Extraction, Transformation, and Loading (ETL) engine that data, cleanses the data, and stores data using a uniform format that is accessible.This article shows how to connect to SFTP data as a JDBC data source and build jobs and transformations based on SFTP data in Pentaho Data Integration.

Configure to SFTP Connectivity

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SFTP JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.sftp.jar

Fill in the connection properties and copy the connection string to the clipboard.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Below is a typical JDBC URL:

jdbc:sftp:RemoteHost=MyFTPServer;

Save your connection string for use in Pentaho Data Integration.

Connect to SFTP from Pentaho DI

Open Pentaho Data Integration and select "Database Connection" to configure a connection to the CData JDBC Driver for SFTP

1. Click "General"
2. Set Connection name (e.g. SFTP Connection)
3. Set Connection type to "Generic database"
4. Set Access to "Native (JDBC)"
5. Set Custom connection URL to your SFTP connection string (e.g.
   

   jdbc:sftp:RemoteHost=MyFTPServer;

6. Set Custom driver class name to "cdata.jdbc.sftp.SFTPDriver" 👁 Configuring the JDBC Driver connection.
   
7. Test the connection and click "OK" to save. 👁 Saving the connection.
   

Create a Data Pipeline for SFTP

Once the connection to SFTP is configured using the CData JDBC Driver, you are ready to create a new transformation or job.

1. Click "File" >> "New" >> "Transformation/job"
2. Drag a "Table input" object into the workflow panel and select your SFTP connection. 👁 Configuring the Table input object
   
3. Click "Get SQL select statement" and use the Database Explorer to view the available tables and views. 👁 Selecting data (QuickBooks Online is shown).
   
4. Select a table and optionally preview the data for verification. 👁 Previewing the data (QuickBooks Online is shown).
   

At this point, you can continue your transformation or jb by selecting a suitable destination and adding any transformations to modify, filter, or otherwise alter the data during replication.

👁 A completed transformation/job.

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for SFTP and start working with your live SFTP data in Pentaho Data Integration today.