Copy File activity

The Copy File activity copies a file from an SFTP server (source host) to another SFTP server (target host).

Input variables

Table 1. Copy File input variables
Variable Description
sourceHost Name or IP address of the server containing the files you want to transfer.
sourcePort Port number to use to communicate with the source server. The default port number is 22.
sourceFilePath Full path to the file to copy from the source host.
targetHost Name or IP address of the server to which you want to move the files.
targetPort Port number to use to communicate with the target server. The default port number is 22.
targetFilePath Full path to the copied file on the target host.
tempFileSuffix Temporary suffix to use when moving a file. If this field contains a value, the activity deletes the duplicate target file, if it exists, and then copies the source file to a temporary file using targetFilePath + tempFileSuffix as the name. Upon completion, the activity renames the file to the actual target file name. If this field is blank, the activity copies the source file directly to the target file and overwrites it, if it already exists.
sourceCredentialTag Specific credential tag this activity must use to run SSH commands on the source host.
targetCredentialTag Specific credential tag this activity must use to run SSH commands on the target host.

Output variables

Table 2. Copy File 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 Text message advising that the command was executed successfully.

Conditions

Table 3. Copy File conditions
Condition Description
Success The activity succeeded in copying the file.
Failure The activity failed to copy the file.