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 the storage location used as a relay destination.

You use the share_id of a storage location to designate it as a relay destination. To determine the share_id of a file relay destination:
  1. Go to Nodes and storage.
  2. Right-click the node and select Add file storage.
  3. Select the storage location.
  4. Find the share_id in the page URL. For example, if the page URL is https://faspex.aspera.us/aspera/faspex/admin/nodes-storage/4/storage/1/profile, the share_id is 1.
Metadata field Description Format Example
SenderShareId Defines the storage location 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 storage location destination. If not set, use the default inbox destination as the storage location 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 mailbox, Faspex transfers the package to the sender from this storage location.

 share_id 3
RecipientShareIds Defines extra recipients (defined by user_name) and their respective 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 mailbox, Faspex transfers the package to the recipients from the specified storage locations.

Draft comment: jhwanus.ibm.com
According to FASPX-940, array support in the JSON is not yet supported. Currently can only set 1 Share ID.
 
{
  "user_name": share_id,
  "another_user: share_id,
  ...
}
Note: Value must be valid JSON.
 
{
  "admin": 4,
  "other_user": 5
}
OverrideShareIds
Draft comment: josephwan
create an extra file relay if necessary after initial upload
Defines additional file relays from the initial transfer destination host to designated storage locations (defined by share_id).		 [share_id, ...]
Note: Value must be valid JSON.
 [1, 2, 3]

Example

share_id Node for storage location 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:
  1. Faspex uploads the package directly to node2.
  2. Faspex performs a package relay from node2 to node3 and node4.
  3. 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 mailbox node2 (share_id: 2)
recipient_user1 Received mailbox node3 (share_id: 3)
recipient_user2 Received mailbox node4 (share_id: 4)
recipient_user3 Received mailbox 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.