---
title: "FTP Scheduler"
canonical: "https://kb.myframeworks.com.au/space/FRAM/218857486/FTP%20Scheduler"
format: markdown
---
# Overview

The FTP Scheduler is a scheduled task that automates file transfers between Frameworks and remote SFTP sites. You can use this tool to push files to remote SFTP sites (upload) or download files from remote SFTP sites (poll). This functionality supports automated data exchange with your suppliers and customers who have SFTP infrastructure.

> ℹ️ The FTP Scheduler uses **Secure File Transfer Protocol **(SFTP) by default for all file transfers.

## Planning Your FTP Schedule

When setting up the FTP Scheduler, consider the timing and dependencies of related tasks to ensure smooth operations:

**Timing Considerations:**

- **Export Task Timing**: Schedule resource intensive tasks during off-peak hours when system usage is lowest.
- **Task Duration**: Estimate how long the task will take based on typical file sizes and data volumes.
- **Duration Variability**: Account for variations in task duration caused by data volume fluctuations and system load.
- **Dependent Tasks**: Schedule any follow-up tasks after the FTP transfer completes to ensure data currency.
- **Buffer Time**: Allow margin for unexpected delays or duration variations.

**Cycle Planning:**

Based on these considerations, determine when the complete cycle of tasks should begin to maintain consistent and coordinated data updates.

# Accessing FTP Schedule

1. Click the **Frameworks Menu** and navigate to **System Administration > Task Scheduler > Schedulable Task > FTP Schedule**.
2. The **Scheduled FTP Settings** tab will open, displaying the required options.

![image-20251104-060151.png](media://3e78cbc7-e26a-4a0a-805f-840f171bde4d)

# Configuring FTP Settings

On the **Scheduled FTP Settings** tab, enter the following connection details:

- **User Name**: Enter the username for the FTP server
- **Password**: Enter the password for the FTP server
- **Host Order Directory**: Enter the directory path on the remote SFTP site (for example, `/<directory-on-remote-site>`)
- **FTP Site**: Enter the server address for the FTP server (for example, `servername.com.au`)
- **FTP Port**: Enter the port number for the FTP server. Below are some commonly used ports, however, administrators can configure SFTP and FTP services to run on non-standard ports for various reasons, such as enhanced security or to avoid conflicts with other services
  - **SFTP **typically operates over port 22.
  - **FTP **typically operates over ports 21 or 20
- **Script Path**: Enter (updated) the script file path on the Frameworks server. The script path must end with either:
  - `fw_sftp_poll.sh` for downloading files from the remote site
  - `fw_sftp_upload.sh` for uploading files to the remote site
- **File Path**: Enter the file path on the Frameworks server where files are stored or will be saved (for example, `/frameworks/tenants/feature/...`)
- **Sent File Archive**: Enter the file path on the Frameworks server where uploaded files will be archived after successful transfer. This field only appears when the **Script Path** is set to `fw_sftp_upload.sh`

> ⚠️ **Important**: The Script Path, File Path, and Sent File Archive paths must already exist on the Frameworks server before you schedule this task.

# Scheduling the Task

Go to the **Schedule** tab to configure when the task runs, then click **Submit** to activate the task.

We strongly recommend you update the **Task Description **field to help identify why you configured the task to run.

> ✅ Refer to [Scheduled Task - Scheduling and Output](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256) for more information about scheduling options.

---

# Script Types and Locations

The FTP Scheduler uses two different scripts depending on the direction of file transfer:

## 1. Upload Script (Push Files)

The upload script pushes files from Frameworks to a remote SFTP site.

![image-20251104-223028.png](media://cd658ced-716c-4a09-b40c-414e8a61cd8d)

**Typical Script Path:**

```
/frameworks/tenants/{environment}/deploy/scripts/fw_sftp_upload.sh
```

**Additional Fields:** When using the upload script, you must specify the **Sent File Archive** path where successfully uploaded files will be moved.

## 2. Poll Script (Download Files)

The poll script downloads files from a remote SFTP site to Frameworks.

![image-20251104-222951.png](media://2b008906-b1a5-4cf0-928d-0567bf47f035)

**Typical Script Path:**

```
/frameworks/tenants/{environment}/deploy/scripts/fw_sftp_poll.sh
```

> ℹ️ **Note**: The `{environment}` placeholder in these paths may vary depending on your Frameworks environment. Common values include`/prod/`,  `/live/` or `/demo/`.

For on-premise environments, your server paths may differ from these examples. You can view your server information on the **System** tab of the [System Control File Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401568) screen.

---

# Additional Information

> ✅ Refer to [Scheduled Task - Scheduling and Output](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256), for general information about scheduling tasks in Frameworks.