Note: First see Working with File Sets for a discussion on how data flows through step to step.
The Pull step is used to download remote files to a job's file set.
Friendly Name |
INI Variable |
Required? |
Description |
Site |
site |
required |
The name of a Managed Site record defined in the Configurator |
File Filter |
specification |
optional |
Specification for source file to match. default is * |
File Path |
path |
optional |
Remote directory to monitor for a source file |
Timeout |
timeout |
optional |
Timeout in minutes looking for source file and send error notification |
Leave Files on Host |
persistent_source |
optional |
Should we leave processed source files on the server or delete them once they have been processed? |
Include Directories |
include_directories |
optional |
Import directories matching specification. default: false |
File Order |
file_order_first |
optional |
Indicates in what order the files should be processed. Possible values are "oldest", "newest", "server", without quotes, with the default being "server". "server" indicates that the files are ordered in whatever order the server returns the listing. |
Multiple Files |
multiple_files |
optional |
Number of files matching specification to import. "any" is zero or more, making the absence of a file for this step to import not an error. Possible values are a specific number like "1", "2", "3", etc., "all", or "any", without quotes. The default is "all". |
Minimum Size |
min_size |
optional |
Specifies that a file must be at least this many bytes, defaulting to 0. |
Minimum Age |
older_than |
optional |
Retrieved 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 |
Retrieved 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". |
Archive Files |
archive_files |
optional |
keep archival copies of created or imported files |
The Pull step works just like the Monitor step except the monitored source location is on an FTP or SFTP server rather than a locally accessible path. It searches the remote source location for the set of files matching the specification and then passes that file set on to the next step in the job.
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:
See also: Scheduling and the Timeout Parameter