Client Documentation
3.7. Transfer scheduling¶
The SFTPPlus Client transfers can be scheduled according to two rules:
- starttime and transferwindowdelay
- transferwindow and transferwindowdelay
The SFTPPlus Client uses an internal clock having a configurable clock resolution. The internal clock resolution is configured by default to the value of 1 second.
The client clock resolution is the smallest time unit that can be configured inside transfer definition files and all time parameters must be configures using values which are multiple of the clock resolution.
3.7.1. starttime and transferwindowdelay¶
In this case the SFTPPlus Client will start the transfer at a specific hour of the day or after a certain hours and minutes specified by starttime, and will repeat the transfer after a number of seconds defined by the transferwindowdelay.
3.7.2. transferwindow and transferwindowdelay¶
If transferwindow is used the SFTPPlus client will activate the transfer within the time interval specified by transferwindow and will repeat the transfer based on a frequency in second defined by the transferwindowdelay.
3.7.3. Transfer scheduling options¶
3.7.3.1. starttime¶
| Optional: | Yes |
|---|---|
| Default value: | ‘+00:00’ |
| Values: |
|
| From version: | 1.5.1 |
| To version: | None |
| Description: | Time to start transfer. If start time is not specified, the transfer will be scheduled to start after the SFTPPlus client is launched. |
3.7.3.2. transferwindowdelay¶
| Optional: | Yes |
|---|---|
| Default value: |
|
| Values: |
|
| From version: | 1.5.1 |
| To version: | None |
| Description: | Number of seconds to wait between local or remote scans for new files to be transferred. |
3.7.3.3. stabledelay¶
| Optional: | Yes |
|---|---|
| Default value: | 4 |
| Values: |
|
| From version: | 1.5.52 |
| Description: | Number of seconds to wait between the time when a file is initially detected and the actual transfer is started. If file changed in this interval the file is ignored and the transfer is re-tried after transferwindowdelay. For GET transfers or for PUT transfers in which putbatch is enabled, if any file from the recursive folder is changed, the transfer is delayed. |
3.7.3.4. maxtry¶
| Optional: | Yes |
|---|---|
| Default value: | ‘3’ |
| Values: |
|
| From version: | 1.5.1 |
| To version: | None |
| Description: | Number of times a transfer will be attempted before failing. |
3.7.3.5. waittime¶
| Optional: | Yes |
|---|---|
| Default value: | ‘120’ |
| Values: |
|
| From version: | 1.5.1 |
| To version: | None |
| Description: | Seconds to wait between failed transfer retries. |
3.7.3.6. transferwindow¶
| Optional: | Yes |
|---|---|
| Default value: | None |
| Values: |
|
| From version: | 1.5.1 |
| To version: | None |
| Description: | Format: action, starttime, stoptime. Examples:
If transferwindow is specified, starttime will be ignored. Please note that starttime should be smaller than stoptime. A transfer configured as ‘allow, 22:00, 06:00’ will not work. To get a similar configuration please use `block, 06:00, 22:00 |
3.7.3.7. transferwindowcount¶
| Optional: | Yes |
|---|---|
| Default value: | 0 |
| Values: |
|
| From version: | 1.5.2 |
| To version: | None |
| Description: | Maximum number of successful transfers within a transfer window. Active, only if transferwindow was defined. If set to ‘0’ (zero), it is effectively disabled and the client will trigger as many transfers as can be fittted inside the window using the transferwindowdelay specified. |