Dieses generische Import-Plugin erlaubt den Massenimport von Daten aus JSON-Dateien
Name | Wert |
---|---|
Dieses dies die technische Dokumentation für das Workflow-Plugin für Goobi workflow, das dazu dient, Metadaten aus mehreren JSON-Dateien auszulesen und darauf Vorgänge zu erstellen.
Zur Installation des Plugins müssen folgende beiden Dateien installiert werden:
Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:
Der Inhalt der Konfigurationsdatei sieht wie folgt aus:
Die Konfiguration des Plugins gestaltet sich wie folgt:
Die folgenden Attribute können in einem group
-Element konfiguriert werden:
Die folgenden Attribute können in einem child
-Element konfiguriert werden:
Es gibt eine Möglichkeit, ein Metadatum für die URL des Partners zu erzeugen und zu speichern. Die zu erzeugende URL wird wie folgt festlegt: {urlBase}/{urlPart_1}/{urlPart_2}/.../{urlPart_k}/{urlTail}/
Wert | Beschreibung |
---|---|
Wert | Beschreibung |
---|---|
Wert | Beschreibung |
---|---|
Wert | Beschreibung |
---|---|
jsonFolder
Pfad zum Verzeichnis, wo sich die JSON-Dateien befinden.
importFolder
Pfad zum Verzeichnis, wo die herunterzuladenden Bilder gespeichert werden sollen, bevor sie in die Vorgänge importiert werden.
workflow
Name des Produktionsvorlage, die verwendet werden soll.
publicationType
Publikationstyp für die anzulegenden Vorgänge.
downloadableUrl
Typs des Metadatums, in dem die URL angegeben ist, von der die Bilder herunterzuladen sind. Dieser Wert ist wiederholbar.
metadata
Aus jedem Tag wird ein Metadata-Objekt erzeugt. Das Attribut @source
bezieht sich auf einen JSON-Pfad, wenn dieser mit $
beginnt. Aus diesem Pfad wird der Wert des Metadatums ausgelesen. In diesem Falle bezieht sich das Attribut auf eine Liste, wenn es außerdem mit [:]
endet. Wenn es weder mit $
noch mit @
startet, wird es hingeben selbst als Wert des Metadatums verwendet. Das Attribut @target
konfiguriert den Namen des Metadatentyps.
group
Hier werden Metadatengruppen konfiguriert. Es gibt sechs Attribute, die nachfolgend erläutert werden. Unter einem group
-Element können mehrere metadata
-Elemente konfiguriert werden, deren @source
Attribute mit @
starten sollen.
child
Hier werden Strukturelemente konfiguriert. Es gibt fünf Attribute, die nachfolgend erläutert werden. Unter einem child
-Element können mehrere metadata
-Elemente konfiguriert werden, deren @source
Attribute mit @
starten sollen.
@source
JSON-Pfad zum Eltern-Element einer Liste. Startet mit einem $
.
@type
Typ der Metadatengruppe.
@altType
Alternativer Typ der Metadatengruppe. Wenn der alternative Typ richtig konfiguriert wird, wird aus allen gefilterten Einträgen eine Metadatengruppe diesen Typs erzeugt. Wenn das Attribut nicht konfiguriert ist oder wenn der konfigurierte Typ nicht zu finden ist, werden alle gefilterten Einträge nicht importiert. Dieser Parameter ist optional.
@key
Schlüssel der JSON-Objekte für die Filterung. Dieser Parameter ist optional.
@value
Wert zum Vergleich beim Filtern. Dieser Parameter ist optional.
@method
Zu verwendende Logik für das Filtern. Möglichkeiten sind hierbei is
, not
, startsWith
, endsWith
und contains
. Dieser Parameter ist optional. Der Default-Wert lautet is
.
@source
JSON-Pfad zum Eltern-Element einer Liste. Startet mit einem $
.
@type
Typ des Strukturelements.
@key
Schlüssel der JSON-Objekte für die Filterung. Dieser Parameter ist optional.
@value
Wert zum Vergleich beim Filtern. Dieser Parameter ist optional.
@method
Zu verwendende Logik für das Filtern. Möglichkeiten sind hierbei is
, not
, startsWith
, endsWith
und contains
. Dieser Parameter ist optional. Der DEFAULT-Wert lautet is
.
partnerUrl
Das Attribut save
konfiguriert ob ein Metadatum für die URL des Partners erzeugt werden soll. Der DEFAULT-Wert lautet false
.
urlBase
Hier konfiguriert man den URL zum Server des Partners. Dieser Parameter ist optional. Maximal ein Treffer ist möglich.
urlPart
Hier werden die Teile der URL konfiguriert, deren Werte aus den JSON-Objekten an die urlBase
nacheinander anhängen werden sollen. Dieser Parameter ist optional. Mehrere Treffer sind möglich.
urlTail
Hier wird der hintere Teil der URL konfiguriert. Dieser Parameter ist optional. Maximal ein Treffer ist möglich.
urlMetadata
Typ des Metadatums.
Identifier
intranda_workflow_import_json
Repository
Lizenz
GPL 2.0 oder neuer
Letzte Änderung
14.08.2024 19:06:00