A file in MediaHaven consists of a list of metadata fields. Each metadata field has a key and the keys are unique in the list of metadata fields from a file. An overview of all the fields that are standard in MediaHaven is documented in Metadata Fields.
Field Definitions
A field definition describes the properties of a field.
...
Property
...
Description
...
Key
...
The name of the field
The keys are case sensitive
The
Keyof the top fields are unique (case insensitive)
...
Sub
...
Metadata fields can be nested inside other metadata fields (see complex field). Such nested fields are called sub fields or child fields and have a parent field.
...
Top
...
Inverse of the property sub. Each file consists of a list of top fields whose key is unique.
...
Flattened Key
...
A sub field cannot be uniquely determined by its own key because the key for sub fields is not unique across all fields. By concatenating the key of the parent field(s) with the key of the sub field, you obtain a unique flattened key. For example the field Keywords with sub field Keyword, yields a flattened key KeywordsKeyword.
The flattened key is allowed in the MediaHaven REST API 2.0 but the dotted key is the preferred format
...
Dotted Key
...
Same principle as for flattened keys but now the concatenation contains a dot . between each part and the first piece is the family.
The descriptive field
Keywordhas as dotted keyStructural.Keywords.Keyword
| Tip |
|---|
The dotted key is the reference format for the MediaHaven REST API 2.0 |
...
Lucene Key
...
Name of the field in Lucene. For legacy reasons it can differ significantly from the key of the field.
From 18.1 the REST API allows for using the field key instead of the Lucene key in queries. For sub fields you must use the flattened key. This allows for bypassing the legacy Lucene keys.
From 19.1: the Lucene key always corresponds with the flattened key
| Note |
|---|
The Lucene key is no longer allowed in the MediaHaven REST API 2.0 |
...
Required
...
If true, this field will always be present for every record with a non empty value.
...
Read Only
...
The value of this field cannot be changed using metadata updates.
...
Index
...
If true, make the field searchable in the index
Note: a field can be present in the index without being indexed.
...
Global
...
When using the standard search, it searches in a hidden virtual field which contains as value a join of all fields marked as global
...
Advanced Search
...
If true, make it available in the advanced search. Requires the field to be indexed.
...
Tokenize
...
Informally speaking, tokenizing means splitting the string value of the field on white space in tokens. Requires the field to be indexed.
For example the field Description with value "Alice Bob Cedric" is split into the ordered tokens "Alice", "Bob" and "Cedric".
The file can matched in the index:
using these tokens separately:
+Description:Cedric +Description:Alicein a specific order:
+Description:"Bob Cedric"note:
+Description:"Alice Cedric"will not match
...
Family
...
Metadata Families
...