FTP Delete File

The FTP Delete File activity issues an FTP delete or mdelete command to remove one or more files from the remote server.

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
FTP Connection	No	Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.
Quit (post-command)	No	When checked, this field specifies that the FTP connection should be closed after completing this command. If this field is not checked, the FTP connection remains open so that all FTP activities that specify the same FTP session (that is, the same host, port, username, and password) share the FTP session until the connection is closed.

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

FTP Connection

Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.

Quit (post-command)

When checked, this field specifies that the FTP connection should be closed after completing this command.

If this field is not checked, the FTP connection remains open so that all FTP activities that specify the same FTP session (that is, the same host, port, username, and password) share the FTP session until the connection is closed.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
Host	string	The name of the FTP server. This overrides the value specified in the FTP Connection resource.
Port	integer	Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.
UserName	string	Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
Password	string	Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
RemoteDirectory	string	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, * for one or more characters) are permitted in this field. You can specify an absolute or relative path for the remote file name. Relative paths are relative to the path specified in the RemoteDirectory element or the user’s home directory, if RemoteDirectory is null.
Timeout	integer	The amount of time to wait for the FTP server to respond. This timeout is used when the FTP server places the FTP connection used by this activity into a waiting state. This overrides the value specified in the FTP Connection resource. See FTP Connection for more information.

The name of the FTP server. This overrides the value specified in the FTP Connection resource.

Port

integer

Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.

UserName

string

Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.

Password

string

Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.

RemoteDirectory

string

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, * for one or more characters) are permitted in this field.

You can specify an absolute or relative path for the remote file name. Relative paths are relative to the path specified in the RemoteDirectory element or the user’s home directory, if RemoteDirectory is null.

Timeout

integer

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

This overrides the value specified in the FTP Connection resource. See FTP Connection for more information.

This activity produces no output.

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
ConnectionErrorException	An error occurred when connecting to the FTP server.
CommandExecutionException	An error occurred when executing the FTP command.

Exception

Thrown When...

ConnectionErrorException

An error occurred when connecting to the FTP server.

CommandExecutionException

An error occurred when executing the FTP command.