SFTP Remove Remote Directory

The SFTP Remove Remote Directory activity deletes the specified directory from the remote SFTP 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.

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.

Remove Recursively No Selecting this check box deletes all the non-empty directories from the remote location (including subdirectories).

Description

Provides a short description for the activity.

Input

The input for the activity is the following.

Input Item Datatype Description
Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
ParentRemoteDirectory string The parent directory path of the remote directory, you want to remove. This element is concatenated with the RemoteDirName element to provide the complete path to the directory to remove.

This element is optional.

RemoteDirName string The name of the remote directory to remove. Optionally, include the complete path of the directory to remove.
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.

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 server.
ConnectionErrorException An error occurs when connecting to the SFTP command.