...
An export location is a re-usable and savable configuration to create exports. These exports can either be to your computer (a download) or to an external location (e.g. YouTube). It shares a lot of its configuration with export jobs.
Business Logic
General information
Property | Description | Engine validation | Frontend validation | ||||
---|---|---|---|---|---|---|---|
Id | / | / |
| ||||
Name | / | / | / | ||||
Unique folder | Whether each export to this location creates a unique subfolder for the export |
|
| ||||
Http URL | The (internal) url on which the export will be accessible |
|
| ||||
Export downloadable | Whether the result of the export can be downloaded If true, the export location will show up in MediaHaven under the download action. If false, the export location will show up in MediaHaven under the 'export to location' action |
|
| ||||
Export reasons required | Whether an export reason is required to initiate an export | / | / | ||||
Custom export reason allowed | Whether a custom (free-text) reason is allowed in addition to the supplied list |
|
| ||||
Default export location | Whether the export location is the default export location | / |
| ||||
Priority | / |
|
| ||||
Storage Type | The type of storage. This is a Frontend only construct | / |
| ||||
Storage pool id | The id of the storage pool. |
|
| ||||
Server address | The server address |
|
| ||||
Protocol | The server protocol. |
|
| ||||
Port | The port of the server |
|
| ||||
Path | The server path | / |
| ||||
Username | The server username. Filling it in will overwrite the existing value. | / |
| ||||
Password | The server password. Filling it in will overwrite the existing value. |
|
| ||||
Filename expression | Expression that will provide the filename of the export. You can make this very complex, but generally will be of the form:
Apostrophes included. |
|
| ||||
Temporary path | The temporary location path. | / | / | ||||
Temporary filename | The temporary filename + extension. | / | / |
Export Options
Export image options
Property | Description | Engine validation | Frontend validation | ||||
---|---|---|---|---|---|---|---|
Height | The height in pixels an exported image will have. If not defined, the original height will be used. |
|
| ||||
Width | The width in pixels an exported image will have. If not defined, the original width will be used. |
|
| ||||
Container | The export container format, defaults to JPG when transforming and not explicitly set. | / |
| ||||
Color space | The color space of the export, defaults to sRGB when transforming and not explicitly set. |
| |||||
Rotation | The rotation of the image, in degrees |
|
| ||||
Flip | Flip the image horizontal / vertical | / |
| ||||
Cropping (top, bottom, left, right) | The offset to crop the image. |
|
| ||||
Watermark source | The source of the watermark applied by the transformation. | / | / | ||||
Watermark scale | The scale of the watermark. |
|
| ||||
Watermark opacity | The opacity of the watermark. |
|
| ||||
Watermark position | The position of the watermark. | / |
|
...
Property | Description | Engine validation | Frontend validation | ||||
---|---|---|---|---|---|---|---|
Height | The height in pixels an exported document will have. If not defined, the original height will be used. |
|
| ||||
Width | The width in pixels an exported document will have. If not defined, the original width will be used. |
|
| ||||
Container | The export container format, defaults to JPG when transforming and not explicitly set. | / |
| ||||
Color space | The color space of the export, defaults to sRGB when transforming and not explicitly set. |
| |||||
Watermark source | The source of the watermark applied by the transformation. | / | / | ||||
Watermark scale | The scale of the watermark. |
|
| ||||
Watermark opacity | The opacity of the watermark. |
|
| ||||
Watermark position | The position of the watermark. | / |
|
Export partial options
This option cannot be specified beforehand on an export location but can be specified on demand when requesting the export.
Property | Description | Engine validation |
---|---|---|
Type | Enum. Values: Frames, Bytes | |
Start | The start of the partial, specified in frames or bytes. This point is included in the interval. |
|
End | The end of the partial, specified in frames or bytes. This point is excluded from the interval. |
|
Export metadata options
Property | Description | Engine validation | Frontend validation |
---|---|---|---|
Type | If set, defines define how record metadata is exported. |
| |
Format | The sidecar format |
|
|
Only metadata | If true, only metadata will be exported. |
|
|
Metadata translation id | The id of a metadata translation |
|
|
User options
Property | Description | Engine validation | Frontend validation |
---|---|---|---|
Allowed for all users | Whether the export location is allowed for all users of own organisation. | / | / |
Allowed for all organisations | Whether the export location is allowed for all users of own organisation. | / | / |
Explicitly assigned users | Users that have received explicit access to the export location. |
|
|
Context (Readonly)
Property | Description |
---|---|
IsEditable | Whether the export location is editable. False if the user does not have the required functions. |
AreOptionsEditable | Whether the options of the export location are editable. False for default export locations or if the user does not have the required functions. |
IsDeletable | Whether the export location is deletable. False for default export locations or if the user does not have the required functions. |