Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Changes versus Metadata 17.1:
    • Renamed family Standard Fields to family Descriptive Fields
    • Renamed family Read-Only Fields to family Administrative Fields: this family provides information to help manage a resource, such as when and how it was ingested, file type
    • The administrative fields are now also exposed in the export sidecar metadata under the tag Administrative
    • New administrative field Workflow: describes through which workflow a file was ingested (if applicable)
    • New administrative field IngestTape: describes on which ingest tape the file was provided (if applicable)
    • New technical field OriginalFilename (same meaning as before but now in the correct family Technical)
    • New family Structural Fields which describe the ensembles the file belongs to and the related files
    • New internal field DeparmentId: uuid of the department the file was published with, the administrative field DepartmentName provides the human readable name.
    • Newly exposed internal fields HasKeyframes, IsFragment and ContainsGeoData
    • The search keys have been renamed for:
      • Keywords: MediaObjectFragmentKeyword → MediaObjectFragmentKeywordsKeyword
      • Categories: MediaObjectFragmentcategory → MediaObjectFragmentCategoriesCategory

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

...

ProfileDescriptionFormatSearchSidecar (xpath)Read-onlySearchableSortable
TitleThe title of the file
MediaObjectFragmentTitleSorttitle
(tick)(tick)
DescriptionDescription about the file
MediaObjectFragmentScriptDescriptiondescription
(tick)
CreationDateThe date and time the file was originally createdEXIFMediaObjectFragmentCreationDateMDProperties/CreationDate
(tick)(tick)
Rights_OwnerThe name of the (copyright) owner of the file
MediaObjectFragmentrightsownerMDProperties/rights_owner


KeywordsSeries of keywords about the fileMultiItemMediaObjectFragmentKeyword MediaObjectFragmentKeywordsKeyword (individual value)keywords/keyword
(tick)
CategoriesSeries of categories about the fileMultiItemMediaObjectFragmentcategory MediaObjectFragmentCategoriescategory (individual value)MDProperties/categories/category

(tick)
PublisherPublisher of the file
N/AMDProperties/Publisher



Administrative Fields
Anchor
Administrative
Administrative

ProfileDescriptionFormatSearchSidecar (xpath)Read-onlySearchableSortable
OrganisationNameThe name of the organisation to which the file belongs
MediaObjectOwnerNameAdministrative/OrganisationName(tick)(tick)
LastModifiedDateThe date and time when the file was last editedISO-8601MediaObjectFragmentLastModifiedTimeAdministrative/LastModifiedDate(tick)(tick)(tick)

Anchor
ExternalId
ExternalId
ExternalId

The ID of the file in an external platform. This field is only for advanced installations.
MediaObjectExternalIdAdministrative/ExternalId(tick)(tick)
ExpiryDateThe date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations
MediaObjectExpiryDateAdministrative/ExpiryDate(tick)(tick)
ArchiveDateThe date and time the file was ingestedEXIFMediaObjectArchiveDateAdministrative/ArchiveDate(tick)(tick)(tick)
UploadedByThe name of the user that uploaded the file
MediaObjectUploadedByAdministrative/UploadedBy(tick)(tick)


TypeThe type of the file (e.g. video, audio, etc)

Image, Layer,
Document, Page,
VIdeo, VideoFragment,
Audio, AudioFragment,
Collection, Set, NewsPaper,
NewsPaperPage, MetadataOnly

MediaObjectTypeAdministrative/Type(tick)(tick)
DepartmentNameThe name of the department that published the file
MediaObjectFragmentDepartmentNameAdministrative/DepartmentName(tick)(tick)
WorkflowDescribes through which workflow a file was ingested (if applicable)
MediaObjectWorkflowAdministrative/Workflow(tick)(tick)
IngestTapeDescribes on which ingest tape the file was provided (if applicable)
MediaObjectIngestTapeAdministrative/IngestTape(tick)(tick)

Technical Fields
Anchor
Technical
Technical

Profile / Sidecar

DescriptionFormatSearchSidecar (xpath)Read-onlySearchableSortable
OriginalFilename The name of the file as it was ingested into MediaHaven
MediaObjectOriginalFilenameSortTechnical/OriginalFilename(tick)(tick)(tick)
FileSizeThe size of the file in bytes
MediaObjectFileSizeTechnical/FileSize(tick)(tick)(warning) yes, but lexicographically
Md5The MD5 checksum of the file
MediaObjectMd5Technical/Md5(tick)
(tick)
MimeTypeThe mime type of the file, e.g. image/jpg
MediaObjectMimeTypeTechnical/MimeType(tick)(tick)
WidthThe width of the filepixelsImageWidthTechnical/Width(tick)(tick)(warning) yes, but lexicographically
HeightThe height of the filepixelsImageHeightTechnical/Height(tick)(tick)(warning) yes, but lexicographically
ImageSizeWidth times height, e.g 1920x1080pixels times pixelsImageSizeTechnical/ImageSize(tick)(tick)
VideoTechnicalDescription of the video codec in the media file
VideoTechnicalTechnical/VideoTechnical(tick)(tick)
AudioTechnicalDescription of the audio codec in the media file
AudioTechnicalTechnical/AudioTechnical(tick)(tick)
VideoFormatThe format of the video (e.g. IMX 30i SD, XDCAMHD)
VideoFormatTechnical/VideoFormat(tick)(tick)
DurationTimeCodeThe duration of the media fileHH:mm:ss.SSSMediaObjectDurationTimeCodeTechnical/DurationTimeCode(tick)

