Note: First see Working with File Sets for a discussion on how data flows through step to step.
The Retrieval step verifies that files from the current file set have been removed from the remote server. This step is useful when you expect that some automation on the remove site will process the file and then remove it.
Friendly Name |
INI Variable |
Required? |
Description |
Site |
site |
required |
The name of a Managed Site record defined in the Configurator |
File Filter |
N/A |
optional |
Specification for file to match. default is * |
File Path |
path |
optional |
Remote directory into which the file should be dropped |
N/A |
timeout |
optional |
(Currently unsupported through the Web UI) Total minutes to wait for file to be removed before notifying |
Archive Files |
archive_files |
optional |
keep archival copies of created or imported files |
Minimum Age |
older_than |
optional |
Files must be older than the given relative value, which has a resolution of seconds, minutes, hours, days, or months; for example: "1 month" or "7 days". |
Maximum Age |
newer_than |
optional |
Files must be newer than the given relative value, which has a resolution of seconds, minutes, hours, days, or months; for example: "1 month" or "7 days". |
Minimum Size |
min_size |
optional |
Files must be at least as large as the specified size in bytes. |
The Retrieval step returns success if the file does not exist within the timeout period specified. If the file exists and is not deleted within the timeout period then a notification is sent and an error is logged in the database.
Please see the Robo-FTP Help file for more information about creating Managed Site records in the Configurator.
Important
The Framework controls the working folder so the value of a Managed Site's "Initial Local Directory" field is ignored when used in this step.
Example Usage:
