FTP send is a processor (although conceptually it is a consumer) that uploads any incoming jobs to an FTP site.
In case your system environment requires FTP connections to pass through a proxy server, you need to setup the FTP proxy preferences to provide Switch with the configuration details for the proxy server. In this case, FTP send will fail as long as these preferences have not been set.
Keywords
Keywords can be used with the search function above the Elements pane.
The keywords for the FTP send element are:
- Internet
- web
- FTP
- SFTP
- network
- communication
- transfer
- output
- upload
Connections
FTP send supports optional outgoing connections to provide in-flow feedback about the operation and to keep the job around without extra copying. This allows multiple send operations to be chained in an intelligent manner; for example:
Successively upload the same job to multiple FTP sites.
Provide a fallback operation when an upload fails (for example, upload to a secondary site).
Send an email with the URL of a job that was successfully uploaded to an FTP site.
FTP send supports traffic-light connections of the following types (other types are not allowed):
Data error: carries the incoming job if the operation fails at the first attempt; if there are no data error connections the tool keeps retrying the operation as specified in the user preferences.
Data success: carries the incoming job after the operation succeeds; if there are no data success connections the output is simply suppressed (without logging a warning or error).
Log success: carries a small log file in XML format after the operation succeeds; if there are no log success connections the output is simply suppressed. The log file contains relevant information about the operation such as destination, time sent, transfer time, list of files, etc. SeeProcessing results schema.
Data with log success: carries both the job and the log file (as metadata), allowing access to the results of the operation through variables or scripting.
Properties
Property |
Description |
|---|---|
Name |
The name of the flow element displayed in the canvas |
| Server type | Select FTP or SFTP |
| Passive mode | If set to yes, FTP send uses passive mode, otherwise it uses active mode |
FTP server address |
The URL or IP address of the FTP server to which the jobs are to be delivered |
Port |
The port used by the FTP server |
User name |
The login name for the FTP server. For anonymous login, use "anonymous" as user name |
Password |
The password for the FTP server. For anonymous use, enter an email address as password. |
FTP directory |
The directory on the FTP site to which jobs are to be delivered. If the path starts with a forward slash "/", it is relative to the users's home directory. If the path starts with a double forward slash, it is relative to the FTP site's system root. This is only useful if the user has access to the complete file system on the FTP site |
Subfolder levels |
The number of nested subfolder levels in the uploaded folder hierarchy (similar to the behavior of the archive hierarchy tool) When this property is set to zero (the default) all jobs are placed immediately inside the FTP directory specified in the previous property |
Strip unique name |
If set to yes, the unique name prefix added to the filename by Switch is removed before placing the job in the FTP hierarchy; the default is to strip the prefixes from jobs deposited in a FTP hierarchy - leaving the prefixes in place avoids overwriting a previously deposited job with the same name |
Duplicates |
Determines what happens when "Strip unique name" is set to yes and a job arrives with the same name and location as a job already residing on the FTP site:
|