FTP send

FTP send is a processor (although conceptually it is a consumer) that uploads any incoming jobs to an (S)FTP site.

If your system environment requires (S)FTP connections to pass through a proxy server, you need to set up the (S)FTP proxy preferences to provide Switch with the configuration details of the proxy server. See Switch preferences: FTP proxy.

Keywords

If you enter one of the following keywords in the Search field at the top of the Flow elements pane, the FTP send element will be shown in the list:

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 (S)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 (S)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. See Processing 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.
Description	A description of the flow element displayed in the canvas. This description is also shown in the tooltip that appears when moving your cursor over the flow element
Server type	Select FTP or SFTP. If you select FTP, you have to set the subordinate property Passive mode (see further). If you select SFTP, you have to choose the preferred Authentication method (see further).
Authentication method	Only available if server type = SFTP You have two options: Password: Switch logs on to the server with the user name and password filled in below. Public key: Switch logs on to the server using key pairs (public key + private key) which can be generated with the PuTTY Key Generator. The public key is the key used on the server, which must be configured to use public key configuration. The private key is the key used by Switch. You must set the following subordinate properties: Certificate store type: Format in which the key was saved. Certificate store path: Full path to the certificate file, which contains the private key. Certificate store password: Password used to save and encode the generated keys. If no password was used, this field should remain empty. Note: Alternatively, you can set the authentication method when selecting the FTP directory (See the FTP directory property: click and Choose FTP directory).
Passive mode	Only available if server type = FTP If set to Yes, FTP receive uses passive mode to communicate with the FTP server; otherwise it uses active mode.
User name	The login name for the (S)FTP server. For anonymous login, use "anonymous" as user name. Note: If you're using the (S)FTP proxy protocol, append an @ sign and the target FTP site address (domain or IP address) to the regular user name (<ftpserverusername>@<ftpserveraddress>).
Password	The password for the (S)FTP server. For anonymous use, enter an email address as password. This property is not available if you have chosen for Public key as authentication method for the SFTP server.
FTP server address	The URL or IP address of the (S)FTP server to which the jobs are to be delivered. Note: If you're using the (S)FTP proxy protocol, this should be URL or IP address of the proxy server.
Port	The port used by the (S)FTP server.
FTP directory	The directory on the (S)FTP site to which jobs are to be delivered. If the path starts with a forward slash "/", it is relative to the user's home directory. If the path starts with a double forward slash, it is relative to the (S)FTP site's system root. This is only useful if the user has access to the complete file system on the (S)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 (default value) all jobs are placed immediately inside the (S)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 (S)FTP site: Overwrite: replace the existing job with the new one – this is the default behavior. Keep unique name: preserve the new job's unique name prefix, leaving the existing job untouched (without unique name prefix). Add version number: add an incrementing version number at the end of the filename body for the new job ("2", "3", … "9", "10", "11"), leaving the existing job untouched. For example, "job.pdf" will become "job1.pdf"," job2.pdf", ... Optionally, you can add a separator between the filename body and the version number, for example an underscore. In that case, e.g. "job.pdf" will become "job_1.pdf"," job_2.pdf", ... By default, the Separator property is empty. You can also determine the width of the version number, i.e. the number of digits used for the version number. For example, if Width is set to "5", the version number will consist out of 5 digits (e.g. job_00001.pdf), meaning that leading zeros will be added as required. Fail: move the new job to the problem jobs folder, leaving the existing job untouched.