File relays

Edit online

A file relay transfers copies of files uploaded to a source node to specified nodes. File relays do not preserve the package directory structure. File relays transfers files to storage in a flat structure. This is ideal for ingesting files without having to parse nested data from package structure (such as providing files for API consumption).

File relay options

When you configure file relays on a workgroup or shared inbox, you can set the file relay to overwrite existing files with the same name at the destination. By default, Faspex skips files with the same name that exist at the destination node.

You can also configure email notifications for file relays. In the Server > Notifications section, you can use the Relay Started CC email template to notify users when package forwarding is started, a Relay Finished CC email template to let users know when package forwarding is completed, and a Relay Error CC email template to notify users when package forwarding has failed. For details see Reference: Email notification templates.

Comparing file relays to package relays

When a user uploads files to a custom inbox with direct upload or to the default inbox, Faspex creates the following package directory structure on the destination node:

package_title - package_id.aspera-package/
|-- PKG - package_title
    |-- folder1
        |-- file1
    |-- file2

File relays do not preserve this directory structure, but transfers the contents of the package in a flat structure to the destination node:

folder1
|-- file1
file2

If the destination node already had the existing_file1 and existing_folder1 files, the resulting directory snapshot would be:

existing_file1
existing_folder1
|-- existing_file2
folder1
|-- file1
file2