Konfigurierbarer Export
Dies ist eine technische Dokumentation für das konfigurierbare Goobi Export Plugin. Es ermöglicht, den Export mithilfe der Projektkonfiguration anzupassen. Durch die Verwendung von Exportprojekten ist

Einführung

Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz eines Export-Plugins in Goobi.
Mithilfe dieses Export-Plugins für Goobi können die Goobi-Vorgänge innerhalb eines Arbeitsschrittes gleichzeitig an mehrere Orte exportiert werden.
Details
Text
Identifier
intranda_export_configurable
Lizenz
GPL 2.0 oder neuer
Kompatibilität
Goobi workflow 2022.03 und neuer
Dokumentationsdatum
12.05.2022

Installation

Dieses Plugin wird in den Workflow so integriert, dass es automatisch ausgeführt wird. Eine manuelle Interaktion mit dem Plugin ist nicht notwendig. Zur Verwendung innerhalb eines Arbeitsschrittes des Workflows sollte es wie im nachfolgenden Screenshot konfiguriert werden.
Integration des Plugins in den Workflow
Das Plugin muss zunächst in folgendes Verzeichnis kopiert werden:
1
/opt/digiverso/goobi/plugins/export/plugin_intranda_export_configurable.jar
Copied!
Daneben gibt es eine Konfigurationsdatei, die an folgender Stelle liegen muss:
1
/opt/digiverso/goobi/config/plugin_intranda_export_configurable.xml
Copied!

Konfiguration

Die Konfiguration des Plugins erfolgt über die Konfigurationsdatei plugin_intranda_export_configurable.jar und über die Projekteinstellungen. Die Konfiguration kann im laufenden Betrieb angepasst werden. Im folgenden ist eine beispielhafte Konfigurationsdatei aufgeführt:
1
<?xml version="1.0" encoding="UTF-8"?>
2
<config_plugin>
3
<!--
4
order of configuration is:
5
1.) project name matches
6
2.) project is *
7
-->
8
<config>
9
<project>testocr</project>
10
<includeMarcXml>false</includeMarcXml>
11
<folder>
12
<includeMedia>true</includeMedia>
13
<includeMaster>true</includeMaster>
14
<includeSource>false</includeSource>
15
<includeImport>false</includeImport>
16
<includeExort>false</includeExort>
17
<includeITM>false</includeITM>
18
<includeOcr>true</includeOcr>
19
<includeValidation>false</includeValidation>
20
<ocr>
21
<suffix>alto</suffix>
22
</ocr>
23
</folder>
24
</config>
25
26
27
<config>
28
<project>*</project>
29
<target key="{meta.ViewerInstance}" value="evifaanddigihub" projectName="evifExportProject"/>
30
<target key="{meta.ViewerInstance}" value="evifaanddigihub" projectName="digihubExportProject"/>
31
<target key="{meta.ViewerInstance}" value="" projectName=""/>
32
<includeMarcXml>false</includeMarcXml>
33
<folder>
34
<!-- as configured in goobi_config.properties -->
35
<!--genericFolder>thumbs</genericFolder-->
36
<includeMedia>true</includeMedia>
37
<includeMaster>true</includeMaster>
38
<includeOcr>false</includeOcr>
39
<includeSource>false</includeSource>
40
<includeImport>false</includeImport>
41
<includeExort>false</includeExort>
42
<includeITM>false</includeITM>
43
<includeValidation>false</includeValidation>
44
</folder>
45
</config>
46
</config_plugin>
Copied!
Parameter
Erläuterung
project
Dieser Parameter legt fest, für welches Projekt der aktuelle Block <config> gelten soll. Verwendet wird hierbei der Name des Projektes. Der <config>-Block mit dem project * wird immer verwendet, wenn kein anderer Block auf den Projektnamen passt.
target
Dieser Parameter hat 3 obligatorische Attribute: Im Parameter key sollte eine Goobi Variable der Form {meta.Metadatenname} verwendet werden. Im Attribut value kann dann der gewünschte Wert angegeben werden. Setzt man value="" So schlägt die Bedingung an, wenn das Metadatum leer oder nicht gesetzt ist. Im Attribut projectName sollte der Name des Exportprojektes, mit dessen Einstellungen der Export stattfinden soll, angegeben werden. Wird dem Attribut ein leerer String zugewiesen projectName="", so werden die Einstellungen des Projektes des Vorgangs zum Export verwendet. Wenn keine target condition gesetzt ist, wird ein normaler Export durchgeführt. Für jede target Bedingung, die zutrifft, wird ein Export angestoßen.
includeMarcXml
Dieser Parameter legt fest, ob evtl. vorhandene MARC-XML Daten in die exportierte Mets-Datei eingebettet werden sollen. Der Defaultwert ist false.
Der Block <config> ist wiederholbar und kann so in unterschiedlichen Projekten verschiedene Metadaten definieren. Der Block mit <project>*</project> wird angewendet, wenn kein Block mit der Projektbezeichnung des Projektes existiert.

Der folder-Block

Der folder Block befindet sich innerhalb von jedem config-Element. Er steuert, welche Verzeichnisse für den Export berücksichtigt werden sollen.
Parameter
Erläuterung
includeMedia
Hier kann definiert werden, ob der media-Ordner exportiert werden soll.
includeMaster
Hier kann definiert werden, ob der master-Ordner exportiert werden soll.
includeOcr
Hier kann definiert werden, ob der ocr-Ordner exportiert werden soll.
includeSource
Hier kann definiert werden, ob der source-Ordner exportiert werden soll.
includeImport
Hier kann definiert werden, ob der import-Ordner exportiert werden soll.
includeExort
Hier kann definiert werden, ob der export-Ordner exportiert werden soll.
includeITM
Hier kann definiert werden, ob der TaskManager-Ordner exportiert werden soll.
includeValidation
Hier kann definiert werden, ob der validation-Ordner exportiert werden soll.
ocr
Das ocr Element wird benötigt, wenn man OCR-Ordner mit verschiedenen Suffixen verwendet. Das konkrete Suffix kann dann im Unterelement suffix angegeben werden.
Der Defaultwert für jeden dieser Parameter außer ocr ist false. Wird der jeweilige Parameter nicht in der Konfiguration erwähnt, findet kein Export des entsprechenden Ordners statt.
Die Konfiguration des Zielordners kann innerhalb der Projekteinstellungen in der Nutzeroberfläche von Goobi workflow vorgenommen werden. Wenn dort die Checkbox für Erzeuge Vorgangsverzeichnis gesetzt ist, wird der Vorgang in einen Unterordner mit seinem Titel als Namen im Zielverzeichnis abgelegt.
Projekteinstellungen innerhalb von Goobi workflow