Export
Introduction
Exports are an essential aspect of our platform to retrieve previously ingested objects by the https://mediahaven.atlassian.net/wiki/spaces/CS/pages/3263102987. Exports can be requested
The normal form of export is through https://mediahaven.atlassian.net/wiki/spaces/CS/pages/3182101827 in the MediaHaven 2.0 front-end
API users can interact with the https://mediahaven.atlassian.net/wiki/spaces/CS/pages/2447769640 to export records
Name of an export
A user can optionally define a name for the export. If not defined, the filenameExpression
on the export location will be used to determine the name. See below for more info. When the expression yields a runtime error on evaluation, the original filename of the record is used. Other rules are:
illegal characters are replaced by a
-
if the name exceeds the limit of 255 characters, the name is truncated
Export locations
Export locations are predefined locations where objects can be exported to and have the following important properties
URI (protocol, server, credentials, path, etc)
Where to send the export, for example using
FTPS
orS3
Export options
Image
Document
Video
Audio
Metadata
Users require the function ADMIN_EXPORT_LOCATION
to manage export locations.
Export Options
Export options define additional transformations on the export files. If an export option is predefined on an export location, that option can not be removed or modified on the export request.
Option | Usage |
---|---|
Metadata | Metadata can either be added as
|
Video | Transform the content into a video with particular transcoding options |
Audio | Transform the content into an audio with particular transcoding options |
Image | Transform the content into an image with with particular transcoding options |
Document | Transform the content into a PDF with with particular transcoding options |
See the for a complete overview of all properties which can be added to the export options for both exports and export locations.
Filename Expression 24.3
In version 24.3
a new property FilenameExpression
is introduced that allows the user to dynamically determine the filename of an export by using metadata expressions. The structure of these expressions is the same as for . You can find more info there.
The only difference from batches is that in this case, the input is a string instead of a sidecar. Consequently, the allowed fields are slightly different from those in batches:
Level | Case | Effect | Example Expression | Example Output |
---|---|---|---|---|
Top | SimpleField | String |
|
|
Top | Others
| Not allowed |
|
|
Sub | Child of MapField | String |
|
|
Sub | Other | Not allowed |
|
|