SFTP Rename File

The SFTP Rename File activity renames the specified file on the remote SFTP server.

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 Rename File 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.
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.
OldRemoteDirectory	string	The path to the remote directory which contains the file you want to rename. This element is concatenated with the OldRemoteFileName element to provide the complete path to the file to rename.
OldRemoteFilename	string	The name of the remote file you want to rename. You can optionally include the complete path of the file to rename.
NewRemoteDirectory	string	The new path of the remote directory which contains the file to rename. This element is concatenated with the NewRemoteFileName element to provide the complete path to the file to rename. This element is optional.
NewRemoteFilename	string	The new name for the remote file. You can optionally include the complete path of the file.
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 in a waiting state. This overrides the value specified in the SFTP Connection shared resource.

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.