Put a file with FTP

Description

The Put A File With FTP action uploads a file to an FTP server.

Options

General tab

Option	Description
Action name	The name of the workflow action.
Server settings
FTP connection	An optional FTP Connection from the metadata. Pick one and the server, credentials, transfer mode, timeouts and proxy settings below come from that connection; leave it empty to configure the server on this action.
FTP server name / IP address	The name of the server or the IP address.
Port	The port number the FTP server connects on.
Username	The user name associated with the FTP server account.
Password	The password associated the FTP server account.
Proxy host	Proxy server host name.
Proxy port	Proxy server port number.
Proxy username	Proxy server account user name.
Proxy password	Proxy server account password.
Test connection	Tests the configured connection.
Advanced settings
Binary mode	Enable if files must be transferred in binary mode.
Timeout	The timeout in milliseconds, for example 30000 for 30 seconds. 0 (the default): no timeout.
Use active FTP connection	Enable if you are connecting to the FTP server using Active mode; you must set your firewall to accept connections to the port that your FTP client will open. The default is Passive mode.
Control encoding	Select the character encoding to use for determining special characters in file names. For Western Europe and the USA, ISO-8859-1 usually suffices. Select encoding that is valid for your server.

Option

Description

Action name

The name of the workflow action.

Server settings

FTP connection

An optional FTP Connection from the metadata. Pick one and the server, credentials, transfer mode, timeouts and proxy settings below come from that connection; leave it empty to configure the server on this action.

FTP server name / IP address

The name of the server or the IP address.

Port

The port number the FTP server connects on.

Username

The user name associated with the FTP server account.

Password

The password associated the FTP server account.

Proxy host

Proxy server host name.

Proxy port

Proxy server port number.

Proxy username

Proxy server account user name.

Proxy password

Proxy server account password.

Test connection

Tests the configured connection.

Advanced settings

Binary mode

Enable if files must be transferred in binary mode.

Timeout

The timeout in milliseconds, for example 30000 for 30 seconds. 0 (the default): no timeout.

Use active FTP connection

Enable if you are connecting to the FTP server using Active mode; you must set your firewall to accept connections to the port that your FTP client will open. The default is Passive mode.

Control encoding

Select the character encoding to use for determining special characters in file names. For Western Europe and the USA, ISO-8859-1 usually suffices. Select encoding that is valid for your server.

Files tab

Option	Description
Source (local) files
Local directory	The local directory from which to upload.
Browse…	Browse the filesystem for a local directory.
Wildcard (regular expression)	If you are uploading multiple files, specify a regular expression that defines the set of files you want to upload.
Remove files after transferal	Enable to remove files from the local directory after they’ve been uploaded.
Don’t overwrite files	Enable to skip files that already exist in the remote directory. See the WARNING under Result.
Remote directory	The directory on the FTP server to upload files to.
Test folder	Test if the remote directory exists. This connects to the FTP server and attempts to access the specified directory. If this directory doesn’t exist, the upload fails.

Option

Description

Source (local) files

Local directory

The local directory from which to upload.

Browse…

Browse the filesystem for a local directory.

Wildcard (regular expression)

If you are uploading multiple files, specify a regular expression that defines the set of files you want to upload.

Remove files after transferal

Enable to remove files from the local directory after they’ve been uploaded.

Don’t overwrite files

Enable to skip files that already exist in the remote directory. See the WARNING under Result.

Remote directory

The directory on the FTP server to upload files to.

Test folder

Test if the remote directory exists. This connects to the FTP server and attempts to access the specified directory. If this directory doesn’t exist, the upload fails.

Socks Proxy

Option	Description
Host	The Socks proxy server’s host name.
Port	The port number the Socks proxy connects on.
Username	The user name associated with the Socks proxy server account.
Password	The password associated with the Socks proxy server account.

Option

Description

Host

The Socks proxy server’s host name.

Port

The port number the Socks proxy connects on.

Username

The user name associated with the Socks proxy server account.

Password

The password associated with the Socks proxy server account.

Result

What this action passes on to the next action. See Action results for how results travel through a workflow.

Result	Value
True	Every matching file was uploaded, with 0 errors. No file matching the wildcard is also true.
False	A file can’t be uploaded, the server can’t be reached or refuses the login, the remote directory doesn’t exist, Local directory is empty or doesn’t exist, or the wildcard is not a valid regular expression. The number of errors is the number of files that failed, or 1 when the action fails before the upload.
Result files	Passed on unchanged: the uploaded files are not added.
Result rows	Passed on unchanged.

Result

Value

True

Every matching file was uploaded, with 0 errors. No file matching the wildcard is also true.

False

A file can’t be uploaded, the server can’t be reached or refuses the login, the remote directory doesn’t exist, Local directory is empty or doesn’t exist, or the wildcard is not a valid regular expression. The number of errors is the number of files that failed, or 1 when the action fails before the upload.

Result files

Passed on unchanged: the uploaded files are not added.

Result rows

Passed on unchanged.

With Don’t overwrite files and Remove files after transferal both checked, a local file that already exists on the server is not uploaded, but it is still removed from the local directory.