Connect to SFTP Data in Jaspersoft Studio

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.



Execute SQL to remote SFTP data in Jaspersoft Studio.

This article shows how to connect to SFTP from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for SFTP. You will use the standard Jaspersoft wizards to build SQL queries to SFTP. The queries are executed directly to the SFTP APIs, enabling real-time connectivity to SFTP data.

Connect to SFTP Data as a JDBC Data Source

To create a JDBC data source in Jaspersoft Studio, create a data adapter:

  1. In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
  2. Select Database JDBC Connection.
  3. Enter a user-friendly name for the driver.
  4. On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
  5. On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.sftp.SFTPDriver.
  6. Enter the JDBC URL.

    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 for SFTP:

    jdbc:sftp:RemoteHost=MyFTPServer;

Create Reports with SFTP Data

Follow the steps below to build an SQL query to SFTP, the basis of a simple report:

  1. Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
  2. In the Data Adapter menu, select the data adapter you created in the previous section.
  3. In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example: SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt
  4. Select the fields you want to include in the dataset. This example uses all fields.
  5. Skip the Group By step and finish the wizard.

In the Preview tab, you can see the report as it would look with the current SFTP data.

Create a Chart

The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.

Create a DataSet

Follow the steps below to create a new dataset to populate the chart:

  1. In the report editing area, click the Design tab.
  2. In the Outline view, right-click the root node for the report and click Create Dataset.
  3. Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
  4. In the Data Adapter menu, select the data adapter you created in the first section.
  5. Enter a query such as the following:

    SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt
  6. Select the fields you want in the dataset. This example uses Filesize and Filename.
  7. Skip the step to group by fields and finish the wizard.

Configure the Chart

After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:

  1. Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
  2. Drag a chart from the Palette onto the summary. The chart wizard is displayed.
  3. Select the chart type. This example uses a bar chart.
  4. In the Dataset menu, select the dataset you created for the chart.
  5. In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
  6. Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the Filesize column to set the expression to $F{Filesize}.
  7. Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click Filename to set the expression to $F{Filename}.

  8. Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the Filesize column to set the expression to $F{Filesize}. If needed, convert the column type to string, as in the following expression: $F{Filesize}.toString()
  9. Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.

Running the Report

You can now generate reports on SFTP data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.