Rename File or Directory activity

The Rename File or Directory activity renames a file or directory to a new name on an SFTP server.

Input variables

Table 1. Rename File or Directory input variables
Variable Description
sourceHost Name or IP address of the server containing the file or directory you want to rename.
sourcePort Port number to use to communicate with the target server. The default port number is 22.
sourceFilePath Full path to the file or directory to rename.
targetFilePath Full path to the renamed file or directory.
sourceCredentialTag Specific credential tag this activity must use to run SSH commands on the host.

Output variables

Table 2. Rename File or Directory output variables
Variable Description
errorMessages The executionResult.errorMessages from the Activity designer parsing sources. If this variable is not null, the operation has failed.
result A message saying that the operation has been successful. For example, you might see: Rename /tmp/sftp_test/subdir1 to /tmp/sftp_test/subdir2 complete.


Table 3. Rename File or Directory conditions
Condition Description
Success The activity succeeded in renaming the file or directory.
Failure The activity failed to rename the file or directory.