Using Metadata Fields to Set Relay Destinations

Use the SenderShareId, RecipientShareIds, OverrideShareIds metadata fields to configure file relays for a package upload.

Metadata field names for relay destinations use the term share. A share in this context is a file storage used as a relay destination.

You use the share_id of a file storage to designate it as a relay destination. To determine the share_id of a file relay destination, go to Server > File Storage, select the node, and click Edit from the drop-down menu. Find share_id in the page URL.

For example, if the page URL is https://faspex.aspera.us/aspera/faspex/admin/nodes/4/edit, the share_id is 4.

Metadata Field Name Description Format Example
SenderShareId Upload the package from the sender to the specified file storage (defined by share_id).

After the transfer has completed, when the sender downloads the package from the Sent page, Faspex transfers the package to the sender using the specified file storage as the source.

 share_id 3
RecipientShareIds For specified users (defined by user_name), upload copies of uploaded files to the specified file storage (defined by share_id).

After the transfer has completed, when a recipient downloads the package, Faspex transfers the package to the recipient using the specified file storage as the source.

 
{
  "user_name": share_id,
  "another_user: share_id,
  ...
}
Note: Value must be valid JSON.
 
{
  "admin": 4,
  "other_user": 5
}
OverrideShareIds In addition to the default inbox, relay files to the following file storages (defined by share_id). [share_id, ...]
Note: Value must be valid JSON.
 [1, 2, 3]

Example

share_id Node for file storage with specified share_id
1 node1
2 node2
3 node3
4 shared_node
5 shared_node
The default inbox has a share_id of 1. The sender, user, shares a package to user and the sender's own account with metadata:
  • SenderShareId = 2
  • RecipientShareIds = recipient_user: 3, sender_user: 4
  • Override = 5
Faspex uploads the package directly to node1 (default inbox) and then relays the contents to node2, node3, and shared_node. Since the file storage with share_id 4 and 5 both use shared_node, Faspex only needs to relay the package once.

When sender_user goes to the Sent page and downloads the sent package, Faspex transfers the package using node2 (share_id: 2) as the source.

When sender_user goes to the Received page and downloads the sent package, Faspex transfers the package using node3 (share_id: 3) as the source

When recipient_user goes to the Sent page and downloads the sent package, Faspex transfers the package using shared)node (share_id: 4) as the source