Integrate SFTP Data in the Pentaho Report Designer

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP JDBC Driver

An easy-to-use database-like interface for Java based applications and reporting tools access to remote files and directories.



Publish reports based on SFTP data in the Pentaho BI tool.

The CData JDBC Driver for SFTP data enables access to live data from dashboards and reports. This article shows how to connect to SFTP data as a JDBC data source and publish reports based on SFTP data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new SFTP connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:sftp: and is followed by a semicolon-separated list of 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.

      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.

      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;
    • Custom Driver Class Name: Enter cdata.jdbc.sftp.SFTPDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add SFTP Data to a Report

You are now ready to create a report with SFTP data.

  1. Add the SFTP source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the MyDirectory table.
  4. Finally, run the report to see the chart.