SFTP Delete File

The SFTP Delete File activity issues an SFTP rm command to remove one or more files from the remote server.

General

The General tab has the following fields.

Field Literal Value/Module Property Description
Name No The name to be displayed as the label for the activity in the process.
SFTP Connection Yes

The path to the shared configuration resource containing the user information such as Host, Port, and User Name, Private Key or Password, and Known Host File.

For configuration details, refer to SFTP Connection.

Quit (post-command) No When this check box is selected, it specifies that the SFTP Connection should be closed after completing this command.

If this check box is not selected, the SFTP Connection remains open so that all SFTP activities specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed.

Description

Provide a short description for the activity.

Input

The following is the input for the activity.

Input Item Datatype Description
Host string The name or IP of the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
Port integer The port number for the incoming SFTP requests on the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
UserName string The user name for logging to the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
Password password The password for logging into the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
PrivKey string The private key’s absolute or relative path to authenticate your login. This overrides the value specified in the SFTP Connection shared resource.
PrivKeyPass password The password of the private key, if using the PrivKey authentication or two factor authentication method to log on to SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Proxy Host string The host name or IP address of the proxy server.
Proxy Port integer The port number of the proxy server.
Proxy User Name string The user name used to connect to the proxy server, if necessary.
Proxy Password password

The password for the specified user name when connecting to the proxy server, if necessary.

RemoteDirectory string The path to the directory containing the file(s) to be deleted. This element is concatenated with the RemoteFilename element to provide the complete path to the file(s) to be deleted. This element is optional.
RemoteFilename string The path and name of the file to delete on the remote server. Wildcards (? for any one character or * for one or more characters) are permitted in this field.
Note: TIBCO recommends that you exercise caution when using wildcards as this activity could delete the files you want to save.

You can specify an absolute or relative path for the remote file name. Relative paths are specified in the RemoteDirectory element and the user’s current remote directory.

Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP Connection used by this activity into a waiting state.

This value overrides the value specified in the SFTP Connection shared resource.

Fault

The Fault tab lists the possible exceptions that can be thrown by this activity.

Exception Thrown When...
CommandExecutionException An error occurs when executing the SFTP command.
ConnectionErrorException An error occurs when connecting to the SFTP server.