Faspex Metadata

Metadata refers to the additional information that an IBM Aspera Faspex user can send with a file package. For example, an admin can require that, when a user sends an audio-file package to a producer, the user must also specify the sample rate, bit depth, and compression of the package. The admin sets these requirements by creating a new metadata profile that can the admin can then apply to all new, normal packages or to individual dropboxes.

The Metadata Profiles (go to Server > Metadata) page displays any profiles you have previously created.

Metadata Example

In the example metadata file below, the Audio Details metadata profile contains the following fields:
  • Sample rate (text input field)
  • Bit Depth (option list that includes 8-bit, 16-bit and 24-bit)
  • Compression (text input field)
  • Date Created (date picker)


Applying Metadata Profiles

Admins choose which configured metadata profile to apply to new, normal packages or to individual dropboxes. Admins can choose to assign (none) as a metadata profile in cases where no metadata fields are required. For information about applying metadata profiles to normal packages, see Applying Metadata Profile to Normal Packages. For information about applying metadata profiles to dropboxes, see Creating a Dropbox.

Forwarding Packages with Metadata

When you forward a package, the original metadata is preserved in the Note field. The preserved metadata does not change even if the applied metadata profile has been changed. No new aspera-metadata.xml file is created, even if Save metadata to file is enabled for the metadata.

Faspex Metadata Reporting for IBM Aspera Console

If a Faspex instance is added to IBM Aspera Console as a managed node, Console monitors transfer details of transfers in Faspex. Custom metadata fields applied to normal packages or to dropboxes are included as metadata tags in the transfer details and as transfer cookies for Console to use in running reports.

A Faspex transfer cookie is formatted in the following way:

{"aspera": 
  {"faspex": 
    { "key1":"val1", … , "key3":"val3"}
  }
}
The corresponding JSON match value is shown below:
[aspera][faspex][key1]val1