FTP Delete File
FTP Delete File is a synchronous activity that issues an FTP delete or mdelete command to delete one or more files from the remote server.
General
The General tab has the following fields.
Field | Literal Value/Module Property | Description |
---|---|---|
Name | None | The name to be displayed as the label for the activity in the process. |
FTP Connection | Yes | The path to the shared configuration resource containing the user information such as host name, username, and password. |
Quit (post-command) | None | Select this check box to specify that the FTP Connection should be closed after completing this command.
The FTP connection remains open, if this check box in not selected. As a result all the 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. |
Input
The following is the input for the activity.
Input Item | Datatype | Description |
---|---|---|
Host | string | The name of the FTP server.
This overrides the value specified in the FTP Connection property. |
Port | integer | The port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property. |
UserName | string | The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property. |
Password | string | The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property. |
RemoteDirectory | string | An optional element. The path to the directory containing the files to be deleted.
This element is concatenated with the RemoteFileName element to provide the complete path to the files to be deleted. |
RemoteFileName | string | The path and name of the file to delete on the remote server. This field permits wildcards (? for any one character, * for one or more characters).
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 in the user’s home directory, if RemoteDirectory is null. |
Timeout | integer | This timeout is used, when the FTP server places the FTP Connection used by this activity, into a waiting state. |