Metadata & Classification Profiles

Owned by Alexis Rombaut
Last updated: Sept 16, 2024
2 min read

From version 24.4 profiles of the category Classification should always be used as metadata profiles. Usage of the category Base is discouraged will be forbidden in a future version as metadata profile.

Introduction

The term metadata profiles refers to Profiles of type Base or Classification linked with a record of type Classification named Classifications that functions as the top of the Record Trees MediaHaven. As of version 24.4 the category Base should no longer be used for metadata profiles.

Linking metadata profiles and top records

  • Profiles are linked with Classifications in an ordered manner

  • Top records are of record type Classification

  • The order in which profiles are linked with a top record determines the order in which the profiles should be shown in the UI

  • A profile is only applicable to certain record types

    • All record types

    • Specific record types, e.g. [Mh2Collection, Record]

    • Optionally with wildcards, e.g. [Mh2Collection, Media*]

    • Top records are the top objects in the Record Tree

      • MediaHaven 2.0 → Classification

      • DigiHaven → Series

Record Tree

  • Records have a metadata field Profiles which describes which profiles are linked to it

  • The content of this field is copied from the parent when a child record is created in the Record Tree

  • The content of this field describes which profiles are applicable depending on the record type

"Profiles": { "Record": [ "634656ef-265f-4a9a-b853-1b38dbfbbdcf", "5b2591b7-719f-40c2-b7c9-da92076ac2fc", ], "Mh2Collection": [ "634656ef-265f-4a9a-b853-1b38dbfbbdcf" ] }

Example MediaHaven

Take two example profiles

  1. Profile “Descriptive metadata” linked with record type “Mh2Collection” and “Record”

  2. Profile “Technical metadata” linked with record type “Record”

Example DigiHaven

Take two example profiles

  1. Profile “Adres extensie”

  2. Profile “Bouwaanvraag extensie”

Take two series

  1. Series “Bouwaanvragen Stad Gent” linked with profiles

    1. “Adres extensie” for Dossiers and Documents

  2. Series “Bouwaanvragen Stad Mechelen” linked with profiles

    1. “Adres extensie” for Dossiers

    2. “Bouwaanvraag extensie” for Dossiers

Note that the record types for the profile “Adres extensie” differ depending on the top record Series.

Profiles Rights Management using Scope

  • Permissions on a profile field can be set using the Scope property of a Classification profile

  • Setting the Scope property is only allowed on Field Definitions | Top fields.

  • A user can view/edit fields depending on their functions:

Scope

Required functions

Note

Scope

Required functions

Note

Public

None

  • Default scope

  • The user “public” will lack the functions VIEW/EDIT_ADVANCED_FIELDS and VIEW/EDIT_STANDARD_FIELDS → Portal will not show these fields

Standard

  • VIEW_STANDARD_FIELDS

  • EDIT_STANDARD_FIELDS

  • Use this scope to shield certain fields

Advanced

  • VIEW_ADVANCED_FIELDS

  • EDIT_ADVANCED_FIELDS

  • Use this scope to shield certain fields even further

Children to display in the UI (since 24.4)

Since a child field definition always has the same index as its parent, all child fields are displayed under a field in the user interface. This applies, for instance, to the Descriptive.Authors field, containing children like Author, Photographer, Componist, Artist, etc. To avoid displaying all children, you can set the ChildrenToDisplay property on a classification profile field with as value a limited list of child keys you want to display, for example: ChildrenToDisplay: ["Author", "Artist"]. The following rules apply:

  • By default, the list is empty, which means all child fields will be shown in the user interface

  • The property is only allowed for top fields

  • The property is only applicable for field definitions of type MultiItemField or MapField

  • The feature is a soft permission, in a sense that the API will always return all metadata, but the UI selectively displays it

A migration has been performed so that Mediahaven 2 classification profile fields with dotted key Descriptive.Authors contain the following values ​​for ChildrenToDisplay: Author, Photographer, Artist, Componist