Versions Compared

Key

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

MediaHaven has a wide variety of metadata fields. This table list various information about these fields.

...

Descriptive fields are modifiable fields that describe files for purposes such as discovery.

Key

Sub Key

Description

Format

Read-only

Search

Title

The title of the file

(tick)

Description

Description about the file

(tick)

CreationDate

The date and time the file was originally created

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

RightsOwner

The name of the (copyright) owner of the file

Rights

A description about how the file can or can not be disseminated.

Keywords

Series of keywords about the file

ListField

Keywords

Keyword

Sub field of Keywords containing an individual keyword

(tick)

Categories

Series of categories about the file

ListField

Categories

Category

Sub field of Categories containing an individual category

(tick)

Publisher

Publisher of the file

Authors

A list of various authors of the file

MulitItemField

AuthorsAuthor

Sub field of Authors containing an individual author

(tick)

Publications

List of locations where the file is published

ListField

Publications

Comment

Sub field of Publications describing a comment

OriginalFilename

The name of the file as it was ingested into MediaHaven

(tick)

UploadedBy

The name of the user that uploaded the file

(tick)

KeyframeStart


By default the the field PathToKeyframe refers to the closest keyframe before to time provided by the field FragmentStart. When KeyframeStart is defined it overrides this time.

frames (using a fictitious 25 fps)

(tick)

...

Key

Description

Format

Read-only

Search

OrganisationName

The name of the organisation to which the file belongs

(tick)

(tick)

LastModifiedDate

The date and time when the file was last modified by any user, including by the system under the hood

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

(tick)

UserLastModifiedDate

The date and time when the file was last edited by non system user. System users are used by process and customer support users.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

(tick)

ExternalId

The ID of the file in an external platform. This field is only for advanced installations.

(tick)

(tick)

ArchiveDate

The date and time the file was ingested

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

(tick)

Type

The type of the file (e.g. image, document, page, image, layer, newspaperpage, article, video, videofragment, audio, audiofragment, set, collection, newspaper, metadataonly)

(tick)

(tick)

DepartmentName

The name of the department that published the file

(tick)

(tick)

Workflow

Describes through which workflow a file was ingested (if applicable)

(tick)

(tick)

IngestTape

Describes on which ingest tape the file was provided (if applicable)

(tick)

(tick)

IsSynchronized

Indicates whether or not this file or fragment has been synchronized from another MediaHaven.

0 or 1

(tick)

(tick)

ExternalUrl

When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven.

URL

(tick)

IsOriginal

Indicates if the file is an original file

0 or 1

(tick)

(tick)

IsPreservation

Indicates if the file is valid for preservation means

0 or 1

(tick)

(tick)

IsAccess

Indicates if the file is valid for access means

0 or 1

(tick)

(tick)

RecordType

The type of the record. 

(tick)

(tick)

RecordStatus

The status of the record (e.g. but not limited to New or Published)

(tick)

(tick)

OrganisationExternalId

External id of the organisation to which the file belongs.

(tick)

OrganisationLongName

The full name of an organisation including white space and punctuation 

(tick)

(tick)

PublicationDate

The date and time the file was published

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

(tick)

DeleteStatus

Indicates if the record is deleted, and if so whether it’s been deleted logically or permanently.

  • NotDeleted

  • LogicallyDeleted

  • PermanentlyDeleted

(tick)

(tick)

LogicalDeletionDate

The time the record was logically deleted.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

(tick)

(tick)

ChildOrderFields

Key

Sub Key
#1

Sub Key #2

Description

Format

Read-only

Search

ChildOrderFields

The sort order the children of the record should be retrieved in.

ComplexListField

(tick)

ChildOrderFields

Field

A single sort field.

MapField

(tick)

ChildOrderFields

Field

DottedKey

The dotted key of a sortable field definition.

SimpleField

(tick)

ChildOrderFields

Field

Direction

The direction to sort the fields in.

Possible values are:

  • Asc

  • Desc

EnumField

(tick)

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

Read-only

Search

Since

OriginalExtension

