- Docs
- Integrations
- Sync
- Sync Setup
Sync Setup
Setting up a Sync is easy. Choose a source and a destination using the folders within your site or folders within your Remote Servers. Select options for how the Sync will be triggered. You can also configure optional include and exclude patterns to control which files are affected by the Sync. There's also the option to provide a human-readable description for the Sync, to make sync management more convenient.
Source Folder
The source folder can be within your site or within a Remote Server.
For remote servers, make sure that the target folder exists prior to creating the Sync as only existing folders will be available for selection.
Destination Folder
The destination folder can be within your site or within a Remote Server.
For remote servers, make sure that the target folder exists prior to creating the Sync as only existing folders will be available for selection.
After Copying
You can choose whether to delete or keep files in the source folder.
Selecting delete will remove copied items from the source folder, allowing you to "clean up" transferred files from the source location.
If you choose to delete, you can also Delete empty folders from the source when syncing.
End-Of-Sync Trigger Filename
Some Managed File Transfer (MFT) services require delivery of an empty file, known as a trigger file, to signal that data transfer is complete and further processing can begin.
Specifying a Trigger filename will enable the delivery of a zero-byte file to the sync destination once the sync has successfully finished.
The trigger file is the last file to be delivered, after all other files have been transferred.
The trigger file is only sent when files are transferred by the sync. If a sync contains no files then no trigger file will be delivered.
Starting the Sync
Each sync can be configured to automatically start based upon a schedule or via an external trigger.
When you save a sync, it will start to run immediately, unless it is disabled.
Enabling a disabled sync will also immediately start that sync.
Syncing to a Destination Folder That Has Folder Settings
When syncing files to a folder with folder settings that alter file contents or filenames (e.g. GPG Encryption, GPG Decryption, or Filename rewriting rules), enable the option to delete files from the source.
A sync to a destination folder with a folder setting that alters file contents or filenames will not run unless the sync is set to delete from source. This prevents repeated syncing of the same files every time the process runs, which could potentially lead to high transfer usage charges with no benefit to you.