SFTP Change Default Directory

The SFTP Change Default Directory activity changes the current default directory on the remote machine to the specified 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 user information such as Host, Port, and User Name, Private Key or Password, and Known Host File. For more details on configuration, see 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 user information such as Host, Port, and User Name, Private Key or Password, and Known Host File.

For more details on configuration, see 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 Change Default Directory activity.

Input

The following is the input for the activity.

Input Item	Datatype	Description
Host	string	The name or IP address of the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Port	integer	The port number for the 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.
PrivKeyPass	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.
Proxy Host	string	Specifies the host name or IP address of the proxy server.
Proxy Port	integer	Specifies the port number of the proxy server.
Proxy User Name	string	Specifies the user name used to connect to the proxy server, if necessary.
Proxy Password	password	Specifies the password for the specified user name when connecting to the proxy server, if necessary.
NewDefaultDir	string	The new directory to be set as a default directory for the current session. This element is mandatory.
Timeout	integer	The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server puts the SFTP Connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection shared resource.

Fault

The Fault tab lists the possible exceptions 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.

Did you find this helpful?

Yes No