Using Metadata Fields to Set Relay Destinations

Use the SenderShareId, RecipientShareIds, OverrideShareIds metadata fields to configure 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	Description	Format	Example
`SenderShareId`	Defines the file storage destination (defined by `share_id`) for the initial upload of a new package. If set, override the default inbox storage setting in Faspex with the file storage destination. If not set, use the default inbox destination as the file storage destination. Use `SenderShareId` to control where the sender uploads to and downloads the sent package from. When the sender downloads the package from the Sent page, Faspex transfers the package to the sender from this file storage.	`share_id`	`3`
`RecipientShareIds`	Defines extra recipients (defined by `user_name`) and their respective file storage locations (defined by `share_id`). Faspex performs a package relay transfer from the initial transfer destination to the targets defined in the metadata. Use `RecipientShareIds` to control where recipients download the package from. When recipients download the package from the Received page, Faspex transfers the package to the recipients from the specified file storages.	`{ "user_name": share_id, "another_user: share_id, ... }` Note: Value must be valid JSON.	`{ "admin": 4, "other_user": 5 }`
`OverrideShareIds`	Defines additional file relays from the initial transfer destination host to designated 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` (default inbox)
`2`	`node2`
`3`	`node3`
`4`	`node4`
`5`	`node5`

The sender (sender_user) sends a package to the recipients (recipient_user1, recipient_user2, and recipient_user3) and configures file transfers using the metadata:

SenderShareId = 2
RecipientShareIds = recipient_user1: 3, recipient_user2: 4
OverrideShareIds = 5

Faspex performs the following transfers:

Faspex uploads the package directly to node2.
Faspex performs a package relay from node2 to node3 and node4.
Faspex performs a file relay from node2 to node5.

When a user downloads the uploaded package, Faspex uses the metadata to determine from which node to serve the content:

User	Downloading from	Package source node
`sender_user`	Sent page	`node2` (`share_id: 2`)
`recipient_user1`	Received page	`node3` (`share_id: 3`)
`recipient_user2`	Received page	`node4` (`share_id: 4`)
`recipient_user3`	Received page	`node2` (`share_id: 2`)

In this scenario, the sender uploads the package to the node2 as defined by the SenderShareId, and not the server-default inbox. When recipient_user3 (who is not defined in RecipientShareIds) downloads the package, the user downloads from node2, since there is no package in the server-default inbox. In this scenario, Faspex treats the share configured with SenderShareId as the default inbox.