What is a Relay?

Relays transfer copies of uploaded files to specified destinations (custom inboxes). There are two types of relays: package relays and file relays.

Overview

There are three types of transfers to Faspex file destinations: direct uploads, package relays, and file relays.
Transfer type Description Starts when Transferred files directory structure on the destination node
Direct upload

A direct upload transfers files to the default inbox or to a custom inbox with direct upload configured.

Faspex makes these files available to the designated recipients. Faspex also uses these files when performing a relay.		 A user sends a package to a recipient, workgroup, or dropbox. 
package_title - package_id.aspera-package/
|-- PKG - package_title
    |-- folder1
        |-- file1
    |-- file2
Package relay A package relay transfers copies of files uploaded to a source node to specified nodes. Package relays preserve the package directory structure. A user sends a package to a workgroup or dropbox with a custom inbox that does not have direct upload configured.

A user sends a package with relay metadata (see Using Metadata Fields to Set Relay Destinations).

 
package_title - package_id.aspera-package/
|-- PKG - package_title
    |-- folder1
        |-- file1
    |-- file2
File relay A file relay transfers copies of files uploaded to a source node to specified nodes. File relays do not preserve the package directory structure. A user sends a package to a workgroup or dropbox with relays configured. 
folder1
|-- file1
file2

Order of Operations

If a transfer triggers both package and file relays, Faspex performs transfers in this order:

  1. Direct upload
  2. Package relay
  3. File relay

If the direct package upload fails, Faspex does not relay the package to custom inboxes or file relay destinations.

If the direct package upload succeeds, Faspex performs both relays. If the package relays fail, Faspex still performs the file relays.