CSV Import
CSV Import¶
A Metadata import task can only be started from an existing .csv file on your system. Whether the CSV file contains a header or not does not matter. Each "csv" row will result in a presentation property. Each row must have exactly 6 fields in the following exact order:
| target entity | property name | label id | language | label name | value |
Warning
An entry will be overridden if a new imported entry has the same target, property name, label id and language!
Target Entity Field¶
The target entity field must not be empty. The possible values are "Root" which targets the root project's collection, the name or the id (uuid) of a IIIFResource entity. IIIFResource entities are the following: Project, Collections, Sequences and Images. The name of a IIIFResource entity can be retrieved directly from the "show" interface.
Warning
Projects are IIIFResource entites, however metadata import is yet not available.
Property Name Field¶
The name of the presentation property to be added. Every property must have a non-blank name field. To ensure consistency the allowed property name field values are predetermined, namely:
- label
- metadata
- license
- rights
- attribution
- requiredStatement
- description
- summary
- navDate
- viewingDirection
- viewingHint
- behavior
- profile
Information on which of these properties can be used by v2.1 and/or v3 can be found here.
Label Id Field¶
The Label Id is used to group the metadata property which needs translations for label names. For example: To add a metadata property (which always needs all fields to not be blank) for the root collection, a redactor must use the Label Id in the .csv file to group german and english translations in the following way:
| Root | metadata | writer_label_id | de | Schriftsteller | Goethe |
| Root | metadata | writer_label_id | en | Writer | Goethe |
This allows the redactor to add multiple translations for the value and label name fields by matching the property's label id. All properties which require a label id field also require the language and the label name fields to not be blank. The properties (Property Name) which require the label id field to not be blank are:
- metadata
Language Field¶
The language abbreviation of the value or/and the label name field. Properties may need a language field. Properties which do not need/allow for the language field to be added exist only once (are thus unique) for the whole IIIFRessource and no additional translation can be added.
The properties (Property Name) which require a language value are:
- metadata
- attribution
- requiredStatement
- description
- summary
- label (only for v3.0, not for v2.1)
The properties (Property Name) which do not allow for a language are:
- license
- rights
- navDate
- viewingHint
- viewingDirection
- behavior
- profile
Label Name Field¶
The translated label name of the property to be added. Every property (Propert Name) which requires a label id field also requires the label name field to not be blank. See Label Id Field to find an example of how to redact label name translations.
The properties (Property Name) which require the label name field to not be blank are:
- metadata
- requiredStatement
Value Field¶
The value of the presentation property to be added. This entry must not be blank for every presentation property added. The value field can represent a translation, if the language field is required, otherwise it represents a unique value.
Example CSV files¶
Here ist an example of a CSV file to import the following metadata (for v2.1): Download file: metadata-mandatory_example_v2.1.csv
| DemoCollection | license | https://creativecommons.org/licenses/by/4.0 | |||
| DemoCollection | attribution | en | University Library of Bern | ||
| DemoCollection | attribution | de | Universitätsbibliothek Bern | ||
| DemoSequence | metadata | title-id | de | Titel | MyNewBook |
| DemoSequence | metadata | title-id | en | Title | MyNewBook |
| DemoSequence | metadata | year-id | de | Year | 2025 |
| DemoSequence | metadata | year-id | en | Jahr | 2025 |
- On the collection level add information about license and rights holder into properties "license" and "attribution"
- On the sequence level, add information about the title and year using the 'metadata' property, where we define an ID for the title and year respectively.
Here is a full example of IIIF presentation properties for version 3.0 and 2.1: metadata-allavailable_example_v3.0andv2.1.csv
| DemoSequence | Label | en | Demo | ||
| DemoSequence | metadata | artist-id | en | artist | Max Müller |
| DemoSequence | license | https://creativecommons.org/licenses/by/4.0/ | |||
| DemoSequence | rights | https://creativecommons.org/licenses/by/4.0/ | |||
| DemoSequence | attribution | en | University of Bern | ||
| DemoSequence | requiredStatement | en | Attribution | University of Bern | |
| DemoSequence | description | en | A short summary. | ||
| DemoSequence | summary | en | A short summary. | ||
| DemoSequence | navDate | 1856-01-01T00:00:00Z | |||
| DemoSequence | viewingDirection | top-to-bottom | |||
| DemoSequence | viewingHint | paged | |||
| DemoSequence | behavior | continuous | |||
| DemoSequence | profile | https://linked.art/ns/terms |
Visualize Metadata¶
At the bottom of each IIIFResource View page, you can find all the properties belonging to the IIIFResource entity.
Property entries with no translations ad no label translations are displayed in a single line:
Property entries with multiple translations are displayed with an "eye" icon:
To see all entries (redacted translations), click on the "eye" icon and all translations will be displayed:
For nested presentation properties, which also required a translated label, you can click first on the "eye" icon to display all labels:
Subsequently click on the "eye" icon at the right of the desired label in order to visualize its translations:
