How do I schedule a report for SFTP delivery?
Use Secure File Transfer Protocol (SFTP) delivery to send a saved report automatically to a server your company controls. Remote uploads one file per run, using the schedule owner's data access.
You need access to Scheduled reports, permission to view data exports and the reporting library, and permission to run the report. Adding an SFTP destination also requires permission to create or update workflows.
Have your server's host, port, username, password, and destination folder path ready. The destination folder must allow file uploads and the server should accept traffic from Remote's IP addresses in order to connect.
SFTP delivery supports password authentication only. It does not support Secure Shell (SSH) key authentication, file encryption, or host key pinning to verify a specific server identity.
- In the sidebar, open Reports & Analytics, then Scheduled reports.
- Click Create schedule.
- Under Which report should run?, choose the report and enter a Schedule title.
- Under How should this report be delivered?, select SFTP export, then click Continue.
- If the setup asks for report filters, choose the legal entity and reporting period or snapshot date, then continue. The available options depend on the report.
- In the data transfer step, enter the file name.
- Select an SFTP destination. If none is available, add one using the steps below.
- Choose the File format: CSV (comma-separated values), XLSX (Excel), or XLS (Excel 1997–2003).
- Configure the schedule's frequency, time, and time zone. Use the available start and end dates or months if the schedule should run for a limited period. Review the first run shown in the setup.
- Click Save schedule automation.
The schedule appears in the list. Each run uploads one file to the destination folder.
You cannot change the delivery method after creating the schedule. To switch to email, create a new schedule.
- In the data transfer step, click New Destination.
- Enter a destination name, host, port, username, password, and folder path.
- Click Save and Test.
Remote validates the details and tests the connection. If the test succeeds, the destination is ready to use. If it fails, check the server address, network access, credentials, and destination folder against the error shown.
There is currently no screen for editing or archiving saved SFTP destinations.
Remote adds the file extension for the selected format.
Use these placeholders to include the run's date and time in the file name:
Placeholder | Value |
|---|---|
| Year |
| Month |
| Day |
| Hour |
| Minute |
For example, payroll_[yyyy]-[MM]-[dd]_[HH][mm] includes the run date and time. Remote previews the file name for the next run.
The file name can contain up to 200 characters. It cannot contain slashes, .., a leading dot, control characters, or date placeholders other than those listed above.
An existing file with the same name is overwritten. Include enough date and time detail to distinguish the runs you want to keep.
The file follows the saved report's configuration and any filters set on the schedule. Unlike email delivery, SFTP delivery does not generate separate copies for recipients. It uses the schedule owner's permissions and data access.
If the report has no rows, Remote uploads a file containing only the column headers. It does not send a no-data email.
Open the schedule's Run history to review the run and delivery status.
Remote makes up to six upload attempts over about 8.5 hours. The schedule owner receives a failure email only after the last attempt fails. If a retry succeeds, the run completes without a failure email. Invalid file names and missing passwords fail immediately.
Check whether the server is reachable, the credentials are accepted, and Remote can write to the destination folder. The server must allow connections from all of Remote's IP addresses.
If the schedule moves to the company owner after its previous owner leaves or loses access, Remote pauses SFTP delivery. The file would now use the company owner's access, which may include more data.
The company owner should review the report and destination before resuming the schedule.
