Metadata 18.1

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	Description	Format	Search	Sidecar (xpath)
`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`
`KeywordsKeyword`	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`
`CategoriesCategory`	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`
`AddressFormatted`	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`
`PublicationsComment`	Sub field of `Publications` describing a comment		`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)
`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`
`ExternalId`	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`

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.

Key	Description	Format	Search	Sidecar (xpath)	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	high, medium or low	`ImageQuality`	`Technical/ImageQuality`
`ImageOrientation`	The orientation of the image	panorama (aspect >= 2) landscape (2 > aspect >= 1.1) square (1.1 >= aspect > 0.9) portrait (0.9 >= aspect > 0.5) strip (aspect < 0.5)	`ImageOrientation`	`Technical/ImageOrientation`
`VideoTechnical`	Description of the video codec in the media file		`VideoTechnical`	`Technical/VideoTechnical`
`AudioTechnical`	Description of the audio codec in the media file		`AudioTechnical`	`Technical/AudioTechnical`
`VideoFormat`	The format of the video (e.g. IMX 30i SD, XDCAMHD)		`VideoFormat`	`Technical/VideoFormat`
`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	`MediaObjectStartTimeCode`	`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	`MediaObjectFragmentStartTimeCode`	`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`

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)
`MediaObjectId`	The unique identifier of the file	64 characters	`MediaObjectId`	`Internal/MediaObjectId`
`FragmentId`	The unique identifier of the fragments of the file	96 characters	`MediaObjectFragmentId`	`Internal/FragmentId`
`TransferStatus`	If the value is 1016 the file is processed If the value is < 1016, the file is being processed		`MediaObjectStatus`	`Internal/TransferStatus`
`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`
`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 document, 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`

Structural Fields

Structural fields provide how compound files such as collections are put together or how files are related between each other.

Key	Description	Remark	Search	Sidecar (xpath)
`Collections`	Series of collections the file belongs to	ListField	search using the sub field	`Structural/Collections`
`ColllectionsCollection`	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`
`SetsSet`	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`
`NewspapersNewspaper`	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`
`RelationsPreviousVersion`	Sub field of `Relations` providing the `FragmentId` of an individual file which is the previous version of this file	FragmentId	`RelationsPreviousVersion`	`Structural/Relations/NextVersion`
`RelationsNextVersion`	Sub field of `Relations` providing the `FragmentId` of an individual file which is the next version of this file	FragmentId	`RelationsNextVersion`	`Structural/Relations/PreviousVersion`
`RelationsContains`	Sub field of `Relations` providing the `FragmentId` of an individual file which this file contains	FragmentId	`RelationsContains`	`Structural/Relations/Contains`
`RelationsContainedBy`	Sub field of `Relations` providing the `FragmentId` of an individual file that contains this file	FragmentId	`RelationsContainedBy`	`Structural/Relations/ContainedBy`
`RelationsAssociated`	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	Description	Remark	Search	Sidecar (xpath)
`Permissions`	The different permissions associated with the file	MultiItemField	search using the sub fields	`Structural/Permissions`
`PermissionsRead`	Sub field of `Permissions` providing ID of a user group with read rights	UUID	`PermissionsRead`	`Structural/Permissions/Read`
`PermissionsWrite`	Sub field of `Permissions` providing ID of a user group with write rights	UUID	`PermissionsWrite`	`Structural/Permissions/Write`
`PermissionsExport`	Sub field of `Permissions` providing ID of the user groups with export rights	UUID	`PermissionsExport`	`Structural/Permissions/Export`

Changelog

Changes versus Metadata 17.3:

Changed the following search keys (the old keys are still accepted by the MediaHaven REST API).
- MediaObjectFragmentTitleSort → MediaObjectFragmentTitle
- MediaObjectOriginalFilenameSort → MediaObjectFragmentOriginalFilename
Renamed the key Rights_Owner to RightsOwner (the old key is still accepted by the REST API)
Renamed in the descriptive field Authors the sub key auteur to Author
New descriptive field Publications which contains a list of comments
The technical field OriginalFilename is no longer read-only but can be modified
New metadata family RightsManagement which details the permissions of the file
New descriptive fields
- KeywordsKeyword
- CategoriesCategory
- AuthorsAuthor
- Rights
- Address and AddressFormatted
- Location
- Authors
- NonPreferredTerm
New administrative fields
- ExpiryStatus
New technical fields
- OriginalExtension
- ImageQuality
- ImageOrientation