Setting Up Hot Folders

Hot Folders enable you to monitor selected (and configured) folders for changes and automatically transfer new or modified files. Hot folders can be used for one-way replication between two locations or simply as a way of forwarding files in your workflow. Hot Folders feature uses the Aspera Sync service, which runs in the background.

Important: If you are using a transfer proxy or an HTTP proxy, Hot Folders uses the global proxy settings, not the proxy settings configured in My Preferences. For information about enabling a proxy server, see Enabling a Transfer or HTTP Proxy.

To set up a Hot Folders, launch the program with admin privileges. In the file browser, go to the folder you wish to set up as the Hot Folder. Right-click the panel and select New > Hot Folder to bring up the New Hot Folder dialog. You can also launch it from File > New > Hot Folder.

Create the Hot Folders.

The New Hot Folder window includes the following configuration tabs:

Tab Description
Hot Folder Set the source, the destination, and the synchronization interval.
Transfer Set the transfer speed and transfer policy.
Tracking Turn on and configure email notifications for transfer start, completion and error.
Filters Create filters to skip files that match certain patterns.
Security Enable transfer encryption and content protection.
File Handling Set up a resume rule, preserve transferred file attributes, and remove or move source files.

The following tables describe the options available on each configuration tab.

Hot Folder

Option Description
Name The name of the Hot Folder. Use the default name or enter your own. The default name is the name of the Windows folder. Click Generate to restore the default name.
Source Specify the source for the Hot Folder. If the source is This Computer, then the Hot Folder is in push mode.
Destination Specify the destination for the Fot Folder. If the destination is This Computer, then the Hot Folder is in pull mode.
Send Changes Select when to synchronize. The options depend on whether the Hot Folder is in push or pull mode:
  • Push and pull mode: Select Daily at to specify a time to synchronize daily.
    Note: When the specified time is reached, file transfers from the Hot Folder are allowed for one hour, including any new files added during that window. The one-hour window supports retries.
  • Pull mode: Select Every to specify the interval at which to scan the source Hot Folder and receive updates.
  • Push mode: Select Periodic scan to specify the interval at which to scan the source Hot Folder and send updates if changes are detected.
    Note: When file notification is not available, this feature must be activated in order to detect file changes in your Hot Folders.
  • Push mode: Select Send immediately to synchronize whenever a file in the folder is changed.

Transfer

Option Description
Policy Set the FASP transfer policy.
  • fixed – Attempts to transfer at the specified target rate, regardless of the actual network capacity. This policy transfers at a constant rate and finishes in a guaranteed time. This policy typically occupies most of the network's bandwidth, and is not recommended in most file transfer scenarios. In fixed mode, a maximum (target) rate value is required.
  • high – Monitors the network and adjusts the transfer rate to fully utilize the available bandwidth up to the maximum rate. When congestion occurs, a it transfers at a rate twice of a session with fair policy. In this mode, both the maximum (target) and the minimum transfer rates are required.
  • fair – Monitors the network and adjusts the transfer rate to fully utilize the available bandwidth up to the maximum rate. When other types of traffic build up and congestion occurs, it shares bandwidth fairly by transferring at an even rate. In this mode, both the maximum (target) and the minimum transfer rates are required.
  • low – Similar to fair mode, the low policy uses the available bandwidth up to the maximum rate, but is much less aggressive when sharing bandwidth with other network traffic. When congestion builds up, the transfer rate is reduced to the minimum rate until other traffic retreats.
Note: If --policy is not set, ascp uses the server-side policy setting (fair by default).
Speed Select this option to specify the transfer rate.

Tracking

Option Description
Send Email Notifications Select to enable email notifications and to display configuration options; however, notifications are not sent until they are enabled (click Preferences on the main screen of the application). For more information, see Configuring Transfer Notifications.
Important: For Hot Folder email notifications to work, the GUI must remain open.
When (not displayed until checkbox is enabled) Select one or more events that trigger the notification (transfer start, completion, and error).
To (not displayed until checkbox is enabled) Enter the email addresses of the recipients.
Template (not displayed until checkbox is enabled) Select a notification template from the drop-down list. Add, delete, edit, and preview templates by clicking Manage Templates. For more information on configuring templates, see Configuring Transfer Notifications.
Message (not displayed until checkbox is enabled) Include a custom message with the notification.

Filters

Click Add and enter the filter pattern to use to exclude files or directories from the transfer. The exclude pattern is compared with the whole path, not just the file name or directory name. As shown below, the asterisk (*) can be used to represent zero to many characters in a string, for example *.tmp matches .tmp and abcde.tmp:

Filter Pattern Excludes these files
*dirName path/to/dirName, another/dirName
*1 a/b/file1, /anotherfile1
*filename path/to/filename, /filename
Note: The temporary files used by Aspera to resume incomplete files are ignored according to the resume suffix setting of the sender.

Security

Option Description
Encryption Select Encrypt data in transit to encrypt files during transfer. Encryption may decrease performance, especially at higher transfer speeds and with slower computers.
Content Protection Select if files will be encrypted or decrypted, depending on whether the Hot Folder is in push or pull mode:

Push mode: Select Encrypt uploaded files with a password to encrypt the uploaded files with the specified password. The protected file has the extension .aspera-env appended to the file name.

Pull mode: Select Decrypt password-protected files downloaded to require entry of the decryption password when downloading encrypted files.

File Handling

Option Description
Resume Select Resume incomplete files to enable the resume feature. Select the method of comparing files from the When checking files for differences dropdown menu:
  • Compare file attributes only checks if the existing file is the same size as the original, otherwise retransfers the original file.
  • Compare sparse file checksums performs a sparse checksum on the existing file and resumes if it matches the original, otherwise retransfers the original file.
  • Compare full file checksums performs a full checksum on the existing file and resumes if it matches the original, otherwise retransfers the original file.
File Attributes Select one or more options to preserve the access time, modification time, or source access time of the transferred files.
Source Handling Select Automatically delete source files after transfer to delete the successfully-transferred files from the source. Select Delete empty source subdirectories to also remove the folder.

Push mode: Select Automatically move uploaded source files to a directory after transfer and specify the location on the source machine to which they should be moved. Only a path to an existing location on the client can be specified.

Pull mode: Select Transfer source directory contents only to transfer only the contents of the directory and not the directory itself. If this option is enabled, for a source folder /folder1 containing file1 and file2 being pulled to the destination folder /destination, only file1 and file2 are transferred, not /folder1. If this option is not selected, the transfer produces /destination/folder1 (containing the two files) on the destination machine.

Note: Any empty folders created in a hot folder are not pushed to the server. However, empty folders that have been created on the server are pulled to the local destination.