Skip to main content

Set up and manage SFTP tasks

Updated

SFTP tasks let you automatically export reports to an external server. This is useful for periodically supplying data to external systems. This article explains how to set up SFTP tasks.

Requirements

  • You need the rapportage_rapportagetool right.
  • You need the SFTP connection details for the target server.

Create an SFTP task

  1. Go to Reports > Reports > Custom reports.

  2. Open the query that you want to export automatically.

  3. Click Set up SFTP task or go to the Automation tab.

  4. Enter the following information:

    Field name Description Required
    Server name The address of the SFTP server. Yes
    Port The port number (22 by default). Yes
    Username The username for the SFTP connection. Yes
    Password/Key The password or SSH key for authentication. Yes
    Target folder The folder on the server where the file is placed. Yes
    File name The name of the export file. Yes
    Schedule The export frequency (daily, weekly or monthly). Yes

  5. Click Save.

Test an SFTP task

  1. Open the SFTP task.
  2. Click Run now to start the task manually.
  3. Check that the file has been placed on the SFTP server correctly.

Note: Store SFTP passwords and SSH keys securely and do not share them with unauthorised people.

Frequently asked questions

How often can I run an SFTP task?

You can set the frequency to daily, weekly or monthly, depending on your needs.

What happens if the SFTP connection fails?

If the connection fails, an error is logged. You receive a notification if this has been configured.

Can I create multiple SFTP tasks?

Yes, you can create multiple SFTP tasks for different queries and target servers.