StartTimeCodeThe start time of the media fileHH:mm:ss.SSS
MediaObjectStartTimeCode
Technical/StartTimeCode(tick)

EndTimeCodeThe end time of the media fileHH:mm:ss.SSS
MediaObjectEndTimeCode
Technical/EndTimeCode(tick)

FragmentDurationTimeCodeThe duration of the a fragmentHH:mm:ss.SSS
MediaObjectFragmentDurationTimeCodeTechnical/FragmentDurationTimeCode(tick)

FragmentStartTimeCodeThe start time of a fragment, relative to the start of the media fileHH:mm:ss.SSS
MediaObjectFragmentStartTimeCode
Technical/FragmentStartTimeCode(tick)


FragmentEndTimeCodeThe end time of a fragment, relative to the start of the media fileHH:mm:ss.SSS
MediaObjectFragmentEndTimeCode
Technical/FragmentEndTimeCode


FragmentStartFramesThe start time of a fragment, expressed in frames against a fictitious 25 frames per secondintegerMediaObjectFragmentStartTechnical/FragmentStartFrames
(tick)(tick)
FragmentEndFramesThe end time of a fragment, expressed in frames against a fictitious 25 frames per secondintegerMediaObjectFragmentEndTechnical/FragmentEndFrames


FragmentDurationFramesThe duration of a fragment, expressed in frames against a fictitious 25 frames per secondintegerMediaObjectFragmentDurationTechnical/FragmentDurationFrames(tick)

Internal Fields
Anchor
Internal
Internal

Profile / SidecarDescriptionRemarkSearchSidecar (xpath)Read-onlySearchableSortable

Anchor
MediaObjectId
MediaObjectId
MediaObjectId

The unique identifier of the file64 charactersMediaObjectIdInternal/MediaObjectId(tick)

Anchor
FragmentId
FragmentId
FragmentId

The unique identifier of the fragments of the file96 charactersMediaObjectFragmentIdInternal/FragmentId(tick)(tick)
TransferStatus
  • If the value is 1016 the file is processed
  • If the value is < 1016, the file is being processed

MediaObjectStatusInternal/TransferStatus(tick)(tick)
ArchiveStatusThe possible values are documented here: Ingest Monitoring
MediaObjectArchiveStatusInternal/ArchiveStatus(tick)(tick)
OrganisationIdThe ID of the organisation to which the file belongs to. The administrative field OrganisationName provides the human readable name.
MediaObjectOwnerInternal/OrganisationId(tick)(tick)
IngestSpaceIdThe ID of the ingest space the file belongs or belonged toUUIDMediaObjectFragmentingestspacenameInternal/IngestSpaceId(tick)(tick)
IsInIngestSpaceWhether the file still belongs to an ingest space0 or 1MediaObjectFragmentisiningestspaceInternal/IsInIngestSpace(tick)(tick)
DepartmentIduuid of the department the file was published with, the administrative field DepartmentName provides the human readable name.UUIDMediaObjectDepartmentIdInternal/DepartmentId(tick)(tick)
IsFragmentIndicates 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 1MediaObjectFragmentisfragmentInternal/IsFragment(tick)

HasKeyframesIndicates whether or not the the file has a series of keyframes (applicable to document, multi-page images, video and audio)0 or 1MediaObjectHasKeyframesInternal/HasKeyframes(tick)

ContainsGeoDataIndicates whether or not the file has geolocation data associated to it0 or 1MediaObjectFragmentContainsGeoDataInternal/ContainsGeoData(tick)(tick)

Structural Fields

ProfileDescriptionRemarkSearchSidecar (xpath)Read-onlySearchableSortable
CollectionsSeries of collections the file belongs toMultivaluedCollectionStructural/Collections(tick)(tick)
SetsSeries of sets the file belongs toMultivaluedSetStructural/Sets(tick)(tick)
NewspapersSeries of newspaper the file belongs toMultivaluedNewspaperStructural/Newspapers(tick)(tick)
RelationsSeries of files related with this file
MediaObjectFragmentRelationsStructural/Relations(tick)