Set Destination changes the host definition, and optionally, the path, of the destination that is used in this task run.
This built-in script is typically used with macros. For more information, see Macros. Three common scenarios in which it may play a role are briefly described below.
Partial Paths or Filenames - If you have hosts named "FTP1" and "FTP2", you can use a macro like "[LEFT([OrigName], 4)]" in the "SetDestination_Host" parameter against a filename like "FTP2_report025245.dat" to select different hosts at runtime.
After Look Up - If you have hosts named "Remote Company FTP" and "SSH for Brooklyn", you can use the built-in Look Up script first to determine which host to use based on incoming filenames, file sizes, file paths, etc. and then use a macro like "[Parm:LookUp_Value]" in the "SetDestination_Host" parameter to select different hosts at runtime.
With MOVEit Automation API - Because MOVEit Automation can pass parameters to any task it runs, you can use a macro like "[Parm:HostFromAPI]" in the "SetDestination_Host" parameter so that the MOVEit Automation API application selects different hosts at runtime.
Input Parameters
SetDestination_Host (Required) - The friendly name of the destination host. The host you select does not need to be currently defined in the task, nor does it need to be of the same type. For example, you can use this parameter to switch the destination to a MOVEit Transfer server even if the task's destination is currently a single FTP server.
However, if you use this parameter to switch between hosts of different types (such as between FTPS and MOVEit Transfer servers) you MUST also use the "SetDestination_Path" parameter to ensure that destination paths are properly parsed. To indicate a Windows file system host, use a value of "(default)"; in this case begin the "SetDestination_Path" value with a drive letter (C:\) or a UNC (\\server\share\).
SetDestination_Path (Optional) - Sets the Destination path. Ignored if blank. Macros are allowed and often used in this field.
SetDestination_IgnoreError (Required) - Specifies whether to ignore errors in setting host and path.
Set the value to ON only if you have a fallback destination configured.
Notes
This built-in script can be run per-file or once-after-all-files.
This built-in script can be run as the first step of a task.