"Set Destination" changes the host definition (and optionally, the path) of the destination used in this task run.
This built-in script will almost always be used with 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 might 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 might use the built-in Look Up script first to figure out 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 Central API - MOVEit Central's ability to pass parameters to any task it runs allow you to use a macro like "[Parm:HostFromAPI]" in the "SetDestination_Host" parameter to let your MOVEit Central API application select 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. (e.g., You can use this parameter to switch the destination to a MOVEit DMZ 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 (for example, between FTPS and MOVEit DMZ servers) you MUST also use the "SetDestination_Path" parameter to ensure that destination paths are properly parsed. Use a value of "(default)" to indicate a Windows file system host; in this case your "SetDestination_Path" value should either begin with a drive letter (e.g., "C:\") or a UNC (e.g., "\\server\share\").
SetDestination_Path (Optional) - Sets the Destination path. Ignored if blank. Macros are allowed (and encouraged) in this field.
SetDestination_IgnoreError (Required) - Specifies whether errors in setting host and path are ignored (set this to "ON" only if you have a fallback destination configured).
Notes
This built-in script may be run per-file or once-after-all-files. This built-in script may be run as the first step of a task.