External Metadata Advanced 16.3

Introduction

Metadata can be provided to MediaHaven in the form of a metadata XML. The XML can be provided as a sidecar XML file or provided in a MediaHaven REST API. The basic version of the external metadata format can be found here: External Metadata Basic.

The following XSD validates the metadata:

Standard Fields

Sidecar (xpath)ProfileDescriptionFormat
titleTitleThe title of the file
descriptionDescriptionDescription about the file
md5Md5The MD5 checksum of the submitted file. If it mismatches with the calculated MD5 checksum during ingest, the file is rejected.
keywords/keywordKeywordsSeries of categories about the fileMultiItem
MDProperties/CreationDateCreationDateThe date and time the file was originally createdEXIF
MDProperties/rights_ownerRights_OwnerThe name of the (copyright) owner of the file
MDProperties/PublisherPublisherPublisher of the file
MDProperties/categories/categoryCategories
Series of keywords about the fileMultiItem
MDProperties/Authors/auteur
AuthorsSeries of authors of the fileMultItem
MDProperties/<any-tag><any-tag>

The user can provide his or her own custom tags as children of the tag MDProperties.

(warning) Namespaced tags are not allowed

(warning) It is forbidden to use MediaHaven reserved tags names inside MDProperties. The reserved fields include the following tags: type, title, description. The full list of the reserved fields in MediaHaven: Metadata Fields.


Advanced Fields

Sidecar (xpath)Description
Relations/<relation-type>/ExternalId

Define relations with this file as subject and the provided references as object by means of an ExternalId.

(warning) The object of the relation must already exist in MediaHaven with the provided ExternalId.

(warning) The provided relation type must have been configured in MediaHaven beforehand

(warning) Namespaced relation types are not allowed

fragments/fragment

To create fragments of videos or documents, you can provide a list of fragment children under the element fragments.

The fields below allow for providing some basic metadata fields to the created fragments.

fragments/fragment/original_start_z

The start position of the fragment in the file

  • In the case of video or audio: expressed in frames. Calculate the seconds relative to the start of the video, multiply by 25 and round to an integer. For example: 10.40s => 252
  • In the case of images or documents: the layer or page number, counted from 0.
fragments/fragment/original_end_z

The end position of the fragment in the file

  • In the case of video or audio: expressed in frames. Calculate the seconds relative to the start of the video, multiply by 25 and round to an integer. For example: 10.40s => 252
  • In the case of images or documents: no meaning
fragments/fragment/titleThe title of the new fragment
fragments/fragment/description
The description of the new fragment
fragments/fragment/keywords/keywordA list of keywords about the new fragment

Example

MediaHAVEN_external_metadata
<?xml version="1.0" encoding="UTF-8"?>
<MediaHAVEN_external_metadata name="example" version="1.0">
	<title>provided title</title>
    <description>provided description</description>
	<keywords>
    	<keyword>k1</keyword>
		<keyword>k2</keyword>
		<keyword>k3</keyword>
	</keywords>
	<md5>58e6cd8c4df7132f6ea146c4828fbd96</md5>	
    <MDProperties>		
        <Authors type="list">
            <auteur>Name of the author 1</auteur>
            <auteur>Name of the author 2</auteur>
        </Authors>
        <CreationDate>2012:11:10 13:14:15</CreationDate>
        <Categories type="list">
            <category>x</category>
            <category>y</category>
            <category>z</category>
        </Categories>
        <publisher></publisher>
 
		<!-- Customer extra metadata fields -->
        <intellectualEntity_localID>nieuws 19-09-94a</intellectualEntity_localID>
        <rights_RightsHolder>nieuws 19-09-94a</rights_RightsHolder>        
    </MDProperties>
  
    <!-- Advanced Fields-->
	<Relations>
   		<CroppedBy>
      		<ExternalId>8g8ff4372</ExternalId>
   		</CroppedBy>
		<IsPartOf>
    		<ExternalId>8g8ff3qh45</ExternalId>
   		</IsPartOf>
	</Relations>
    <fragments type="list">
        <fragment>
            <title>Interview Jan Bosmans</title>
            <description>JAN BOSMAN ONTMOET xxxx IN LONDEN</description>
            <original_start_z>1855</original_start_z>
            <original_end_z>8355</original_end_z>
            <keywords>
                <keyword>BOSMAN JAN</keyword>
                <keyword>INTERVIEW</keyword>
            </keywords>
        </fragment>
        <fragment> 
 	        ... 
 	    </fragment>
    </fragments>
</MediaHAVEN_external_metadata>