SFTP Get Default Directory

The SFTP Get Default Directory activity retrieves the name of the current remote directory. The default remote directory is operating system-dependent and determined by the remote SFTP server. On UNIX systems, the default remote directory is usually the home directory of the user account that is used to establish an SFTP connection. The current remote directory may be different from the default directory. When SFTP Change Default Directory activity is used to change the default directory in the same session, it returns the currently set remote directory path.

General

The General tab has the following fields.

Field	Literal Value/Module Property	Visual Difference?	Description
Name	No	Yes	The name to be displayed as the label for the activity in the process.
SFTP Connection	Yes	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	Yes	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.

Field

Literal Value/Module Property

Visual Difference?

Description

Name

Yes

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)

Yes

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

In the Description tab, you can enter a short description for the SFTP Get Default Directory activity.

Input

The following is the input for the activity.

Input	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.
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.
PrivKeyPasss	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.
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 output for the activity is the following.

Output Item	Datatype	Description
CurrentDirectory	string	The current set directory on the remote SFTP server. By default, this directory is set by the SFTP server.

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.