SFTP Dir

The SFTP Dir activity provides a list of files in the specified directory of the 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.

Show Short File Names No Select this check box to view the file names only as a list.

If the check box is not selected, the specified detailed information about the files and directories is visible.

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 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.
Directory string The path to the directory for which you want to list the files and directory. This parameter is optional, and if null, lists the 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 overrides the value specified in the SFTP Connection shared resource.

Output

The following is the output for the activity.

Output Item Datatype Description
ItemCount integer The number of entries returned from the remote directory listing.
DirectoryItems string A repeating element containing the list of files returned.

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.