Creating a Sync

Setting up a Sync is easy. Choose a source and a destination using the folders within your site, on a Remote Server or Agent, or even on a child site.

Any Site Administrator can add a new Sync to your site. Workspace Administrators can add Syncs within their Workspace.

Select options for how the Sync will be triggered.

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.

Who Can Create Syncs

Only users with admin-level access can create and manage Syncs.

Site Administrators can create and manage all Syncs. Workspace Administrators can create and manage Syncs for folders within their Workspace. Folder Administrators can create and manage Syncs for folders they control.

Source Folder

The source folder is where files will be synchronized from.

The source folder can be a folder in the current site (including a Remote Server Mount folder), a folder on a Remote Server, or a folder on an Agent. Syncs created by a Site Administrator in a parent site can use a Child Site for the source folder.

Destination Folder

The destination folder is where files will be synchronized to from the source folder.

The destination folder can be a folder in the current site (including a Remote Server Mount folder), a folder on a Remote Server, or a folder on an Agent. Syncs created by a Site Administrator in a parent site can target a Child Site for the destination folder.

When the Destination Folder Has Restrictive 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), you must enable the option to delete files from the source folder after copying.

To prevent repeatedly syncing the same files every time the process runs, your site will not start a sync to a destination folder that alters file contents or filenames the option to delete source files after copying is enabled. This prevents high transfer usage charges for a process that would offer no benefit to you.

After Copying

You can choose whether to delete or keep files in the source folder. Keeping files means that the original files are retained in the source folder after they have been copied to the destination.

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. When you're syncing files from a source that creates uniquely named folders, we recommend enabling this feature so that your source folder does not accumulate unused empty folders.

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, started via an external trigger, started manually or to run on an automatic interval.

You can start a Dry run to simulate the results of a Sync without performing any file transfer or modification actions.

Automatic Interval type Syncs start running immediately when they are saved or enabled, unless the Sync is disabled or already running.