Dies ist eine technische Dokumentation für das VLM Export Plugin. Es ermöglicht, den Export in eine VLM Instanz.
Name | Wert |
---|---|
Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz des VLM-Export-Plugins in Goobi.
Mithilfe dieses Plugins für Goobi können die Goobi-Vorgänge innerhalb eines Arbeitsschrittes an den konfigurierten Ort für VLM exportiert werden.
Dieses Plugin wird in den Workflow so integriert, dass es automatisch ausgeführt wird. Zur Verwendung innerhalb eines Arbeitsschrittes des Workflows sollte es wie im nachfolgenden Screenshot konfiguriert werden.
Das Plugin muss zunächst in folgendes Verzeichnis kopiert werden:
Daneben gibt es eine Konfigurationsdatei, die an folgender Stelle liegen muss:
Die Konfiguration des Plugins erfolgt über die Konfigurationsdatei plugin_intranda_export_vlm.xml
. Die Konfiguration kann im laufenden Betrieb angepasst werden. Im folgenden ist eine beispielhafte Konfigurationsdatei aufgeführt:
Aktuell gibt es nur eine mögliche Art von Bedingungen, die variablematcher
Bedingung. Diese Art der Bedingung prüft eine beliebige Variable, welche im Feld field
definiert wird, gegen einen regulären Ausdruck, welcher im Feld matches
definiert wird.
Eine Beispiel condition
ist hier zu sehen:
Diese Bedingung hat den Typen variablematcher
. Sie prüft das Feld {meta.singleDigCollection}
, welches dem Metadatum singleDigCollection
entspricht. Die Bedingung prüft, ob der Wert des Metadatums dem regulären Ausdruck \d{20}
entspricht, also ob der Wert aus 20 Ziffern besteht.
Parameter | Erläuterung |
---|---|
identifier
Dieser Parameter legt fest, welches Metadatum als Ordnername verwendet werden soll. Er hat zwei optionale Attribute @anchorSplitter
und @volumeFormat
, die für den Fall verwendet werden, dass der Wert dieses Identifier
s selbst sowohl den Namen des Hauptordners als auch den Namen des Datenträgers enthält, getrennt durch den konfigurierten @anchorSplitter
. @volumeFormat
wird in diesem Fall als linker Auffüller für den Namen des Datenträgers verwendet.
volume
Dieser Parameter steuert, mit dem Inhalt welchen Metadatums die Unterverzeichnisse für Bände benannt werden sollen.
path
Dieser Parameter legt den Export-Pfad fest, wohin die Daten exportiert werden sollen. Erwartet wird ein absoluter Pfad.
condition
Dieses Element ist optional und kann mehrfach auftreten um Bedingungen zu definieren, unter welchen dieser Konfigurationsabschnitt verwendet werden kann. Das Format den condition
Elements ist weiter unten beschrieben. Ein Konfigurationsabschnitt kann verwendet werden, wenn alle Bedingungen erfüllt sind. Wenn es mehrere Konfigurationsabschnitte gibt und mehr als eine verwendet werden könnte wird der Konfigurationsabschnitt mit den meisten Bedingungen ausgewählt (je spezieller die Bedingungen werden, desto höher ist die Priorität). Sollte das nicht eindeutig sein, wird ein beliebiger Konfigurationsabschnitt gewählt. In diesem Fall wird dem Benutzer eine Fehlermeldung angezeigt.
subfolderPrefix
Dieser Parameter beschreibt den Präfix, der für jeden Band eines mehrbändigen Werkes in der Ornderbezeichnung vorangestellt werden soll. (Beispiel T_34_L_
: Hier steht T_34
für die Erkennung zur Erstellung eines Strukturknotens des Typs Band
und das L
gibt an, dass danach ein Text kommt.)
sftp
Dieser Parameter legt fest, ob der Export mittels SFTP stattfinden soll.
useSshKey
Dieser Parameter legt fest, ob die Verbindung zum Remote-Host mithilfe einer SSH Schlüssel Datei zu erledigen.
knownHosts
Dieser Parameter legt fest, wo die Datei namens known_hosts
ist. Wenn keine Datei angegeben wurde, dann wird der Pfad {user.home}/.ssh/known_hosts
genutzt. Sonst wird hier ein absoluter Pfad erwartet.
username
Dieser Parameter legt fest, welcher Nutzername für die Anmeldung bei dem Remote-Host verwendet werden soll.
hostname
Dieser Parameter legt fest, wie der Remote-Host heißt.
port
Dieser Parameter definiert die Portnummer des Remote-Hosts. DEFAULT 22.
password
Dieser Parameter definiert das Passwort, das für die Anmeldung mittels username
@hostname
verwendet werden soll.
keyPath
Dieser Parameter legt fest, wo sich die SSH Schlüssel Datei befindet, die für die Anmeldung mittels username
@hostname
verwendet werden soll.
Identifier
intranda_export_vlm
Repository
Lizenz
GPL 2.0 oder neuer
Letzte Änderung
25.07.2024 12:03:37