Publish Reports with SFTP Data in Crystal Reports

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP ODBC Driver

The SFTP ODBC Driver is a powerful tool that allows you to connect with live data from remote files and directories, directly from any applications that support ODBC connectivity.

Access remote data like you would a database through a standard ODBC Driver interface.



Use the Report Wizard to design a report based on up-to-date SFTP data.

Crystal Reports has many options for offloading data processing to remote data; this enables real-time reporting. The CData ODBC Driver for SFTP brings this capability to Crystal Reports. This article shows how to create a report on SFTP data that refreshes when you run the report.

Connect to SFTP Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, 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.

You can then follow the procedure below to use the Report Wizard to create the SFTP connection.

  1. In a new report, click Create New Connection -> ODBC.

  2. In the resulting wizard, click Select Data Source and select the DSN in the Data Source Name menu.

Design a Report

After adding a ODBC connection to SFTP, you can then use the Report Wizard to add SFTP data to your report.

  1. Click File -> New -> Standard Report.
  2. Expand the ODBC node under Create New Connection and double-click Make a New Connection.
  3. Configure the data source by selecting the tables and fields needed in the report. This example uses the Filesize and Filename columns from the MyDirectory table.

You can then configure grouping, sorting, and summaries. For example, this article groups on Filesize and summarizes on Filename. See the following section to use the aggregate and summary to create a chart.

Create a Chart

After selecting a column to group by, the Standard Report Creation Wizard presents the option to create a chart. Follow the steps below to create a chart that aggregates the values in the Filesize column.

  1. In the Standard Report Creation Wizard, select the Bar Chart option and select the column you grouped by, Filesize in this example, in the On Change Of menu.
  2. In the Show Summary menu, select the summary you created.
  3. Select filters and a template, as needed, to finish the wizard.

Preview the finished report to view the chart, populated with your data. If you want to filter out null values, use a SelectionFormula.

Working with Remote Data

To ensure that you see updates to volatile data, click File and clear the "Save Data with Report" option. As you interact with the report, for example, drilling down to hidden details, Crystal Reports executes SQL queries to retrieve the data needed to display the report. To reload data you have already retrieved, refresh or rerun the report.

You can offload processing onto the driver by hiding details elements and enabling server-side grouping. To do this, you will need to have selected a column to group on in the report creation wizard.

  1. Click File -> Report Options and select the Perform Grouping On Server option.
  2. Click Report -> Section Expert and select the Details section of your report. Select the Hide (Drill-Down OK) option.

When you preview your report with the hidden details, Crystal Reports executes a GROUP BY query. When you double-click a column in the chart to drill down to details, Crystal Reports executes a SELECT WHERE query that decreases load times by retrieving only the data needed.