Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Copy File activity

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

Input variables

VariableDescription
sourceHostName or IP address of the server containing the files you want to transfer.
sourcePortPort number to use to communicate with the source server. The default port number is 22.
sourceFilePathFull path to the file to copy from the source host.
targetHostName or IP address of the server to which you want to move the files.
targetPortPort number to use to communicate with the target server. The default port number is 22.
targetFilePathFull path to the copied file on the target host.
tempFileSuffixTemporary 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.
sourceCredentialTagSpecific Credential aliases for Orchestration activities this activity must use to run SSH commands on the source host.
targetCredentialTagSpecific credential tag this activity must use to run SSH commands on the target host.

Output variables

VariableDescription
errorMessagesThe executionResult.errorMessages from the Activity designer parsing sources. If this variable is not null, the operation has failed.
resultText message advising that the command was executed successfully.

Conditions

ConditionDescription
SuccessThe activity succeeded in copying the file.
FailureThe activity failed to copy the file.

Parent Topic:SFTP File Transfer activity pack