Versions Compared

Old Version 4

changes.mady.by.user Alexis Rombaut

Saved on

compared with

New Version Current

changes.mady.by.user Johannes De Smedt (Unlicensed)

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

This release is currently under development and content of this page is subject to change without notice.

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

Searchable

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)

Address

Address of corresponding with the Location

MulitItemField

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

(tick)

(tick)

Location

GPS coordinates corresponding with the Address

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

Remark

Read-only

Searchable

MediaObjectIdRecordId

The unique identifier of the file

64 characters

(tick)Successor of the MediaObjectId field containing exactly the same value with MediaObjectId remaining in place for backwards compatibility.

64 characters

(tick)

(tick)

MediaObjectId

The unique identifier of the file

64 characters

(tick)

(tick)

FragmentId

The unique identifier of the fragment of the file

96 characters

(tick)

(tick)

OriginalStatus

Status of the validation and ingest of the file

  • in_progress: file is being processed

  • completed: file is successfully stored on storage

  • failed: ingest failed and the file is not succesfully stored on storage

(tick)

(tick)

BrowseStatus

Status of the creation of the preview of the file

  • in_progress: browse is being generated

  • completed: browse is successfully created

  • no_browse: no browse is created for this file type

  • cancelled: ingest failed before a browse was created

  • failed: browse could not be created

(tick)

(tick)

ArchiveStatus

The possible values are documented here: Ingest Monitoring

(tick)

(tick)

OrganisationId

The ID of the organisation to which the file belongs to. The administrative field OrganisationName provides the human readable name.


(tick)

(tick)

IngestSpaceId

The ID of the ingest space the file belongs or belonged to

UUID

(tick)

(tick)

IsInIngestSpace

Whether the file still belongs to an ingest space

0 or 1

(tick)

(tick)

UploadedById

The user ID of the user that uploaded the file, the administrative field UploadedBy provides the human readable name.

UUID

(tick)

(tick)

DepartmentId

uuid of the department the file was published with, the administrative field DepartmentName provides the human readable name.

UUID

(tick)

(tick)

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

(tick)

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

(tick)

ContainsGeoData

Indicates whether or not the file has geolocation data associated to it

0 or 1

(tick)

(tick)

Browses 

Key

Sub Key #1

Sub Key #2

Description

Remark

Read-only

Browses

List of browse formats generated for the file

ComplexField

(tick)

Browses

Browse

Description of a single browse format of the file

MapField

(tick)

Browses

Browse

Label

Unique Profiles

A list of profiles linked to this record, sorted by record type. Note that Mediahaven 1.0 profiles will not be added to this field.

MulitItemField

(tick)

(tick)

ProfilesAll

Profiles that can be used for records of any record type.

(tick)

(tick)

Browses 

Key

Sub Key #1

Sub Key #2

Description

Remark

Read-only

Browses

List of browse formats generated for the file

ComplexField

(tick)

Browses

Browse

Description of a single browse format of the file

MapField

(tick)

Browses

Browse

Label

Unique label of this browse format

(tick)

Browses

Browse

Container

Extension of the container of this browse, e.g. jpg, mp4

(tick)

Browses

Browse

BaseUrl

URL to the path containing the files associated with this browse format

(tick)

Browses

Browse

PathToKeyframe

Relative path to the main still image of the file. Prefix with BaseUrl to obtain the complete URL.

(tick)

Browses

Browse

PathToKeyframeThumb

Relative path to the main still image of the file (thumb version). Prefix with BaseUrl to obtain the complete URL.

(tick)

Browses

Browse

PathToVideo

Relative path to the video preview of the file. Prefix with BaseUrl to obtain the complete URL.

(tick)

Browses

Browse

FileSize

File size of the PathToVideo for audio / video or PathToKeyframe for other content.

bytes

(tick)

Browses

Browse

Width

Width of the preview (PathToKeyframe)

pixels

(tick)

Browses

Browse

Height

Height of the preview (PathToKeyframe)

pixels

(tick)

Browses

Browse

...

All keys available under the item #Video on this same page

(tick)

...

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.and Relations.

Record Tree

New since 21.1: ParentRecordId and HasChildren

Key

Sub Key

Description

Remark

Read-only

Searchable

ReferenceCodes

Contains the full line of ancestors. More info Record Tree

ComplexField

(tick)

(tick)

ReferenceCodes

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

Searchable

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

Searchable

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

Searchable

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)

...

Key

Sub Key

Description

Remark

Read-only

Searchable

Permissions

The different permissions associated with the file

MultiItemField

Permissions

Read

Sub field of Permissions providing ID of a user group with read rights

UUID

(tick)

Permissions

Write

Sub field of Permissions providing ID of a user group with write rights

UUID

(tick)

Permissions

Export

Sub field of Permissions providing ID of the user groups with export rights

UUID

(tick)

ExpiryDate

The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations.

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

(tick)

ExpiryStatus

Whether or not the file is expired. This field is only for advanced installations.

(tick)

Changelog

Changes versus /wiki/spaces/CS/pages/1595408491

...

Metadata 20.4

  • Added the field RecordId

  • Added the structural fields ParentRecordId HasChildren