...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Warning |
|---|
This release is currently under development and content of this page is subject to change without notice. |
...
MediaHaven has a wide variety of metadata fields. This table list various information about these fields.
Legend
- Key / Sub Key: The name of the field as it appears the metadata XML and JSON
- Format: extra information about the format of the value, see Metadata Concepts for more information about the used terms
- Read-only: This field cannot be modified in the user interface or API calls
- Search: When performing a search query APIs you must use the flattened key, for example
+Title:"Breaking News!" +KeywordsKeyword:Politics - Searchable: In the MediaHaven REST API you can search and sort on thie field
Descriptive Fields
Descriptive fields are modifiable fields that describe files for purposes such as discovery.
Administrative Fields
| Anchor |
|---|
| Administrative |
|---|
| Administrative |
|---|
|
Administrative Fields are human readable read-only fields which are used for managing and preserving files in MediaHaven.
| Key | DigiHaven / MediHaven 2.0 | Description | Format | Read-only | Searchable |
|---|
OrganisationName |
| The name of the organisation to which the file belongs |
 |
LastModifiedDate |
| The date and time when the file was last edited | ISO-8601 |
|
|
| The ID of the file in an external platform. This field is only for advanced installations. |
|
ArchiveDate |
| The date and time the file was ingested | yyyy:MM:dd HH:mm:ss |
|
Type |
| The type of the file (e.g. image, document, page, image, layer, newspaperpage, article, video, videofragment, audio, audiofragment, set, collection, newspaper, metadataonly) |
|
DepartmentName |
| The name of the department that published the file |
|
Workflow |
| Describes through which workflow a file was ingested (if applicable) |
|
IngestTape |
| Describes on which ingest tape the file was provided (if applicable) |
|
IsSynchronized |
| Indicates whether or not this file or fragment has been synchronized from another MediaHaven. | 0 or 1 |
|
ExternalUrl |
| When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven. | URL |
|
|
IsOriginal |
| Indicates if the file is an original file | 0 or 1 |
|
IsPreservation | Yes | Indicates if the file is valid for preservation means | 0 or 1 |
|
IsAccess | Yes | Indicates if the file is valid for access means | 0 or 1 |
|
RecordType | Yes | The type of the record. |
|
RecordStatus | Yes | The status of the record (e.g. but not limited to New or Published) |
|
OrganisationExternalId |
| External id of the organisation to which the file belongs. |
| |
|
OrganisationLongName |
| The full name of an organisation including white space and punctuation |
Technical Fields
Technical fields are predominantly read-only fields whose values are inherent to data file itself. (Re)-ingesting the file, possibly in a different MediaHaven, will result in exactly the same values.
Common
Time codes
Video
MXF Video
Internal Fields
Internal fields are read-only metadata fields proper to MediaHaven and often not a human readable format opposed to the administrative fields.
Browses
| Key | Sub Key #1 | Sub Key #2 | Description | Remark | Read-only |
|---|
Browses |
|
| List of browse formats generated for the file | ComplexField |
|
Browses | Browse |
| Description of a single browse format of the file | MapField |
|
Browses | Browse | Label | Unique label of this browse format |
| |
Browses | Browse | Container | Extension of the container of this browse, e.g. jpg, mp4 |
| |
Browses | Browse | BaseUrl | URL to the path containing the files associated with this browse format |
| |
Browses | Browse | PathToKeyframe | Relative path to the main still image of the file. Prefix with BaseUrl to obtain the complete URL. |
| |
Browses | Browse | PathToKeyframeThumb | Relative path to the main still image of the file (thumb version). Prefix with BaseUrl to obtain the complete URL. |
| |
Browses | Browse | PathToVideo | Relative path to the video preview of the file. Prefix with BaseUrl to obtain the complete URL. |
| |
Browses | Browse | FileSize | File size of the PathToVideo for audio / video or PathToKeyframe for other content. | bytes |
|
Browses | Browse | Width | Width of the preview (PathToKeyframe) | pixels |
|
Browses | Browse | Height | Height of the preview (PathToKeyframe) | pixels |
|
Browses | Browse | ... | All keys available under the item #Video on this same page |
Distributions
| Anchor |
|---|
| Distributions |
|---|
| Distributions |
|---|
|
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Distributions |
| List of distribution channels where the file has been distributed to | ListField |
|
|
Distributions | Distribution | Provides information about a single channel in the form of <protocol>:<ID>, e.g. jwplayer:bZZVWxol | protocol:id |
Workflows
| Key | Sub Key | Sub Key #2 | Description | Remark | Read-only | Searchable |
|---|
| Tasks |
|
| List of tasks active for this record | ComplexField |
|
|
| Tasks | Task |
| Provides information about a single task | MapField |
|
|
| Tasks | Task | Id | Unique ID of this task | SimpleField |
|
|
| Tasks | Task | TypeName | Type of task (human readable) | SimpleField |
|
| Tasks | Task | TypeId | Type of task | SimpleField |
|
| Tasks | Task | ProcessName | Name of the process this task belongs to | SimpleField |
|
| Tasks | Task | ProcessId | The ID of the process this task belongs to | SimpleField |
|
| Tasks | Task | AssigneeUserId | ID of the assigned user | SimpleField |
|
| Tasks | Task | AssigneeUserLogin | Login of the assigned user | SimpleField |
|
| Tasks | Task | AssigneeFunction | Function necessary to complete this task | SimpleField |
|
| Tasks | Task | CreationDate | Date on which this task was created | DateField |
|
| Tasks | Task | DueDate | This task should be completed before this date | DateField |
Structural Fields
Structural fields provide how compound files such as collections are put together or how files are related between each other. Three categories exist: Fragments, Ensembles and Relations.
Fragments
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Fragments |
| Series of fragments belonging to this file. The main fragment which corresponds to the file itself (i.e. the entire video) is non contained in this series, hence this list is empty if the file contains no pure (= non main) fragments. | ListField |
|
|
Fragments | Fragment | Sub field of Fragments giving the FragmentId of each fragment this file contains | FragmentId |
|
|
MainFragment |
| For a pure fragment, this refers the FragmentId of main fragment. For the main fragment this field is empty. | SimpleField |
|
|
FragmentStartFrames |
| The start time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) |
| |
FragmentEndFrames |
| The end time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) |
| |
FragmentDurationFrames |
| The duration of a fragment, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) |
FragmentStartTimeCode
|
FragmentStartTimeCode |
| The start time of a fragment, relative to the start of the media file | HH:mm:ss.SSS
|
FragmentEndTimeCode
|
|
FragmentEndTimeCode |
| The end time of a fragment, relative to the start of the media file | HH:mm:ss.SSS
|
|
|
FragmentDurationTimeCode |
| The duration of a fragment | HH:mm:ss.SSS
|
Versioning
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Versioning |
| Provides structural information about the chain versions of the same logical file. Each record in the chain is a separate record itself with its own MediaObjectId / FragmentId. All records in the chain have the same Versioning > Id. | MapField |
|
|
Versioning | Status | Untracked for records without versioning, otherwise possible values are Draft, Head, Rejected, Tail. | EnumField |
|
Versioning | Id | Has the same value for an entire versioning chain; its value is the MediaObjectId of the first record in the chain (with Version = 1). | SimpleField |
|
Versioning | Version | Positional index in the chain of versions, starting from Version 1. | LongField |
Ensembles
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Collections |
| Series of collections the file belongs to | ListField |
|
|
Collections | Collection | Sub field of Collections providing the ID of an individual the collection the file belongs to |
|
Sets |
| Series of sets the file belongs to | ListField |
|
|
Sets | Set | Sub field of Sets providing the ID of an individual set the file belongs to |
|
Newspapers |
| Series of newspapers the file belongs to | ListField |
|
|
Newspapers | Newspaper | Sub field of Newspapers providing the ID of an individual newspaper the file belongs to |
Relations
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Relations |
| Series of files related with this file. Depending on your installation different sub fields of Relations might be defined. | MultiItemField |
|
|
Relations | PreviousVersion | Sub field of Relations providing the FragmentId of an individual file which is the previous version of this file | FragmentId |
|
Relations | NextVersion | Sub field of Relations providing the FragmentId of an individual file which is the next version of this file | FragmentId |
|
Relations | Contains | Sub field of Relations providing the FragmentId of an individual file which this file contains | FragmentId |
|
Relations | ContainedBy | Sub field of Relations providing the FragmentId of an individual file that contains this file | FragmentId |
|
Relations | Associated | Sub field of Relations providing the FragmentId of an individual file which is associated with this file | FragmentId |
Rights Management Fields
| Anchor |
|---|
| RightsManagement |
|---|
| RightsManagement |
|---|
|
Rights management fields provide information about who can access, edit or export files.
| Key | Sub Key | Description | Remark | Read-only | Searchable |
|---|
Permissions |
| The different permissions associated with the file | MultiItemField |
|
|
Permissions | Read | Sub field of Permissions providing ID of a user group with read rights | UUID |
| |
Permissions | Write | Sub field of Permissions providing ID of a user group with write rights | UUID |
| |
Permissions | Export | Sub field of Permissions providing ID of the user groups with export rights | UUID |
| |
ExpiryDate |
| The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations. | yyyy:MM:dd HH:mm:ss |
| |
ExpiryStatus |
| Whether or not the file is expired. This field is only for advanced installations. |
Changelog
Changes versus /wiki/spaces/CS/pages/1595408491
- New administrative fields
RecordStatus - Removed column sortable because all searchable fields are now sortable
- New metadata family
Workflows and its first field Tasks