The extension of the file as it was ingested into MediaHaven

(tick)

(tick)

FileSize

The size of the file in bytes

(tick)

(tick)

Md5

The MD5 checksum of the file

(tick)

(tick)

MimeType

The mime type of the file, e.g. image/jpg

(tick)

(tick)

PronomId

The Pronom ID is a file identification mechanism developed by the National Archives 

(tick)

(tick)

Width

The width of the file

pixels

(tick)

(tick)

Height

The height of the file

pixels

(tick)

(tick)

ImageSize

Width times height, e.g 1920x1080

pixels times pixels

(tick)

(tick)

ImageQuality

The quality of the image

  • high

    • image: 1920x1200

    • video: 1280x720)

  • medium

    • image: 1024x768

    • video: 720x540)

  • low

(tick)

(tick)

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)

(tick)

(tick)

Exif

Contains all EXIF metadata extracted from the file, see Metadata Mining for a non exhaustive list of extracted properties

MapField

(tick)

21.3

...

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.

Record Tree

Key

Sub Key

Description

Remark

Read-only

Search

ReferenceCodes

Contains the full line of ancestors. More info Record Tree

ComplexField

(tick)

(tick)

ReferenceCodes

Record

SimpleField

(tick)

(tick)

ReferenceTitles

Contains the titles of the full line of ancestors.

ComplexField

(tick)

(tick)

ReferenceTitles

Record

SimpleField

(tick)

(tick)

ParentRecordId

If the record has a parent record, this value contains the RecordId of that parent.

SimpleField

(tick)

(tick)

HasChildren

If record has or had children in at least one point in time this will field be forever true

BooleanField

(tick)

(tick)

Fragments

Key

Sub Key

Description

Remark

Read-only

Search

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

(tick)

Fragments

Fragment

Sub field of Fragments giving the FragmentId of each fragment this file contains

FragmentId

(tick)

MainFragment

For a pure fragment, this refers the FragmentId of main fragment. For the main fragment this field is empty.

SimpleField

(tick)

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)

(tick)

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)

(tick)

FragmentDurationFrames

The duration of a fragment, expressed in frames against a fictitious 25 frames per second

frames
(using a fictitious 25 fps)

(tick)

FragmentStartTimeCode

The start time of a fragment, relative to the start of the media file

HH:mm:ss.SSS

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

(tick)

Versioning

Key

Sub Key

Description

Remark

Read-only

Search

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

(tick)


Versioning

Status

Untracked for records without versioning, otherwise possible values are Draft, Head, Rejected, Tail.

EnumField

(tick)

(tick)

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

(tick)

(tick)

Versioning

Version

Positional index in the chain of versions, starting from Version 1.

LongField

(tick)

(tick)

Ensembles

Key

Sub Key

Description

Remark

Read-only

Search

Collections

Series of collections the file belongs to

ListField

(tick)

Collections

Collection

Sub field of Collections providing the ID of an individual the collection the file belongs to

(tick)

(tick)

Sets

Series of sets the file belongs to

ListField

(tick)

Sets

Set

Sub field of Sets providing the ID of an individual set the file belongs to

(tick)

(tick)

Newspapers

Series of newspapers the file belongs to

ListField

(tick)

Newspapers

Newspaper

Sub field of Newspapers providing the ID of an individual newspaper the file belongs to

(tick)

(tick)

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

(tick)

Relations

NextVersion

Sub field of Relations providing the FragmentId of an individual file which is the next version of this file

FragmentId

(tick)

Relations

Contains

Sub field of Relations providing the FragmentId of an individual file which this file contains

FragmentId

(tick)

Relations

ContainedBy

Sub field of Relations providing the FragmentId of an individual file that contains this file

FragmentId

(tick)

Relations

Associated

Sub field of Relations providing the FragmentId of an individual file which is associated with this file

FragmentId

(tick)

Relations

IsSuggestedFor

Points to a record for which a suggestion is made

FragmentId

(tick)

Relations

HasAsSuggestion

Points to a suggestion which is made for this record

FragmentId

(tick)

...