Konfiguration der Museums-Online-Schnittstelle

Mit der Museums-Online-Schnittstelle können Verzeichnungseinheiten für die Plattform Museums-Online exportiert werden. Die Konfiguration wird im Archiv Schema Editor vorgenommen.

Die Schnittstelle muss zusätzlich in der Verwaltungsoberfläche aktiviert werden.

Nachfolgend ist eine Beispielkonfiguration dargestellt, die verschiedene Optionen abdeckt:

museums-online:
  # Optional, welche Verzeichnungseinheiten exportiert werden:
  base-query:
    files_are_public: true
    has_media_types: true

  # Optional, maximale Anzahl pro Anfrage (Default: 100):
  max-records: 100

  # Optional, XML-Namespaces für den Export:
  namespaces:
    dc: "http://purl.org/dc/elements/1.1/"

  # Zuordnung der Felder zum Export:
  field-mapping:
    - target: title
      namespace: dc
      fields:
        - title
    - target: creator
      namespace: dc
      fields:
        - museumsonline_persons
    - target: type
      namespace: dc
      fields:
        - archival_type
      enum: archival_type
    - target: archival_type
      fields:
        - custom_archival_type
    - target: identifier
      namespace: dc
      fields:
        - signature
        - inventory_number

Alle Eigenschaften sind optional und müssen nicht zwingend konfiguriert werden.

Mit base-query wird definiert, welche Verzeichnungseinheiten für den Export berücksichtigt werden. Die konfigurierten Filter werden bei jeder Anfrage automatisch angewendet. Im obigen Beispiel werden nur Verzeichnungseinheiten exportiert, die öffentliche Dateien haben und Medientypen enthalten. Ohne Konfiguration werden alle Verzeichnungseinheiten exportiert.

Mit max-records wird die maximale Anzahl der Verzeichnungseinheiten pro Anfrage begrenzt. Wenn eine höhere Anzahl angefragt wird, wird diese auf den konfigurierten Wert begrenzt. Der Default ist 100.

Mit namespaces werden die XML-Namespaces definiert, die im Export verwendet werden sollen. Jeder Eintrag besteht aus einem Prefix (z.B. dc) und der zugehörigen Namespace-URI. Ohne Konfiguration werden die Felder ohne Namespace-Prefix exportiert.

Mit field-mapping wird die Zuordnung von Feldern der Verzeichnungseinheiten zu den Zielfeldern im Export konfiguriert. Pro Eintrag wird ein Zielfeld (target) und eine Liste von Quellfeldern (fields) definiert. Als Quellfelder können sowohl Standardfelder (z.B. title, signature) als auch benutzerdefinierte Felder (z.B. museumsonline_persons) verwendet werden. Wenn mehrere Quellfelder angegeben werden, wird für jeden Wert ein separates Element im Export erzeugt. Felder mit mehreren Werten (Listen) werden mit , zusammengefasst.

Optional kann pro Eintrag ein namespace angegeben werden, der auf einen in namespaces definierten Prefix verweist. Felder mit namespace: dc werden z.B. als <dc:title> exportiert. Felder ohne namespace werden ohne Prefix exportiert, z.B. als <archival_type>. So können Dublin-Core-Felder korrekt mit dem dc:-Prefix versehen werden, während eigene Felder ohne Prefix bleiben.

Optional kann pro Eintrag ein enum angegeben werden. Damit werden die gespeicherten Werte (Identifier) durch die entsprechenden Enum-Labels ersetzt. Im obigen Beispiel wird archival_type mit dem Enum archival_type aufgelöst, sodass z.B. pic als Bild exportiert wird.

Unabhängig von der Konfiguration werden die URL der Verzeichnungseinheit im Webauftritt und die Thumbnail-URL (falls vorhanden) automatisch als Identifikatoren erzeugt.

Die technische Dokumentation der Schnittstelle (URL-Parameter, Beispielantworten) ist unter Museums-Online-Schnittstelle beschrieben.