Metadata 18.3
MediaHaven has a wide variety of metadata fields. This table list various information about these fields.
Legend
- Profile: If you fill this value out in a MediaHaven Profile this metadata will appear in the user interface
- Search / Searchable / Sortable: In the MediaHaven REST API you can search for it using this value if it is searchable and optionally sort the results (sortable).
- Read-only: This field cannot be modified in the user interface or API calls
Descriptive Fields
Descriptive fields are modifiable fields that describe files for purposes such as discovery.
Key | Sub Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable | Harvested from file |
---|---|---|---|---|---|---|---|---|---|
Title | The title of the file | MediaObjectFragmentTitle | title | ||||||
Description | Description about the file | MediaObjectFragmentScriptDescription | description | ||||||
CreationDate | The date and time the file was originally created | EXIF | MediaObjectFragmentCreationDate | MDProperties/CreationDate | |||||
RightsOwner | The name of the (copyright) owner of the file | MediaObjectFragmentrightsowner | MDProperties/RightsOwner | ||||||
Rights | A description about how the file can or can not be disseminated. | MDProperties/Rights | |||||||
Keywords | Series of keywords about the file | ListField | search using the sub field | keywords | |||||
Keywords | Keyword | Sub field of Keywords containing an individual keyword | MediaObjectFragmentKeywordsKeyword | keywords/keyword | |||||
Categories | Series of categories about the file | ListField | search using the sub field | MDProperties/Categories | |||||
Categories | Category | Sub field of Categories containing an individual category | MediaObjectFragmentCategoriesCategory | MDProperties/Categories/Category | |||||
Publisher | Publisher of the file | MDProperties/Publisher | |||||||
Authors | A list of various authors of the file | MulitItemField | search using the sub fields | MDProperties/Authors | |||||
AuthorsAuthor | Sub field of Authors containing an individual author | MediaObjectFragmentAuthorsAuthor | MDProperties/Authors/Author | ||||||
Address | Address of corresponding with the Location | MulitItemField | search using the sub field | MDProperties/Address | |||||
Address | Formatted | Sub field of Address describing the full address in a single line, e.g. Trump Tower, 725 5th Ave, New York, NY 10022, Verenigde Staten | MediaObjectFragmentaddress | MDProperties/Address/Formatted | |||||
Location | GPS coordinates corresponding with the Address | MediaObjectFragmentlocation | MDProperties/Location | ||||||
Publications | List of locations where the file is published | ListField | search using the sub field | MDProperties/Publications | |||||
Publications | Comment | Sub field of Publications describing a comme | MediaObjectFragmentPublicationsComment | MDProperties/Publications/Comment |
Administrative Fields
Administrative Fields are human readable read-only fields which are used for managing and preserving files in MediaHaven.
Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
OrganisationName | The name of the organisation to which the file belongs | MediaObjectOwnerName | Administrative/OrganisationName | ||||
LastModifiedDate | The date and time when the file was last edited | ISO-8601 | MediaObjectFragmentLastModifiedTime | Administrative/LastModifiedDate | |||
| The ID of the file in an external platform. This field is only for advanced installations. | MediaObjectExternalId | Administrative/ExternalId | ||||
ExpiryDate | The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations. | MediaObjectExpiryDate | Administrative/ExpiryDate | ||||
ExpiryStatus | Whether or not the file is expired. This field is only for advanced installations. | MediaObjectFragmentExpiryStatus | Administrative/ExpiryStatus | ||||
ArchiveDate | The date and time the file was ingested | EXIF | MediaObjectArchiveDate | Administrative/ArchiveDate | |||
UploadedBy | The name of the user that uploaded the file | MediaObjectUploadedBy | Administrative/UploadedBy | ||||
Type | The type of the file (e.g. video, audio, etc) | MediaObjectType | Administrative/Type | ||||
DepartmentName | The name of the department that published the file | MediaObjectFragmentDepartmentName | Administrative/DepartmentName | ||||
Workflow | Describes through which workflow a file was ingested (if applicable) | MediaObjectWorkflow | Administrative/Workflow | ||||
IngestTape | Describes on which ingest tape the file was provided (if applicable) | MediaObjectIngestTape | Administrative/IngestTape | ||||
IsSynchronized | Indicates whether or not this file or fragment has been synchronized from another MediaHaven. | 0 or 1 | MediaObjectFragmentIsSynchronized | Administrative/IsSynchronized | |||
ExternalUrl | When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven. | URL | MediaObjectFragmentExternalUrl |
|
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
Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
OriginalFilename
| The name of the file as it was ingested into MediaHaven | MediaObjectOriginalFilename | Technical/OriginalFilename | ||||
OriginalExtension | The extension of the file as it was ingested into MediaHaven | MediaObjectOriginalExtension | Technical/OriginalExtension | ||||
FileSize | The size of the file in bytes | MediaObjectFileSize | Technical/FileSize | yes, but lexicographically | |||
Md5 | The MD5 checksum of the file | MediaObjectMd5 | Technical/Md5 |
| |||
MimeType | The mime type of the file, e.g. image/jpg | MediaObjectMimeType | Technical/MimeType | ||||
Width | The width of the file | pixels | ImageWidth | Technical/Width | yes, but lexicographically | ||
Height | The height of the file | pixels | ImageHeight | Technical/Height | yes, but lexicographically | ||
ImageSize | Width times height, e.g 1920x1080 | pixels times pixels | ImageSize | Technical/ImageSize | |||
ImageQuality | The quality of the image |
| ImageQuality | Technical/ImageQuality | |||
ImageOrientation | The orientation of the image |
| ImageOrientation | Technical/ImageOrientation |
Time codes
Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
DurationTimeCode | The duration of the media file | HH:mm:ss.SSS | MediaObjectDurationTimeCode | Technical/DurationTimeCode | |||
StartTimeCode | The start time of the media file | HH:mm:ss.SSS |
| Technical/StartTimeCode | |||
EndTimeCode | The end time of the media file | HH:mm:ss.SSS | MediaObjectEndTimeCode | Technical/EndTimeCode | |||
DurationFrames | The duration of the media file, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) | MediaObjectDurationFrames | Technical/DurationFrames | |||
StartFrames | The start time of the media file, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) | MediaObjectStartFrames | Technical/StartFrames | |||
EndFrames | The end time of the media file, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) | MediaObjectEndFrames | Technical/EndFrames | |||
FragmentDurationTimeCode | The duration of a fragment | HH:mm:ss.SSS | MediaObjectFragmentDurationTimeCode | Technical/FragmentDurationTimeCode | |||
FragmentStartTimeCode | The start time of a fragment, relative to the start of the media file | HH:mm:ss.SSS |
| Technical/FragmentStartTimeCode | |||
FragmentEndTimeCode | The end time of a fragment, relative to the start of the media file | HH:mm:ss.SSS | MediaObjectFragmentEndTimeCode | Technical/FragmentEndTimeCode | |||
FragmentDurationFrames | The duration of a fragment, expressed in frames against a fictitious 25 frames per second | frames (using a fictitious 25 fps) | MediaObjectFragmentDuration | Technical/FragmentDurationFrames | |||
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) | MediaObjectFragmentStart | Technical/FragmentStartFrames | |||
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) | MediaObjectFragmentEnd | Technical/FragmentEndFrames |
Video
Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
VideoCodec | Description about the video encoding of the file | VideoCodec | Technical/VideoCodec | ||||
VideoFps | Frames per second of the video in the file | frames per second (fps) | VideoCodec |
| |||
VideoBitRate | Average bit rate of the video in the file | bits per second (bps) | VideoBitRate |
| |||
AudioCodec | Description about the audio encoding of the file | AudioCodec |
| ||||
AudioChannels | Total number of audio channels in the flle | AudioChannels |
| ||||
AudioSampleRate | Sample rate of the audio tracks in the file | Hz | AudioSampleRate |
| |||
AudioBitRate | Total average bit rate of all audio tracks | bits per second (bps) | AudioBitRate |
| |||
BitRate | Total average bit rate of the container (includes video and audio) | bits per second (bps) | BitRate |
|
MXF Video
Key | Description | Format | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
Origin | Number of edit units to skip at the start of the source video codec before the logical of start of the essence | frames | Origin |
| |||
EssenceOffset | File offset to the first partition containing essence | bytes | EssenceOffset |
| |||
EditUnitByteSize |
| bytes | EditUnitByteSize |
| |||
RunIn | File offset to the first KLV in the file, typically 0 | bytes | RunIn |
| |||
FramesPerEditUnit | Number of frames per edit unit | frames | FramesPerEditUnit |
| |||
EditRate | Number of edit units per second, if FramesPerEditUnit is 1 this equals the VideoFps | fraction | EditRate |
| |||
IndexEditRate | Advanced MXF feature, stored for future usage | fraction | IndexEditRate |
|
Internal Fields
Internal fields are read-only metadata fields proper to MediaHaven and often not a human readable format opposed to the administrative fields.
Key | Description | Remark | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|
| The unique identifier of the file | 64 characters | MediaObjectId | Internal/MediaObjectId | |||
| The unique identifier of the fragment of the file | 96 characters | MediaObjectFragmentId | Internal/FragmentId | |||
OriginalStatus | Status of the validation and ingest of the file |
| MediaObjectOriginalStatus | Internal/OriginalStatus | |||
BrowseStatus | Status of the creation of the preview of the file |
| MediaObjectBrowseStatus | Internal/BrowseStatus | |||
ArchiveStatus | The possible values are documented here: Ingest Monitoring | MediaObjectArchiveStatus | Internal/ArchiveStatus | ||||
OrganisationId | The ID of the organisation to which the file belongs to. The administrative field OrganisationName provides the human readable name. | MediaObjectOwner | Internal/OrganisationId | ||||
IngestSpaceId | The ID of the ingest space the file belongs or belonged to | UUID | MediaObjectFragmentingestspacename | Internal/IngestSpaceId | |||
IsInIngestSpace | Whether the file still belongs to an ingest space | 0 or 1 | MediaObjectFragmentisiningestspace | Internal/IsInIngestSpace | |||
UploadedById | The user ID of the user that uploaded the file, the administrative field UploadedBy provides the human readable name. | UUID | MediaObjectUploadedById | Internal/UploadedById | |||
DepartmentId | uuid of the department the file was published with, the administrative field DepartmentName provides the human readable name. | UUID | MediaObjectDepartmentId | Internal/DepartmentId | |||
IsFragment | Indicates whether or not the file is the main fragment or non-main fragment (i.e. page of a document, videofragment of a video) | 0 or 1 | MediaObjectFragmentisfragment | Internal/IsFragment | |||
HasKeyframes | Indicates whether or not the the file has a series of keyframes (applicable to documents, multi-page images, video and audio) | 0 or 1 | MediaObjectHasKeyframes | Internal/HasKeyframes | |||
ContainsGeoData | Indicates whether or not the file has geolocation data associated to it | 0 or 1 | MediaObjectFragmentContainsGeoData | Internal/ContainsGeoData |
Browses
Key | Sub Key #1 | Sub Key #2 | Description | Remark | Search | Sidecar (xpath) | Read-only |
---|---|---|---|---|---|---|---|
Browses | List of browse formats generated for the file | ComplexField | Internal/Browses | ||||
Browses | Browse | Description of a single browse format of the file | MapField | Internal/Browses/Browse | |||
Browses | Browse | Container | Label of this browse format | Internal/Browses/Browse/Container | |||
Browses | Browse | BaseUrl | URL to the path containing the files associated with this browse format | Internal/Browses/Browse/BaseUrl | |||
Browses | Browse | PathToKeyframe | Relative path to the main still image of the file. Prefix with BaseUrl to obtain the complete URL. | Internal/Browses/Browse/ | |||
Browses | Browse | PathToKeyframeThumb | Relative path to the main still image of the file (thumb version). Prefix with BaseUrl to obtain the complete URL. | Internal/Browses/Browse/ | |||
Browses | Browse | PathToVideo | Relative path to the video preview of the file. Prefix with BaseUrl to obtain the complete URL. | Internal/Browses/Browse/ | |||
Browses | Browse | FileSize | File size of the PathToVideo for audio / video or PathToKeyframe for other content. | bytes | Internal/Browses/Browse/ | ||
Browses | Browse | Width | Width of the preview (PathToKeyframe) | pixels | Internal/Browses/Browse/ | ||
Browses | Browse | Height | Height of the preview (PathToKeyframe) | pixels | Internal/Browses/Browse/ | ||
Browses | Browse | ... | All keys available under the item #Video on this same page | Internal/Browses/Browse/... |
Distributions
Key | Sub Key | Description | Remark | Search | Sidecar (xpath) | Read-only | Searchable |
---|---|---|---|---|---|---|---|
Distributions | List of distribution channels where the file has been distributed to | ListField | Internal/Distributions | ||||
Distributions | Distribution | Provides information about a single channel in the form of <protocol>:<ID>, e.g. jwplayer:bZZVWxol | protocol:id | DistributionsDistribution | Internal/Distributions/Distribution |
Structural Fields
Structural fields provide how compound files such as collections are put together or how files are related between each other.
Key | Sub Key | Description | Remark | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|---|
Collections | Series of collections the file belongs to | ListField | search using the sub field | Structural/Collections | ||||
Colllections | Collection | Sub field of Collections providing the ID of an individual the collection the file belongs to | Collection | Structural/Collections/Collection | ||||
Sets | Series of sets the file belongs to | ListField | search using the sub field | Structural/Sets | ||||
Sets | Set | Sub fielf of Sets providing the ID of an individual set the file belongs to | Set | Structural/Sets/Set | ||||
Newspapers | Series of newspapers the file belongs to | ListField | search using the sub field | Structural/Newspapers | ||||
Newspapers | Newspaper | Sub field of Newspapers providing the ID of an individual newspaper the file belongs to | Newspaper | Structural/Newspapers/Newspaper | ||||
Relations | Series of files related with this file. Depending on your installation different sub fields of Relations might be defined. | MultiItemField | search using the sub fields | Structural/Relations | ||||
Relations | PreviousVersion | Sub field of Relations providing the FragmentId of an individual file which is the previous version of this file | FragmentId | RelationsPreviousVersion | Structural/Relations/NextVersion | |||
Relations | NextVersion | Sub field of Relations providing the FragmentId of an individual file which is the next version of this file | FragmentId | RelationsNextVersion | Structural/Relations/PreviousVersion | |||
Relations | Contains | Sub field of Relations providing the FragmentId of an individual file which this file contains | FragmentId | RelationsContains | Structural/Relations/Contains | |||
Relations | ContainedBy | Sub field of Relations providing the FragmentId of an individual file that contains this file | FragmentId | RelationsContainedBy | Structural/Relations/ContainedBy | |||
Relations | Associated | Sub field of Relations providing the FragmentId of an individual file which is associated with this file | FragmentId | RelationsAssociated | Structural/Relations/Associated |
Rights Management Fields
Rights management fields provide information about who can access, edit or export files.
Key | Sub Key | Description | Remark | Search | Sidecar (xpath) | Read-only | Searchable | Sortable |
---|---|---|---|---|---|---|---|---|
Permissions | The different permissions associated with the file | MultiItemField | search using the sub fields | Structural/Permissions | ||||
Permissions | Read | Sub field of Permissions providing ID of a user group with read rights | UUID | PermissionsRead | Structural/Permissions/Read | |||
Permissions | Write | Sub field of Permissions providing ID of a user group with write rights | UUID | PermissionsWrite | Structural/Permissions/Write | |||
Permissions | Export | Sub field of Permissions providing ID of the user groups with export rights | UUID | PermissionsExport | Structural/Permissions/Export |
Changelog
Changes versus Metadata 18.2:
- Added new
Internal
fieldBrowses
- Added new
Internal
field Distributions - Added new
Administrative
fieldsIsSynchronized
andExternalUrl