FTP delete

Description

The FTP delete action deletes files on an FTP server.

The SFTP protocol of this action is deprecated. It exists because the action was written before Hop could reach an SFTP server any other way. It can now: the Delete files action resolves its paths through VFS, so an SFTP Connection or a plain sftp:// path deletes remote files without a second implementation of the same thing. Existing workflows keep working and log a warning; new ones should use Delete files.

Option	Description
Action name	The name of the workflow action.
Server
Protocol	FTP SFTP (deprecated)
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. To connect with FTPS, use an FTP connection and its Security option.
SFTP connection	An optional SFTP Connection from the metadata, used when the protocol is SFTP.
FTP server name / IP address	The name of the server or the IP address.
Server port	Port number of the FTP server.
Username	The user name associated with FTP server account.
Password	The password associated the FTP server account.
Use proxy	Whether or not to use a proxy.
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.
Use Public Key	Whether or not to use a public key with an SSH connection.
Key file	The public key file.
Browse…	Browse the filesystem for a public key file.
Key passphrase	The public key passphrase.
Test connection	Tests the configured connection.

Option

Description

Action name

The name of the workflow action.

Server

Protocol

FTP
SFTP (deprecated)

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. To connect with FTPS, use an FTP connection and its Security option.

SFTP connection

An optional SFTP Connection from the metadata, used when the protocol is SFTP.

FTP server name / IP address

The name of the server or the IP address.

Server port

Port number of the FTP server.

Username

The user name associated with FTP server account.

Password

The password associated the FTP server account.

Use proxy

Whether or not to use a proxy.

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.

Use Public Key

Whether or not to use a public key with an SSH connection.

Key file

The public key file.

Browse…

Browse the filesystem for a public key file.

Key passphrase

The public key passphrase.

Test connection

Tests the configured connection.

Files tab

Option	Description
Advanced
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.
Remote
Copy previous results to args	Deletes the files named in the first field of the previous result rows, instead of the files matching Wildcard.
Remote directory	The directory on the remote FTP server.
Check folder	Checks if the directory exists.
Wildcard (regular expression)	The regular expression the file names must match. Required unless Copy previous results to args is checked.
Success condition
Success on	The success condition All works fine At least we delete x files Nr errors less than
Limit files	Sets a limit to the number of deleted files (default 10).

Option

Description

Advanced

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.

Remote

Copy previous results to args

Deletes the files named in the first field of the previous result rows, instead of the files matching Wildcard.

Remote directory

The directory on the remote FTP server.

Check folder

Checks if the directory exists.

Wildcard (regular expression)

The regular expression the file names must match. Required unless Copy previous results to args is checked.

Success condition

Success on

The success condition

All works fine
At least we delete x files
Nr errors less than

Limit files

Sets a limit to the number of deleted files (default 10).

Socks Proxy tab

Option	Description
Host	Socks Proxy host name.
Port	Socks Proxy port number.
Username	User name associated with the Socks Proxy account.
Password	Password associated with the Socks Proxy account.

Option

Description

Host

Socks Proxy host name.

Port

Socks Proxy port number.

Username

User name associated with the Socks Proxy account.

Password

Password associated with the Socks Proxy account.

Result

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

Result	Value
True	Depends on Success on: All works fine (default): no file failed. No file matching the wildcard is also true, and so is Copy previous results to args without previous result rows. At least we delete x files: at least Limit files files were deleted. Nr errors less than: the number of errors is at most Limit files. A failure before deleting counts as 1 error, so the cases listed under False give true with 1 error when Limit files is 1 or more.
False	The success condition is not met, for example because the server can’t be reached or refuses the login, the remote directory doesn’t exist, the wildcard is not a valid regular expression, or Wildcard is empty while Copy previous results to args is unchecked. The number of errors is the number of files that failed, or 1 when the action fails before deleting. With Nr errors less than, these failures count as 1 error, so the action is true when Limit files is 1 or more.
Result files	Passed on unchanged.
Result rows	Passed on unchanged.
Files retrieved	The number of files deleted. When the remote directory has no files, or Copy previous results to args is checked without previous result rows, the value of the previous action is passed on unchanged.

Result

Value

True

Depends on Success on:

All works fine (default): no file failed. No file matching the wildcard is also true, and so is Copy previous results to args without previous result rows.
At least we delete x files: at least Limit files files were deleted.
Nr errors less than: the number of errors is at most Limit files. A failure before deleting counts as 1 error, so the cases listed under False give true with 1 error when Limit files is 1 or more.

False

The success condition is not met, for example because the server can’t be reached or refuses the login, the remote directory doesn’t exist, the wildcard is not a valid regular expression, or Wildcard is empty while Copy previous results to args is unchecked. The number of errors is the number of files that failed, or 1 when the action fails before deleting. With Nr errors less than, these failures count as 1 error, so the action is true when Limit files is 1 or more.

Result files

Passed on unchanged.

Result rows

Passed on unchanged.

Files retrieved

The number of files deleted. When the remote directory has no files, or Copy previous results to args is checked without previous result rows, the value of the previous action is passed on unchanged.

With Copy previous results to args, the first field of each previous result row is the name of a file to delete in the remote directory, and Wildcard is not used.

FTP delete

Description

Options

General tab

Files tab

Socks Proxy tab

Result