An verschiedenen Stellen wird Goobi workflow über mehrere Konfigurationsdateien gesteuert. An dieser Stelle werden die wichtigsten Konfigurationsdateien aufgelistet und detailliert erläutert.

In der Datei goobi_exportXml.xml werden technische Details zu den verwendeten Eigenschaften und zugehörigen XML-Namensräumen beim Generieren von Laufzettel-Dateien angegeben.

Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

/opt/digiverso/goobi/config/goobi_exportXml.xml

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

<?xml version="1.0" encoding="UTF-8"?>

<config_exportXml>

	<namespace name="mets" value="http://www.loc.gov/METS/" />
	<namespace name="mods" value="http://www.loc.gov/mods/v3" />
	<namespace name="goobi" value="http://meta.goobi.org/v1.5.1/" />
	<namespace name="xlink" value="http://www.w3.org/1999/xlink" />
	<namespace name="dv" value="http://dfg-viewer.de/" />
	<namespace name="wt" value="http://wellcome.ac.uk/" />

	<mets>
		<property name="shelfmarksource" value="//mets:mets/mets:dmdSec[1]/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi/goobi:metadata[@name='shelfmarksource']" />
		<property name="TitleDocMain" value="//mets:mets/mets:dmdSec[1]/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi/goobi:metadata[@name='TitleDocMain']" />
		<property name="CorporateName" value="//mets:mets/mets:dmdSec[1]/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi/goobi:metadata[@name='CorporateName']" />
		<property name="PublicationYear" value="//mets:mets/mets:dmdSec[1]/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi/goobi:metadata[@name='PublicationYear']" />
	</mets>

	<!--
	<anchor>
		<property name="ManifestationType" value="//mets:mets/mets:dmdSec[1]/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi/goobi:metadata[@name='_ManifestationType']" />
	</anchor>
	-->

</config_exportXml>

Allgemeines

Diese Konfigurationsdatei wird dafür verwendet, weitere Eigenschaften anzugeben, die beim Export von Laufzettel-Dateien berücksichtigt werden sollen. Da diese Eigenschaften aus verschiedenen Bereichen zusammengetragen werden können, muss für jede Eigenschaft angegeben werden, wo sie definiert ist. Dies geschieht mit Hilfe von Namensräumen, die vorher ebenfalls definiert werden.

Definieren von Namensräumen

Mit den <namespace> Elementen werden Namensräume definiert, mit denen weitere Eigenschaften für den Export von Metadaten verwendet werden können. Es gibt einige Projekte und Institutionen, die solche Namensräume definieren. In dieser Konfigurationsdatei wird für jede benötigte Namensraumdefinition ein <namespace> Element angelegt.

Namensräume werden durch einen Namen oder eine Abkürzung identifiziert, der mit dem name Parameter angegeben wird. Dieser sollte kurz und aussagekräftig sein, da er später oft verwendet wird. Namensraum-Namen dürfen nicht mehrfach vorkommen. Üblicherweise wird der Projektname oder eine Abkürzung davon verwendet. Der Projektname ist in der Regel aus der Domain in der angegeben URL ersichtlich.

Dementsprechend verweisen Namensräume auf eine URL, die im Parameter value definiert wird. Diese URL muss auf eine XML-Spezifikation verweisen, die weitere Informationen über den jeweiligen Namensraum und die verfügbaren Eigenschaftsnamen beinhaltet. Weitere Informationen gibt es in den jeweiligen Dokumentationen zu den Namensraum-Spezifikationen.

Wird zum Beispiel folgender Namensraum definiert,

<namespace name="mets" value="http://www.loc.gov/METS/" />

so kann später ein Element mets:xmlData verwendet werden. Goobi kann dann zuordnen, dass im Namensraum mets, der wiederum in der Spezifikation unter http://www.loc.gov/METS/ definiert ist, nach dem Element xmlData gesucht werden soll. Dort ist es dem Projekt entsprechend definiert.

Definieren von Eigenschaften

Eigenschaften, die beim Export berücksichtigt werden sollen, werden in <property> Elementen angegeben. Der Titel, der im name Parameter angegeben wird, wird für die Struktur des exportierten Laufzetteldokumentes weiterverwendet. Der value Parameter beinhaltet ein oder mehrere Eigenschaften, die wie folgt aufgebaut sind.

Syntax für Eigenschaften

Alle Eigenschaften werden mit Schrägstrichen (/) getrennt. Zusätzlich beginnt der gesamte Eintrag mit zwei Schrägstrichen. Die grundlegende Syntax ist wie folgt:

value="//field1/field2/field3"

Da in der Liste von Namensräumen kein Standardnamensraum definiert werden kann, wird jede Eigenschaft mit einem Namensraum versehen und es ergibt sich folgende Syntax:

value="//namespace1:field1/namespace2:field2/namespace3:field3"

Es können beliebig viele Elemente angegeben werden. Es können nur Namensräume verwendet werden, die zuvor in den <namespace> Elementen definiert worden sind. Entsprechend der Namensräume können nur bestimmte Eigenschaften angegeben werden. Das sieht zum Beispiel so aus:

value="//mets:mets/mets:mdWrap/mets:xmlData/mods:mods/mods:extension/goobi:goobi"

Es kann vorkommen, dass Eigenschaften als Listen vorliegen. In diesem Fall wird mit eckigen Klammern die Nummer des Listenelements angegeben. Zu beachten ist, dass die Zählung bei 0 beginnt. Im folgenden Beispiel wird das zweite Element aus der Liste dmdSec verwendet. (Das erste Element hätte dann die Nummer 0.)

mets:dmdSec[1]

Außerdem ist es möglich, bei komplexeren Eigenschaften zu selektieren, welcher Bestandteil der Eigenschaft verwendet werden soll. Im folgenden Beispiel wird aus dem Element metadata das Unterelement mit der Eigenschaft name = PublicationYear ausgewählt.

goobi:metadata[@name='PublicationYear']

meta.xml oder meta_chanor.xml

Wird nur eine meta.xml verwendet, um den Vorgang zu beschreiben, so werden alle <property> Elemente innerhalb eines <mets> Elementes angelegt.

Wird zusätzlich eine meta_anchor.xml verwendet, um den Vorgang zu beschreiben, so werden alle <property> Elemente innerhalb eines <anchor> Elementes angelegt.

Für einen Export werden immer nur die <property> Elemente aus einem der beiden Elemente verwendet.

Soll eine goobi_exportXml.xml Datei für verschiedene Projekte genutzt werden, die teilweise nur die meta.xml und teilweise auch die meta_anchor.xml verwenden, können problemlos beide Elemente mit ihren jeweiligen <property> Unterelementen angegeben werden. Diese beeinflussen sich nicht gegenseitig.

In der Konfigurationsdatei goobi_opacUmlaut.txt werden Umlaute angegeben, die beim automatischen Generieren von Vorgangstiteln ersetzt werden sollen. Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

Üblicherweise werden die verwendeten Vorgangstitel von Goobi Workflow automatisch generiert. Diese beinhalten die Anfangsbuchstaben des Autors und eine Abkürzung des entsprechenden Werknamens.

Da der Vorgangstitel aus Kompatibilitätsgründen keine Umlaute bzw. Sonderzeichen beinhalten darf, versucht Goobi, diese durch kompatible Buchstaben mit ähnlicher Bedeutung zu ersetzen.

Während es für einen Anwender intuitiv ist, dass ein ä auch durch ein a ersetzt werden kann, haben diese beiden Buchstaben keinen technischen Zusammenhang. Daher muss dieser Zusammenhang im Sinne des Sprachgebrauchs konfiguriert werden. Üblicherweise ist die oben gezeigte Konfiguration bereits vorhanden und deckt die meisten Sprachen ab.

In der Datei goobi_opacUmlaut.txt werden die verwendeten Ersetzungsregeln angegeben. In der ersten Spalte stehen die zu ersetzenden Zeichen. Dahinter steht jeweils das Ersatzzeichen. Dieses darf selbst kein Sonderzeichen oder Umlaut sein.

Alle Sonderzeichen, die nicht in dieser Konfigurationsdatei berücksichtigt werden, werden beim Generieren des Vorgangstitels ersatzlos aus dem Namen entfernt.

Der Übersetzungsalgorithmus ist so implementiert, dass auch mehrbuchstabige Zeichenfolgen ersetzt werden können. Dabei ist auch folgende Konfiguration möglich, wobei immer genau ein Leerzeichen als Trennzeichen erwartet wird:

Zu beachten ist, dass erst der Vorgangstitel anhand der Originalnamen generiert wird und danach die Umlaute ersetzt werden. Dabei kann es vorkommen, dass sich bei einer mehrbuchstabigen Ersetzung die Länge des Vorgangstitels ändert.

Ist zum Beispiel der Name des Autors Björn und es werden die ersten vier Buchstaben verwendet, ergibt sich das Kürzel björ (ohne Großschreibung). Da nun das ö zum oe wird, ändert sich die Abkürzung zu bjoer und hat nun fünf Buchstaben.

In der Konfigurationsdatei goobi_opac.xml wird die Kommunikation von Goobi workflow mit externen Datenquellen festgelegt. Dies betrifft zumeist Systeme wie Bibliothekskataloge. Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

Publikationstypen

In dem Element <doctypes> können mehrere Publikationstypen definiert werden. Jeder Typ steht in einem eigenen <type>-Element und hat einige Eigenschaften, die über Parameter und Unterelemente angegeben werden.

Eigenschaften eines Publikationstyps

Alle wichtigen Eigenschaften eines Publikationstyps werden als Parameter im <type>-Element angegeben. Folgende Parameter können verwendet werden:

Übersetzung des Titels

Die im title-Parameter angegebene Bezeichnung eines Publikationstyps wird softwareintern verwendet und ist daher für Anwender nicht immer gut lesbar und wird nicht automatisch übersetzt. Daher kann der Name des Publikationstyps mit dem <label>-Element in verschiedene Sprachen übersetzt werden. Mit dem language-Parameter wird das Sprach-Kürzel angegeben. Je nach Konfiguration werden üblicherweise folgende Sprachen unterstützt:

Mapping zu anderen Datenformaten

Es kann vorkommen, dass ein Publikationstyp mit einer Suchfunktion oder mit externen Datenformaten über bestimmte Bezeichnungen oder Kürzel gefunden werden können soll, die nicht aus dem Titel ableitbar sind. Dazu können für jeden Typen mit dem Unterelement <mapping>id42</mapping> weitere Bezeichnungen angegeben werden. Wird dann zum Beispiel nach der ID id42 gesucht, so wird der entsprechende Publikationstyp gefunden.

Kataloge

Goobi kann Metadaten aus verschiedenen Katalogen verwenden. Diese werden mit dem <catalogue> Element direkt im <opacCatalogues> Element eingetragen. Für jedes Katalog-Element wird mit dem title Parameter der offizielle Name des jeweiligen Katalogs angegeben.

Konfiguration eines Katalogs

Einige weitere Eigenschaften eines Katalogs werden im Unterelement <config> als Parameter angegeben. Folgende Parameter können verwendet werden:

Optionen für die Suche

Metadaten werden in Katalogen mithilfe bestimmter Nummern identifiziert (zum Beispiel ISBN oder ISSN). Sollen in Goobi Metadaten anhand einer vorgegebenen Nummer aus dem jeweiligen Katalog importiert werden, können mit dem ` Element verschiedene Nummernsysteme aufgelistet werden. Ein Anwender kann dann im folgenden Beispiel eine ISBN-Nummer eingeben und dazu passend das ISBN-Feld auswählen:

Dabei stellt jedes <searchField> Element eine Option in dem zugehörgigen Dropdown-Menü dar. Der in label angegebene Text wird auf der Nutzeroberfläche dargestellt. Der in value definierte Wert ist die interne ID des Nummernsystems. Je nach Katalog kann auch eine textbasierte ID verwendet werden. Das kann zum Beispiel so aussehen:

Detailierte Informationen über unterstützte Nummernsysteme können von der jeweiligen Katalog-API abgefragt werden. Dies ist eine XML-Datei, die direkt im Browser aufgerufen werden kann. Die Domain muss entsprechend dem verwendeten Anbieter angepasst werden.

Mapping zu Publikationstypen

Wie oben beschrieben, können Publikationstypen mit alternativen Bezeichnungen gefunden werden. Zusätzlich ist es in <catalogue> Elementen möglich, mit dem <specialmapping> Element katalogspezifische Bezeichnungen (und damit auch Kataloge) zu Publikationstypen zu verknüpfen. Damit können über die alternativen Bezeichnungen eines Katalogs passende Publikationstypen definiert und gefunden werden.

Dabei verweist der type-Parameter des <specialmapping>-Elements auf den title des zuvor definierten Publikationstypen. Das <specialmapping> Element beinhaltet eine alternative Bezeichnung. Folgendes Beispiel würde für einen K10Plus-Katalog den Suchbegriff k10plus_periodical mit dem Publikationstyp periodical verknüpfen:

Anpassen von Datensätzen aus MARC-Dateien

Werden Datensätze aus Katalogen abgefragt, so werden diese unter anderem über MARC-Dateien in Goobi importiert. Datensätze aus diesen Dateien können durch bestimmte Ersetzungsmuster angepasst werden. Dazu wird das <beautify> Element als direktes Unterelement des entsprechenden <catalogue> Elements verwendet und kann beliebig viele <setvalue> Befehle enthalten.

Da die Bearbeitung der MARC-Daten mit diesen Befehlen sehr komplex werden kann, werden hier auf Basis des folgenden MARC-Daten-Ausschnitts nur ein paar einfache Beispiele beschrieben.

Mit dem folgendem Befehl können bestimmte Werte ersetzt werden. Stellt sich zum Beispiel heraus, dass manche Datensätze vom Typ book eine ungültige Jahreszahl (year) haben, können falsche Daten korrigiert werden. Der setvalue-Befehl bestimmt, dass in jedem mit der inneren <condition> angesprochenen datafield mit Tag book das subfield mit dem Parameter code="year" den Wert 1900 bekommen soll. Die <condition> besagt, dass alle datafield Elemente berücksichtigt werden sollen, die das Tag book haben und bei denen ein Unterelement mit code="year" und dem Wert 190 vorhanden ist.

Daten können mit dem <setvalue>-Befehl gefiltert werden. Möchte man zum Beispiel die other_id Elemente entfernen, kann deren Wert mit einer leeren Zeichenkette überschrieben werden.

Hinweis: Ein Sternchen (*) ist ein Platzhalter für ein beliebigen Wert. Reguläre Ausdrücke werden nicht unterstützt.

Datensätze können auch um neue Eigenschaften ergänzt werden. Dies funktioniert allerdings nur bedingt, weil nur auf die Daten aus der MARC-Datei und aus dem <setvalue> Befehl zurückgeriffen werden kann. So ist es zum Beispiel möglich, Datensätze mit bestimmten Inhalten neue Tags zu vergeben:

In der Konfigurationsdatei goobi_activemq.xml werden die Einstellungen für die von Goobi Workflow verwendete Java-Bibliothek org.apache.activemq angegeben.

Goobi Workflow verwendet die Datei nicht selbst, sondern gibt sie direkt als Konfiguration an die Bibliothek weiter. Diese Dokumentation stellt nur die wichtigsten Einstellungen dar, die für Goobi eine Rolle spielen. Eine ausführlichere Dokumentation ist auf der Webseite von activemq zu finden.

Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

Verwendete XML-Namensräume

Diese Konfigurationsdatei kann in komplexeren Anwendungen mehrere XML-Namensräume verwenden.

Das Wurzelelement <beans> verwendet immer diesen Standard-Namensraum:

Das Unterelement <broker> verwendet immer diesen Standard-Namensraum:

Einstellungen für den Message Broker

Alle Einstellungen, die für die Nutzung des Message Brokers von Goobi Workflow wichtig sind, werden innerhalb des <broker>-Elements vorgenommen.

Mit dem Parameter brokerName wird der Name des Message Brokers angegeben. Da dies der einzige auf localhost (auf diesem Computersystem) ist, ist der Name standardmäßig localhost.

Der Parameter schedulerSupport gibt an, ob ein Scheduler für Multithreading eingesetzt wird.

Mit dem Parameter schedulerDirectory wird ein vollständiger Dateipfad zu einem ausführbaren Scheduler angegeben.

Freischalten von URIs mit bestimmten Protokollen

Mit dem Element <transportConnectors> wird eine Liste von freigeschalteten Endpunkten mitsamt den verwendbaren Protokollen angegeben. Jedes darin enthaltene <transportConnector> Element gibt einen Endpunkt an.

Ein Endpunkt hat üblicherweise zwei Parameter. Mit dem name-Parameter wird ein Name für die Freischaltung festgelegt. Dies kann zum Beispiel der Name des Protokolls sein. Der uri Parameter gibt einen Uniform Resource Identifier an, der aus einem Protokoll, einer IP-Adresse oder Domain, einer Portnummer, einem Pfad und eventuellen Parametern besteht. Von der hier angegebenen URL kann später mit dem angegebenen Port und dem entsprechenden Protokoll auf activemq zugegriffen werden.

Verwendete Datenbank

Es kann vorkommen, dass übertragene Informationen nicht direkt vom Empfänger angenommen werden. Wen diese lange genug nicht abgefragt werden, speichert activemq sie in einer eigenen Datenbank. Diese wird mit dem Element <persistenceAdapter> konfiguriert.

Standardmäßig wird die kahaDB verwendet, daher beinhaltet die Konfiguration ein Element <kahaDB> mit dem Parameter directory, in dem der vollständige Dateipfad zur Datenbank angegeben wird.

Zusätzlich kann der Parameter journalMaxFileLength angegeben werden, um die Dateigröße in der Datenbank zu begrenzen. Dabei wird eine der Maßeinheiten mb oder gb verwendet.

Speicherbegrenzung

Mit dem Element <systemUsage> kann der zur Verfügung stehende Speicherplatz für die übertragenen Daten in der Warteschlange begrenzt werden.

Das Element <memoryUsage> definiert die maximale Größe von verwendetem Arbeitsspeicher.

Das Element <storeUsage> definiert die maximale Größe der internen Datenbank.

Das Element <tempUsage> definiert die maximale Größe von temporären Dateien.

Die üblichsten Maßeinheiten für den limit-Parameter sind mb und gb.

Eigene Verbindung für JMX

Mit dem Element <managementContext> wird üblicherweise eine eigene Verbindung für JMX (Java Management Extensions) ausgeschaltet. Der Parameter createConnector ist standardmäßig auf false gesetzt, damit die Standardverbindung verwendet wird.

Plugins

Diese Konfiguration für den Message Broker ist standardmäßig mit drei Plugins ausgestattet, die die Authentifizierung und das Redelivery-System übernehmen.

Plugin für Benutzergruppen

Mit dem <authenticationPlugin> werden Benutzergruppen und deren Zugriffsrechte auf verschiedene Warteschlangen definiert.

Mit jedem <authorizationEntry> wird eine Warteschlange und die dazugehörigen Details angegeben. Dabei gibt der queue Parameter die verwendete Warteschlange an. Mit dem Parameter topic kann statt Lese- und Schreibrechten für eine Warteschlange der Zugriff auf bestimmte Themen konfiguriert werden.

Statt einem Namen kann bei einer Warteschlange oder einem Thema der Wert > gesetzt werden. Dies ist ein Universaloperator und trifft auf alle Warteschlangen und Themen zu.

Die Parameter read, write und admin geben Nutzergruppen an, die jeweils lesend, schreibend und mit Administratorberechtigung auf die jeweilige Warteschlange oder das Thema zugreifen können. Mehrere Nutzergruppen in einem Parameter können mit Komma getrennt werden.

Plugin für Benutzer und Passwörter

Mit dem <simpleAuthenticationPlugin> werden Benutzer angelegt und Passwörter sowie Benutzergruppen für Benutzer definiert. Jedes <authenticationUser> Element gibt dabei einen authentifizierbaren Benutzer an. Mit den Parametern username und password werden der Nutzername und das notwendige Passwort definiert, mit denen sich der Nutzer (oder eine andere Software) authentifizieren muss.

Zusätzlich gibt es den Parameter groups, der eine kommagetrennte Liste von Benutzergruppen beinhaltet, denen der jeweilige Benutzer angehört. Diese Gruppen sind relevant für das <authorizationPlugin>.

Plugin für die Fehlerbehandlung

Mit dem <redeliveryPlugin> wird eine detailiertere Fehlerbehandlung für das Neu-Senden von fehlerhaft übertragenen Daten konfiguriert. Dieses Plugin hat zwei boolsche Parameter, die das finale Speichern von mehrfach fehlgeschlagenen Übertragungsversuchen und deren Inhalten steuern.

Mit dem Parameter fallbackToDeadLetter werden Nachrichten ab einer bestimmten Anzahl an fehlgeschlagenen Übertragungsversuchen nicht weiter übertragen, um die Auslastung des Systems gering zu halten.

Mit dem Parameter sendToDlqIfMaxRetriesExceeded wird eine Nachricht, die mehrfach nicht gesendet werden konnte, in einen Restspeicher geschrieben. Dort verbleibt sie, bis sie manuell oder durch einen späteren erfolgreichen Übertragungsversuch doch noch gelesen werden kann. So wird verhindert, dass das Warteschlangensystem mit nicht funktionsfähigen Verbindungen ausgelastet wird.

In dem Unterelement <redeliveryPolicyEntries> werden Fehlerbehandlungsregeln aufgelistet, die jeweils auf bestimmte Warteschlangen zutreffen sollen. Dabei wird für jede dort eingetragene Regel mit dem Element <redeliveryPolicy> und dem Parameter queue die zugehörige Warteschlange definiert.

In dem Element <defaultEntry> wird der Standardfall definiert, der dann ausgeführt wird, wenn keine der oben genannten Regeln zutrifft. In diesem Element wird mit <redeliveryPolicy> genau eine Regel definiert, diese benötigt allerdings keinen queue-Parameter, da sie in allen übigen Fällen für alle Warteschlangen verwendet wird.

Es können einige weitere Parameter für die Regeln angegeben werden. So ist es möglich, mit dem ganzzahligen maximumRedeliveries Parameter die maximale Anzahl an Versuchen anzugeben, bevor eine Nachricht in den Restspeicher geschrieben wird. Mit dem ebenfalls ganzzahligen Parameter initialRedeliveryDelay wird die Anzahl an Millisekunden angegeben, nach der ein erneuter Sendeversuch gestartet wird.

Um das System nicht dauerhaft auszulasten, kann der zeitliche Abstand zwischen erneuten Sendeversuchen jedes Mal exponentiell erhöht werden. Dafür wird der boolsche Parameter useExponentialBackOff auf true gesetzt und mit dem Parameter backOffMultiplier ein Multiplikationsfaktor angegeben, mit dem der Zeitraum erhöht wird. Ist dieser zum Beispiel auf 1.5 gesetzt und der initiale Zeitraum ist auf 60 Sekunden gesetzt, so wird der nächste Sendeversuch nach 1.5 * 60 = 90 Sekunden ausgeführt. Der dritte folgt nach weiteren 1.5 * 90 = 135 Sekunden.

In der Konfigurationsdatei goobi_metadataDisplayRules.xml wird festgelegt, wie die Metadaten innerhalb des Metadateneditors von Goobi angezeigt werden sollen. Sie befindet sich üblicherweise an folgendem Pfad im Dateisystem.

/opt/digiverso/goobi/config/goobi_metadataDisplayRules.xml

In dieser Konfigurationsdatei wird beschrieben, wie einzelne Metadatenfelder dargestellt werden sollen. So kann unter anderem festgelegt werden, das Felder beispielsweise als Eingabefelder, Auswahllisten, Read-Only-Felder etc. angezeigt werden und entsprechend unterschiedlich durch den Nutzer bearbeitet werden können. Beispielhaft hier einmal eine solche Konfigurationsdatei:

<?xml version="1.0" encoding="UTF-8"?>
<displayRules>
    <ruleSet>
        <context projectName="*">
            
            <!-- text field -->
            <textarea ref="TitleDocMain">
                <label></label>
            </textarea> 
             <input ref="CatalogIDSource">
                <label></label>
            </input> 
            
            <!-- text area -->
            <textarea ref="TitleDocMainShort">
                <label></label>
            </textarea> 
            <textarea ref="Description">
                <label></label>
            </textarea> 
            
            <!-- default value -->
            <input ref="PlaceOfPublication">
                <label>Göttingen</label>
            </input> 
            
            <!-- read only -->
            <readonly ref="CatalogIDDigital">
                <label></label>
            </readonly>
            
            <!-- Single select -->
            <select1 ref="singleDigCollection">
                <item selected="true">
                    <label>General</label>
                    <value>General</value>
                </item>

                <item selected="false">
                    <label>Biology</label>
                    <value>Biology</value>
                </item>

                <item selected="false">
                    <label>Physics</label>
                    <value>Physics</value>
                </item>

                <item selected="false">
                    <label>Mathematics</label>
                    <value>Mathematics</value>
                </item>
            </select1>
            
            <!-- Multi select  -->
            <select ref="Classification">
                <item selected="true">
                    <label>Blue</label>
                    <value>Blue</value>
                </item>

                <item selected="false">
                    <label>Red</label>
                    <value>Red</value>
                </item>

                <item selected="false">
                    <label>Green</label>
                    <value>Green 2</value>
                </item>

                <item selected="false">
                    <label>Yellow</label>
                    <value>Yellow</value>
                </item>
            </select>

        </context>
    </ruleSet>
</displayRules>

In dieser Konfigurationsdatei kann innerhalb des Attributs projectName festgelegt werden, für welche Projekte diese individuell konfigurierte Anzeige gelten soll.

Die mit ref angegebenen IDs verweisen auf die Metadaten-Namen, die in der Datenbank zu dem entsprechenden Projekt (bzw. Vorgang) existieren.

Die meisten Elemente haben ein Unterelement label. Dieses kann einen Text beinhalten, der das Input-Feld beschreibt. Üblicherweise ist das der Name des entsprechenden Metadatums, er kann jedoch zur besseren Lesbarkeit auch davon abweichen.

Darüber hinaus kann aus einer Liste verschiedener Feldtypen ausgewählt werden:

Input Box

Der Typ input wird als normales einzeiliges Eingabefeld dargestellt.

<input ref="PlaceOfPublication">
    <label>Göttingen</label>
</input>

Text Area

Der Typ textarea ist ähnlich zur Input Box. Eine Text-Area ist jedoch mehrzeilig und erlaubt eine Anpassung der Anzeigegröße des Feldes.

<textarea ref="TitleDocMain">
    <label />
</textarea>

Read only Field

Der Typ readonly ist ähnlich zur Input Box, allerdings erlaubt dieses keine Änderung des Feldinhalts.

<readonly ref="CatalogIDDigital">
    <label />
</readonly>

Select Box

Die Select Box select1 erlaubt die Auswahl eines Wertes aus einer Liste von Werten. Hierbei wird zwischen dem angezeigten Wert (label) und dem tatsächlich intern zu speichernden Wert (value) unterschieden. Mit dem selected Parameter kann ein <item> Element vorausgewählt werden.

<select1 ref="singleDigCollection">
    <item selected="true">
        <label>Default</label>
        <value>DefaultCollection</value>
    </item>
    <item selected="false">
        <label>Biology</label>
        <value>Biology</value>
    </item>
    <item selected="false">
        <label>Physics</label>
        <value>Physics</value>
    </item>
    <item selected="false">
        <label>Mathematics</label>
        <value>Mathematics</value>
    </item>
</select1>

Multi Select Box

Die Multi Select Box select erlaubt die Auswahl mehrerer Werte, die alle innerhalb des Metadatenfeldes gespeichert werden sollen. Auch hier wird zwischen dem anzeigten Wert (label) und dem intern gespeicherten Wert (value) unterschieden. Mit dem selected Parameter können mehrere <item> Elemente vorausgewählt werden.

<select ref="Classification">
    <item selected="true">
        <label>Default classification</label>
        <value>DefaultClassification</value>
    </item>
    <item selected="false">
        <label>Classification 1</label>
        <value>Classification 1</value>
    </item>
    <item selected="false">
        <label>Classification 2</label>
        <value>Classification 2</value>
    </item>
    <item selected="false">
        <label>Classification 3</label>
        <value>Classification 3</value>
    </item>
</select>

HTML Input

Der Feldtyp htmlInput erlaubt die Eingabe von Texten mit optischen Formatierungsmöglichkeiten. So lässt sich beispielsweise Text fett oder kursiv auszeichnen und wird samt den Formatierungen in der METS-Datei gespeichert.

<htmlInput ref="Description">
    <label></label>
</htmlInput>

GeoNames

Der Typ geonames erlaubt die Suche und Auswahl von Orten innerhalb der GeoNames-Datenbank.

<!-- Geonames as selectable field, in ruleset the PlaceOfPublication has to have this attribute then: normdata="true" -->
<geonames ref="PlaceOfPublication">
    <label></label>
</geonames>

GND

Der Feldtyp gnd erlaubt die Suche und Datenübernahme von Einträgen aus der Gemeinsamen Normdatenbank der Deutschen Nationalbibliothek.

<gnd ref="Subject">
    <label />
</gnd>

Dante

Der Feldtyp dante erlaubt die Nutzung des Dante-Vokabularservers des GBV. Hierbei können sämtliche zur Verfügung gestellten Vokabulare konfiguriert werden. Eine vollständige Liste der zur Verfügung stehenden Vokabulare findet sich unter der folgenden Adresse innerhalb des notation Elements:

https://api.dante.gbv.de/voc

<dante ref="DocLanguage">
    <source>languages_gnd</source>
    <field>NORM_LABEL_de, NORM_LABEL_en, NORM_LABEL_fr, NORM_LABEL_es</field>
</dante>

VIAF

Der Feldtyp viaf erlaubt die Datenübernahme aus der VIAF-Datenbank über alle integrierten Normdatenbanken verschiedener Nationalbibliotheken hinweg.

Beispiel für Personen

<viaf ref="Author">
    <source>100__a; 400__a; 700_a</source>
    <field>001=NORM_IDENTIFIER; 0247_a=URI; 1001_a=NORM_NAME; 1001_d=NORM_LIFEPERIOD; 1001_q=NORM_SEX; 375__a=NORM_SEX;  700__a=NORM_ALTNAME</field>
</viaf>

Beispiel für Orte:

<viaf ref="PlaceOfPublication">
    <!-- # Format: 'mmmiis' -->
    <!-- # mmm - MARC main field -->
    <!-- # ii - indicator 1 + 2 (_ if empty) -->
    <!-- # s - MARC subfield -->
    <source>210__a; 111__a; 100__a; 110__a; 150__a; 151__a;</source>

    <!-- # Format: 'mmmiis=label' -->
    <!-- # mmm - MARC main field -->
    <!-- # ii - indicator 1 + 2 (_ if empty) -->
    <!-- # s - MARC subfield -->
    <!-- # label - label of the field, can be used as message key -->
    <field>001=NORM_IDENTIFIER; 0247_a=URI;</field>
</viaf>

Vokabularmanager - Liste

Der Feldtyp vocabularyList erlaubt die Datenübernahme aus einem konkreten Vokabular des Vokabularmanagers von Goobi workflow. Innerhalb von source ist hierbei das zu verwendende Vokabular genannt.

<vocabularyList ref="singleDigCollection">
    <source>Digital collections</source>
</vocabularyList>

Sollen nicht alle Werte des Vokabulars aufgeführt werden, so kann mittels field eine Einschränkung für eines oder mehrere Felder definiert werden, die einen bestimmten Wert enthalten sollen:

<vocabularyList ref="singleDigCollection">
    <source>Digital collections</source>
    <field>public=true;</field>
</vocabularyList>

Vokabularmanager - Dialogauswahl

Soll der Inhalt eines Vokabulars aus dem Goobi Vokabularmanager über eine Suchbox möglich sein, wird der Typ vocabularySearch verwendet. Hierbei kann mittels field definiert werden, welche Felder der Datensätze angezeigt werden sollen.

<vocabularySearch ref="SubjectTopic">
    <source>Languages</source>
    <field>Name; Full Name; Description</field>
</vocabularySearch>

Personen

Mit dem Typ person kann eine Person ausgewählt werden. Die Person kann mit den Elementen source> und <field> näher spezifiziert werden.

<person ref="Name">
    <source>Source</source>
    <field>Field</field>
</person>

Unternehmen

Mit dem Typ corporate kann ein Unternehmen ausgewählt werden. Das Unternehmen kann mit den Elementen source> und <field> näher spezifiziert werden.

<corporate ref="Name">
    <source>Source</source>
    <field>Field</field>
</corporate>

Vorgänge

Mit dem Typ process kann ein Vorgang ausgewählt werden. Der Vorgang kann mit den Elementen source> und <field> näher spezifiziert werden.

<process ref="Title">
    <source>Source</source>
    <field>Field</field>
</process>

Kultur Nav

Der Typ kulturnav erlaubt die Datenübernahme aus der Kulturnav-Datenbank über alle integrierten Normdatenbanken verschiedener Nationalbibliotheken hinweg. Mit der Referenz person und dem <source> Element können zum Beispiel Personendaten abgefragt werden.

<kulturnav ref="person">
    <source>entityType:Person, entity.dataset:d519f76b-5ce5-4876-906e-7d31a76eb609</source>
</kulturnav>

Datenbank easydb

Mit dem Typ easydb kann eine easydb Datenbank für das Importieren von Informationen angegeben werden.

Das Element easydb definiert den gewünschten Metadatentyp, im Attribut ref wird der Name des Metadatums konfiguriert, auf den der Eintrag zutreffen soll. Das Element source enthält die ID der easydb Instanz, in der die Suche erfolgen soll. Der Wert muss einer instance ID aus der Datei plugin_metadata_easydb.xml entsprechen. In field steht die ID der zu nutzenden Suche. Die Zuordnung erfolgt über das Element ID im search Bereich der Datei in plugin_metadata_easydb.xml. Damit kann für jedes Metadatum eine individuelle Suchanfrage in einer eigenen easydb Instanz konfiguriert werden. Die einzelnen Suchanfragen lassen sich jedoch auch nachnutzen und können bei mehreren Metadaten in field eingetragen werden.

<easydb ref="MetadataName">
    <source>Prize Papers EasyDB</source>
    <field>JourneySearch</field>
</easydb>

Generierung von Metadaten aus anderen Werten

Mit dem Typ generate kann eine Regel zur Generierung des Feldes definiert werden. Dabei kann auf den Inhalt anderer Metadaten oder Goobi-Variablen zurückgegriffen werden. Im Attribut ref wird der Name des Metadatums konfiguriert, auf den der Eintrag zutreffen soll. Wenn die Regel nur für bestimmte Datensätze gelten soll, kann optional in <condition> ein XPath Ausdruck angegeben werden, der erfüllt werden muss. Im Gegensatz zu den anderen Elementen ist dieses Feld wiederholbar und erlaubt daher Konfigurationen für ein Feld mit unterschiedlichen Bedingungen. Wenn die Generierung ausgeführt wird, werden alle Einträge von oben nach unten abgearbeitet und der erste Eintrag genutzt, bei dem die Bedinung erfüllt ist oder bei dem keine Bedinung festgelegt wurde.

Das Element <value> enthält den zu bildenden Text. Dabei können beliebige Platzhalter in Form von [NAME] verwendet werden.

Die einzelnen Parameter werden dann innerhalb der <item> Elemente definiert. Jedes Element enthält ein <label> mit dem Namen des zu ersetzenden Platzhalters und einen <type>. Der kann entweder xpath oder variable sein. Bei xpath wird der zu suchende Wert mittels XPAth Ausdruck innerhalb des aktuellen Strukturelements gesucht, bei variable kann auf die Daten des VariablenReplacers des aktuellen Vorgangs zurückgegriffen werden. Mittels <regularExpression> und <replacement> lässt sich der ermittelte Wert noch manipulieren. Wenn ein Wert gefunden wurde, wird der Platzhalter im Text ersetzt.

<generate ref="TitleDocMain">
    <condition>goobi:metadata[@name='genre'][text()='Letter']</condition>
    <value>Letter from [ACTOR_FROM] to [ACTOR_TO] at [PLACE], [DATE]</value>

    <item>
        <label>ACTOR_FROM</label>
        <type>xpath</type>
        <field>goobi:metadata[@type='person'][@name='Creator']/goobi:displayName</field>
        <regularExpression>(.+), (.+)</regularExpression>
        <replacement>$2 $1</replacement>
    </item>
    <item>
        <label>ACTOR_TO</label>
        <type>xpath</type>
        <field>goobi:metadata[@type='person'][@name='Receiver']/goobi:displayName</field>
        <regularExpression>(.+), (.+)</regularExpression>
        <replacement>$2 $1</replacement>
    </item>
    <item>
        <label>PLACE</label>
        <type>xpath</type>
        <field>goobi:metadata[@type='group'][@name='location_related_place'][goobi:metadata[@name='location_holdingExternal_relation_type'][text()='is bound from']]/goobi:metadata[@name='location_physicalLocation_related_place']</field>
    </item>
    <item>
        <label>DATE</label>
        <type>variable</type>
        <field>{meta.PublicationYear}</field>
        <regularExpression>([0-9]{4})-[0-9]{2}-[(0-9]{2}</regularExpression>
        <replacement>$1</replacement>
    </item>
</generate>

Die Konfigurationsdatei goobi_digitalCollections.xml ist für die Steuerung der Auswahlliste von digitalen Sammlungen zuständig. Sie befindet sich üblicherweise an folgendem Pfad im Dateisystem:

/opt/digiverso/goobi/config/goobi_digitalCollections.xml

In dieser Konfigurationsdatei wird festgelegt, welche Sammlungen grundsätzlich existieren, und innerhalb welcher Projekte diese zur Auswahl stehen sollen.

<?xml version="1.0" encoding="UTF-8"?>
<DigitalCollections>
	<default>
		<DigitalCollection>General</DigitalCollection>
		<DigitalCollection>Biology</DigitalCollection>
		<DigitalCollection>Physics</DigitalCollection>
		<DigitalCollection>Mathematics</DigitalCollection>
	</default>
</DigitalCollections>

Sollen Sammlungen mit Untersammlungen konfiguriert werden, so werden diese mit dem Trennzeichen # voneinander getrennt. Dies sieht beispielhaft folgendermaßen aus:

<?xml version="1.0" encoding="UTF-8"?>
<DigitalCollections>
	<default>
		<DigitalCollection>General</DigitalCollection>
		<DigitalCollection>Biology</DigitalCollection>
		<DigitalCollection>Biology#Animals</DigitalCollection>
		<DigitalCollection>Biology#Plants</DigitalCollection>
	</default>
</DigitalCollections>

Sollen die Sammlungen je nach Projekt unterschiedlich konfiguriert werden, so kann dies folgendermaßen erfolgen:

<?xml version="1.0" encoding="UTF-8"?>
<DigitalCollections>
  <default>
    <DigitalCollection>General</DigitalCollection>
  </default>
  <project>
    <name>Archive Project</name>
    <DigitalCollection>Monographs</DigitalCollection>
    <DigitalCollection>Files</DigitalCollection>
    <DigitalCollection>Maps</DigitalCollection>
  </project>
  <project>
    <name>Newspapers</name>
    <DigitalCollection>1920 - 1930</DigitalCollection>
    <DigitalCollection>1930 - 1940</DigitalCollection>
    <DigitalCollection>1940 - 1950</DigitalCollection>
  </project>
</DigitalCollections>

Mit der Konfigurationsdatei goobi_webapi.xml werden bestimmte API Endpunkte des Goobi Workflow Servers für andere Server oder Clients freigeschaltet. Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

/opt/digiverso/goobi/config/goobi_webapi.xml

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

<?xml version="1.0"?>
<config_webapi>
  <credentials ip="0:0:0:0:0:0:0:1" password="CHANGEME">
    <command name="closeStep"/>
    <command name="addToProcessLog"/>
    <command name="setErrorStep"/>
    <command name="help"/>
  </credentials>
  <credentials ip="127.0.0.1" password="CHANGEME">
    <command name="closeStep"/>
    <command name="addToProcessLog"/>
    <command name="setErrorStep"/>
    <command name="help"/>
  </credentials>
  <credentials ip="10.20.30.40" password="super_admin_password">
    <command name="/"/>
  </credentials>
  <credentials ip="20.40.60.80" password="admin_password">
    <command name="/process"/>
  </credentials>
  <credentials ip="40.60.80.100" password="user_password">
    <command name="/process/check"/>
  </credentials>
</config_webapi>

Goobi Workflow stellt eine REST-API zur Verfügung, bei der zwischen dem Goobi Workflow Server und anderen Netzwerkteilnehmern mittels HTTPS Protokoll und JSON Datenobjekten kommuniziert wird.

Die Funktionen, die mit der API ausgeführt werden, sind als Endpunkte in der URL angegeben. Zum Beispiel gibt folgende URL die Details eines Vorgangs mit der angegebenen ID MY_ID zurück:

http://goobi.your-domain.org/Goobi/api/process/details/id/MY_ID?token=test

Es gibt allerdings auch Befehle wie process/create oder process/delete, die nur von bestimmten Nutzern ausgeführt werden dürfen.

Ein Nutzer kann ein anderer Server oder Client sein. In beiden Fällen braucht er eine feste IP-Adresse, für die der Zugriff freigeschaltet wird.

Für jedes Zugriffsrecht wird ein <credentials> Element verwendet. Der ip Parameter beinhaltet entweder die IPv4-Adresse oder die IPv6-Adresse des Nutzers. Mit dem password Parameter wird ein Token angegeben, das in einer Anfrage von der jeweiligen Nutzer-IP-Adresse als URL-Parameter angegeben werden muss. Ist zum Beispiel in der Zugriffsregel für die IP-Adresse ip="10.20.30.40" das Token password="super_user_password" angegeben, so kann eine API-Anfrage nur beantwortet werden, wenn der Nutzer mit der IPv4-Adresse 10.20.30.40 den URL-Parameter token=super_user_password verwendet.

Das Token sollte keine Sonderzeichen oder URL-Syntax Zeichen beinhalten. Andernfalls müssen diese entsprechend der URL-Spezifikation später in der Anfrage codiert werden. Ist in der Zugriffsregel das Token My Password angegeben, so muss das Leerzeichen in der Anfrage-URL durch den Hexadezimalwert 0x20 ersetzt werden und der URL-Parameter sieht wie folgt aus: token=My%20Password.

Jede Zugriffsregel beinhaltet einen oder mehrere API-Befehle. Diese Befehle oder Befehlsgruppen können verwendet werden, sobald die oben beschriebene Kombination von IP-Adresse und Token übereinstimmt. Ein Befehl wird mit dem <command> Element definiert und hat genau einen Parameter name, der den Befehl beinhaltet. Der Befehl selbst kann optional mit einem Schrägstrich (/) beginnen.

Im obigen Beispiel sind drei Zugriffsregeln angegeben, die die unterschiedlichen Zugriffsrechte für verschiedene Anwendergruppen definieren. So hat ein Superadministrator die Möglichkeit, alle API-Befehle (/) zu benutzen. Ein normaler Administrator kann alle Unterbefehle von process ausführen. Für einen Standardnutzer ist nur der Befehl process/check freigeschaltet.

In der Konfigurationsdatei goobi_config.properties werden einige grundlegende Einstellungen für Goobi Workflow eingestellt. Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

/opt/digiverso/goobi/config/goobi_config.properties

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

# -----------------------------------
# application information
# -----------------------------------

ApplicationTitle=http://goobi.io
ApplicationHeaderTitle=Goobi workflow

# Text that describes the website
ApplicationHomepageMsg=info
ApplicationWebsiteMsg=info

# Developer mode (true) or production mode (false)
developing=false

# -----------------------------------
# directories
# -----------------------------------

# Main folder for Goobi incl. subfolders config, xslt, rulesets, metadata etc.
# Path configured here should end with path separator
# sample and default if missing: /opt/digiverso/goobi/
goobiFolder=/opt/digiverso/goobi/

# use this folder if metadata directory is not goobiFolder + metadata/
#dataFolder=

# parent folder for home directories, default is goobiFolder + users/
#dir_Users=/home/

#folder for debugging files, can be used by opac beautifier 
#debugFolder=

# folder for the process log
# for compatibility reasons, also folder_processlog_internal is requested
#folder_journal_internal=intern

# folder for mass upload functionality
#doneDirectoryName=fertig/

# path for swapping, this could for example be /tmp/unused/
#swapPath=

# naming rule for master folder 
#process.folder.images.master={processtitle}_master

# naming rule for media folder
#process.folder.images.main={processtitle}_media

# naming rule for source folder
#process.folder.images.source={processtitle}_source

# naming rule for image fallback folder - not needed any more, is replaced with thumbs directories
# default value is an empty string
#process.folder.images.fallback={processtitle}_jpeg

# naming rule for ocr text folder
#process.folder.ocr.txt={processtitle}_txt

# naming rule for pdf folder
#process.folder.ocr.pdf={processtitle}_pdf

# naming rule for ocr xml folder
#process.folder.ocr.xml={processtitle}_xml

# naming rule for ocr alto folder
#process.folder.ocr.alto={processtitle}_alto

# naming rule for import folder
#process.folder.import=import

# naming rule for export folder
#process.folder.export=export

# create master directory if it does not exist
createOrigFolderIfNotExists=true

# indicates whether the source folder should be created automaticly or not, default is false
createSourceFolder=false

# -----------------------------------
# global user settings
# -----------------------------------

# set a default language, language can be changed by the user. If no language is set, the browser default is used
#defaultLanguage=

# anonymized statistics, displaying user on steps, etc
# possible values: true/false
anonymize=false

# enable or disable usage of gravatar icons
#enableGravatar=true

# The minimum password length for user accounts
# This value is also used for new generated passwords, they are generated with
# this length + 10
minimumPasswordLength=8

# Multiple additional user rights can be set here, default is an empty list
userRight=

# -----------------------------------
# user interface features
# -----------------------------------

ui_useIntrandaUI=true

# include the file accessibility.css in the template. Can be overwritten in user settings
renderAccessibilityCss=false

# show statistics box on startpage, default is true
showStatisticsOnStartPage=true

# enable or disable the finalize button in task/batch edition screens. The default value is to display the button
#TaskEnableFinalizeButton=true

#show button to link into home directory
#ui_showFolderLinkingInProcessList=false

#display confirmation dialogue when link into home directory is set from process list 
#confirmLinking=false

# A button to reimport already exported content can be activated
#renderReimport=false

# use this parameter to exlude user agents from session list
excludeMonitoringAgentName=Munin
excludeMonitoringAgentName=munin
excludeMonitoringAgentName=nagios-plugins
excludeMonitoringAgentName=monitoring-plugins
excludeMonitoringAgentName=ELB-HealthChecker/2.0
excludeMonitoringAgentName=python-requests

# -----------------------------------
# ldap
# -----------------------------------

# Logins ueber LDAP verwenden
ldap_use=false

# -----------------------------------
# truststore
# -----------------------------------

# Keystore for LDAP and other services
# There is no default value, but it can look like this example:
# /opt/digiverso/goobi/scripts/mykeystore.ks
#truststore=
#truststore_password=

# -----------------------------------
# open id connect
# -----------------------------------

# Must be set to true to use OpenID Connect
#useOpenIdConnect=false
# Automatic redirection to OpenID Connect login
#OIDCAutoRedirect=false
# The OpenID Connect authentication server
#OIDCAuthEndpoint=
# API endpoint for logout command
#OIDCLogoutEndpoint=
# The issuer of OpenID Connect
#OIDCIssuer=
# The JWK set of OpenID Connect
#OIDCJWKSet=
# The client ID of this server
#OIDCClientID=
# The notifying method
#OIDCIdClaim=email
# Can be set to true to use SSO logout
#useOIDCSSOLogout=false

# -----------------------------------
# single sign on
# -----------------------------------

# Enables a login method via HTTP header field
#EnableHeaderLogin=false
# The login type via the HTTP header field
#SsoParameterType=header
# The name of the HTTP header field to login
#SsoHeaderName=Casauthn
# Enables a logout page for 
#showSSOLogoutPage=false

# -----------------------------------
# external users
# -----------------------------------

# enable an additional login area for external users, it allows a different UI and a self registration 
#EnableExternalUserLogin=false

# assign the self registered users to this institution, this could be "goobi" for example
#ExternalUserDefaultInstitution=

# assign the self registered users to this authentication type
#ExternalUserDefaultAuthentication=

# -----------------------------------
# database search
# -----------------------------------

# enable fulltext search mode for metadata searches. Doesn't work on h2 or older mysql/mariadb databases
useFulltextSearch=false

# configure fulltext search mode, possible values are 'NATURAL LANGUAGE MODE' or 'BOOLEAN MODE'
# see https://www.w3resource.com/mysql/mysql-full-text-search-functions.php
#FulltextSearchMode=BOOLEAN MODE

#truncation characters in sql queries
#DatabaseLeftTruncationCharacter=%
#DatabaseRightTruncationCharacter=%

# enable this to use a specific index for my tasks queries. The best table index might be different from database to database
# if commented out, no specific index is used
#SqlTasksIndexname=status_x_title

#generate one metadata index field for multiple metadata coming from the METS file
#index.ids=CatalogIDDigital,CatalogIDSource

# -----------------------------------
# processes and process log
# -----------------------------------

# Set this to true to automatically reset the process log if processes are cloned
#ProcessCreationResetJournal=false

# allow white spaces in directory names or replace them with __
#dir_allowWhiteSpaces=false

# allow import with plugin mechanism for mass imports
massImportAllowed=false

# allow process title duplication
#MassImportUniqueTitle=true

# number of maximal items per batch, if not configured the default is 100
batchMaxSize=500

# enables the option to see the last edition date, username and title of the last finished step
ProcesslistShowEditionData=false

# Defines the start times of the daily delay job, the daily vocab job and the daily history analyser job
# If missing or value is -1, the job is disabled.
# Every other number is interpreted as MILLISECONDS after midnight.
# These values are requested by org.goobi.production.flow.jobs.JobManager
dailyDelayJob=-1
dailyVocabJob=-1
dailyHistoryAnalyser=-1

# This is the upload frequency of the goobi authentication server in MINUTES
# This value is requested by org.goobi.production.flow.jobs.JobManager
goobiAuthorityServerUploadFrequencyInMinutes=-1

# Activates additional columns for search result
downloadAvailableColumn=CatalogIdDigital
downloadAvailableColumn=TitleDocMain
downloadAvailableColumn=PublicationYear
downloadAvailableColumn=PlaceOfPublication

# Text templates for error reporting and problem solutions
#task.error.Missing\ pages=The following pages are missing: {}
#task.error.Blurred\ images=The images {} are unsharp. Please create these again.
#task.solution.Problem\ solved=The problem was solved. {}
#task.solution.The\ original\ print\ is\ blurred=The original pages are printed blurry. It is not possible to create sharper images. {}

# -----------------------------------
# scripts
# -----------------------------------

# These values can be set to paths to bash script files that do the concerning tasks
#script_createDirUserHome=
#script_createDirMeta=
#script_createSymLink=
#script_deleteSymLink=

# -----------------------------------
# s3 bucket
# -----------------------------------

# Can be set to true to enable S3 usage
#useS3=false

# Can be set to true to use a custom S3 service
#useCustomS3=false

# If useCustomS3 is enabled, the endpoint can be specified here
#S3Endpoint=

# The used S3 bucket is specified here
#S3bucket=

# The access id of the account of goobi against the S3 service
#S3AccessKeyID=

# The secret access key of that account
#S3SecretAccessKey=

# The number of retries if a connection does not succeed
#S3ConnectionRetry=10

# The timeout for any connection tries
#S3ConnectionTimeout=10000

# The timeout for socket concerning things
#S3SocketTimeout=10000

# -----------------------------------
# proxy server
# -----------------------------------

http_proxyEnabled=false
#http_proxyUrl=127.0.0.1
#http_proxyPort=3128
http_proxyIgnoreHost=127.0.0.1
http_proxyIgnoreHost=localhost

# -----------------------------------
# internal servers and interfaces
# -----------------------------------

# allow external programms to send commands to Goobi via WebAPI
useWebApi=false

# The token salt value can be used to make authentication on the Goobi REST API more secure
#apiTokenSalt=

#the jwtSecret is needed to (among others) authenticate mail delivery deactivation
#jwtSecret=

# goobi base url, can be used when url cannot be detected from user sessions
goobiUrl=http://localhost:8080/goobi

#The url of the plugin server of goobi
#pluginServerUrl=

# Basispfad fuer OCR (ohne Parameter)
ocrUrl=

# TimeOut for GoobiContentServlet-Request via HTTP in ms (default value, if nothing defined here: 60000)
goobiContentServerTimeOut=30000

# The url, the user name, the password and the upload frequency can be set
# for the content server here
goobiAuthorityServerUrl=
goobiAuthorityServerUser=
goobiAuthorityServerPassword=
goobiAuthorityServerUploadFrequency=

# account name for geonames api
#geonames_account=

# -----------------------------------
# message broker
# -----------------------------------

# Set this to true to let the message broker start
#MessageBrokerStart=false

# The default value is the configuration folder + "goobi_activemq.xml"
#ActiveMQConfig=

# The server IP or domain of the message broker
#MessageBrokerServer=localhost

# The port number of the message broker
#MessageBrokerPort=61616

# The password to access the message broker
#MessageBrokerPassword=

# The number of parallel messages can be set here
#MessageBrokerNumberOfParallelMessages=1

# External Queues can be enabled here
allowExternalQueue=false

# The type of the external queue, currently the possible values are "SQS" and "activeMQ"
externalQueueType=activeMQ

#set this to true if you want to test the SQS external queue with elasticMQ
useLocalSQS=false

# -----------------------------------
# mets editor
## mets editor / general properties
# -----------------------------------

# initialise all sub elements in Mets editor to assign default values, default value is true
MetsEditorEnableDefaultInitialisation=true

# create pagination when mets editor is opened 
#MetsEditorEnableImageAssignment=true

# use special pagination type for automatic default pagination (uncounted, roman, arabic)
MetsEditorDefaultPagination=uncounted

# configure the locking time for mets editor timeout in ms, default is 30 minutes
MetsEditorLockingTime=1800000

# use external ocr for text in mets editor or use existing files 
#MetsEditorUseExternalOCR=false

# The number of backups can be set here. 0 means that no backups are created
numberOfMetaBackups=0

# -----------------------------------
## mets editor / user interface
# -----------------------------------

# OCR-Button fuer ausgewaehltes Strukturelement anzeigen
showOcrButton=false

# Display the METS editor area for manipulation of the image set
MetsEditorDisplayFileManipulation=false

# Display archived folders
MetsEditorShowArchivedFolder=false

# display/hide metadata popup in structure tree
#MetsEditorShowMetadataPopup=true

# use a maximum of characters to display titles in the left part of mets editor, the default value is 0 (everything is displayed)  
MetsEditorMaxTitleLength=0

# -----------------------------------
## mets editor / images and thumbnails
# -----------------------------------

# enable to show image comments in METS editor, imageQA and LayoutWizzard
ShowImageComments=false

# Number of images in thumbnail view
MetsEditorNumberOfImagesPerPage=96

# This value can be set to true to use image tiling in the METS editor
MetsEditorUseImageTiles=true

# sorting of images
# At this time implemented sorting options:
# number (default): 1 is lesser then 002, compares the number of image names, characters other than digits are not supported
# alphanumeric: 1 is greater then 002, compares character by character of image names, all characters are supported
ImageSorting=number

# Prefix for image names as regex. Default is 8 digits \\d{8} and gets validated
ImagePrefix=\\w+
#ImagePrefix=\\d{8}
#ImagePrefix=.+

# define owner of images, when read access is provided. Default is root user 
#UserForImageReading=root

# This can be set to true to use image thumbnails
UseImageThumbnails=true

# Size of thumbnails in METS editor
MetsEditorThumbnailsize=200

# Maximum number of requested thumbnails to not overload the server
MaxParallelThumbnailRequests=100

# The maximum image size in pixels
MetsEditorMaxImageSize=15000

# The maximum image size in bytes, MaxImageFileSizeUnit must be set as factor
MaxImageFileSize=4000

# The unit for the maximum image size in bytes, MaxImageFileSize must be set as numeric value
MaxImageFileSizeUnit=MB

# Sizes for big images in METS editor to allow standard display and deep zoom
# This value can be set multiple times
MetsEditorImageSize=

# The size of image tiles
# This value can be set multiple times
MetsEditorImageTileSize=

# The scale of image tiles
# This value can be set multiple times
MetsEditorImageTileScale=

# A list of image file types that are used for process checks
historyImageSuffix=.tif

# -----------------------------------
## mets editor / validation
# -----------------------------------

# grundsaetzliche Metadatenvalidierung durchfuehren oder nicht
useMetadatenvalidierung=true

# Validate the images in the METS editor
MetsEditorValidateImages=true

# regular expression to check if the process title is valid
validateProcessTitelRegex=[\\w-]*

# regular expression for all characters to remove in title generation
ProcessTitleGenerationRegex=[^\\w-]

# -----------------------------------
## mets editor / export
# -----------------------------------

# The path to the exif tool to export the images
ExportExiftoolPath=/usr/bin/exiftool

# set if Master-Images-Folder 'orig_' should be used at all
useOrigFolder=true

# if this parameter is missing or 'false' the old export mechanism is used, otherwise there is no timelimit for export 
exportWithoutTimeLimit=true

# Validate images on mets export. Default value is true
ExportValidateImages=true

# Defines the name of the metadata field where the project title gets exported.
# If the field is empty, missing or contains an unknown value, the project title is not written.
#ExportMetadataForProject=MetadataName

# Defines the name of the metadata field where the institution name gets exported.
# If the field is empty, missing or contains an unknown value, the institution name is not written.
#ExportMetadataForInstitution=MetadataName

# Defines the name of the metadata field where the dfg viewer link gets exported.
# If the field is empty, missing or contains an unknown value, the link is not written.
#ExportMetadataForDfgViewerUrl=MetadataName

# Define if files shall get exported if optional file groups for these files are configured
ExportFilesFromOptionalMetsFileGroups=false

# export in temporary file, move it to destination or export directly to destination
ExportInTemporaryFile=false

# Use UUID for each file id instead of incremental numbers
ExportCreateUUID=true

# Create premis elements for technical metadata for each exorted file  
ExportCreateTechnicalMetadata=false

# Define here if in the automatic export images shall be exported too or not
automaticExportWithImages=true

# Define here if in the automatic export OCR results shall be exported too or not
automaticExportWithOcr=true

# Allow the PDF generation as downloadable file instead of storing it into the users home directory
pdfAsDownload=true

Allgemeines

Diese Konfigurationsdatei wird schon seit sehr langer Zeit in Goobi Workflow verwendet und beinhaltet daher teilweise veraltete Einstellungen, die heutzutage nur noch aus Kompatibilitätsgründen unterstützt werden. Diese sind gesondert gekennzeichnet und beschreiben gegebenenfalls eine Alternative, wie diese Einstellungen zu ersetzen sind.

Da die Einstellungen über einen langen Zeitraum ergänzt wurden und immer noch werden, haben sich immer wieder andere Namenskonventionen in den Variablennamen bewährt. Daher muss insbesondere auf den richtigen Gebrauch von Groß- und Kleinschreibung sowie Unterstrichen und Punkten in den Variablennamen geachtet werden.

Diese Konfigurationsdatei beinhaltet Einstellungen zu vielen unterschiedlichen Themen. Teilweise lässt es sich nicht vermeiden, dass bestimmte Einstellungen zu mehreren Themen passen und je nach Anwendungszweck auch in verschiedenen Kategorien stehen können. Sollten bestimmte Einstellungen nicht an der erwarteten Stelle wiederzufinden sein, wird empfohlen, mit der Suchfunktion des Browsers (üblicherweise Strg+F) die Seite zu durchsuchen.

Viele Einstellungen haben Standardwerte, die so gewählt sind, dass sie für die meisten Anwender sinnvoll sind. Daher müssen nicht alle Einstellungen in der Konfigurationsdatei angegeben werden oder können einfach auskommentiert werden.

Kommentare werden mit einem Raute-Symbol (#) am Zeilenanfang markiert. Dies ist auch nützlich, um Einstellungen zu deaktivieren.

# Dies ist ein Kommentar und wird ignoriert
# setting=Dies ist eine Einstellung, die auch ignoriert wird
setting=Diese Einstellung wird verwendet

Verwendete Datentypen

Für die Einstellungen in dieser Konfigurationsdatei sind Datentypen angegeben. Sofern es nicht anders angegeben ist, sind folgende Werte zulässig:

Basisinformationen über Goobi Workflow

Es gibt einige grundlegende Informationen über die installierte Goobi Workflow-Instanz und über Goobi allgemein, die in der Konfiguration angegeben und teilweise auf der Login-Seite im Webbrowser angezeigt werden.

Verzeichnisse

Es können einige Verzeichnispfade in der Konfigurationsdatei gesetzt werden. Die meisten davon werden relativ zum Goobi-Verzeichnis angegeben. Das Goobi-Verzeichnis befindet sich üblicherweise in /opt/digiverso/goobi/.

Einige Verzeichnisse beinhalten die Textsequenz {processtitle}. Diese wird in den jeweiligen Verzeichnisnamen verwendet, um den automatisch generierten Titel eines Vorgangs einzusetzen. Damit wird erreicht, dass die entsprechenden Verzeichnisse für jeden Vorgang separat angelegt und verwendet werden.

Allgemeine Nutzer-Einstellungen

Alle benutzerdefinierten Nutzereinstellungen speichert Goobi Workflow in der intern verwendeten Datenbank. Die hier angegebenen Einstellungen sind für Seiten relevant, auf denen kein Nutzer angemeldet ist (zum Beispiel die Login-Seite) und daher die nutzerspezifischen Einstellungen nicht existieren. Andere Einstellungen in dieser Kategorie gelten für alle Nutzer und sind nicht accountspezifisch anpassbar.

Minimale Passwort-Länge

Die Passwort-Länge wird nur beim Anlegen eines Accounts und beim Ändern des eigenen Passwortes geprüft. Bestehende und zu kurze Passwörter können weiter genutzt werden, sofern dieser Wert im Nachhinein erhöht wird.

Für Administratoren besteht die Möglichkeit, ein neues zufälliges Passwort für Nutzer zu generieren. Diese werden immer 10 Zeichen länger generiert, als es die minimale Passwort-Länge vorgibt.

Weitere Benutzerberechtigungen

Es können weitere Benutzerberechtigungen angegeben werden. Dazu wird für jede hinzugefügte Berechtigung ein neuer Eintrag mit der Eigenschaft userRight vorgenommen. Somit kann dieser Wert mehrfach vorkommen und wird von Goobi Workflow als Liste interpretiert.

Das kann zum Beispiel so aussehen:

userRight=Statistics_Latest
userRight=Statistics_Most_Relevant
userRight=Statistics_Users

Hinweis: Es sollten keine Benutzerberechtigungen eingetragen werden, deren Bezeichnung bereits in Goobi Workflow existieren. Dies kann zu falschem Verhalten von einigen Funktionen führen.

Zusätzliche Funktionen in der Benutzeroberfläche

Goobi Workflow lässt einige optionale Funktionalitäten für die Benutzeroberfläche im Webbrowser zu. Dafür gibt es folgende Schalter, die auf true gesetzt werden können, um Funktionalitäten zu aktivieren:

Die folgende Einstellung wird verwendet, um die Liste der angezeigten Sessions in der Session-Übersicht zu filtern. Die Einstellung selbst kann mehrfach verwendet werden, wobei jedes Mal ein Client-Name (zum Beispiel Browser-Name) angegeben wird, der aus der Session-Liste herausgefiltert werden soll.

Das sieht bei mehreren Namen zum Beispiel so aus:

excludeMonitoringAgentName=Munin
excludeMonitoringAgentName=munin
excludeMonitoringAgentName=nagios-plugins
excludeMonitoringAgentName=monitoring-plugins
excludeMonitoringAgentName=ELB-HealthChecker/2.0
excludeMonitoringAgentName=python-requests

LDAP aktivieren

Die eigentliche LDAP-Konfiguration befindet sich in der von Goobi Workflow verwendeten Datenbank. In dieser gibt es für jede verwendete LDAP-Gruppe einen Datensatz mit zahlreichen Einstellungsmöglichkeiten. Ob LDAP eingebunden wird, ist mit folgendem Parameter steuerbar.

Truststore konfigurieren

Der Truststore wird in Goobi Workflow verwendet, um Zertifikate und SSH-Schlüssel zu verwalten. Diese können zum Beispiel für die Authentifikation am LDAP-Server oder an anderen Servern verwendet werden. Um den Truststore verwenden zu können, ist die Konfiguration folgender Werte erforderlich.

OpenID Connect

Normalerweise werden Benutzeraccounts in der von Goobi Workflow verwalteten mariadb-Datenbank gespeichert. Zusätzlich gibt es die Möglichkeit, Benutzer mit OpenID-Accounts zu authentifizieren.

Single Sign On (SSO)

Mit SSO kann eine Authentifizierung über HTTP-Header zugelassen und konfiguriert werden. Diese erlaubt oder verbietet es, mittels HTTP-Header-Feldern bei einer Sitzung im Browser angemeldet zu bleiben.

Externe Benutzer einrichten

Mit den folgenden Einstellungen kann bestimmt werden, ob Benutzer mit externen Accounts am System angemeldet werden können und wie gegebenenfalls Standardwerte gesetzt werden sollen, die sonst für normale Accounts in der Datenbank existieren.

Datenbank-Einstellungen

In Goobi Workflow kann in Vorgängen, Aufgaben und anderen Datensätzen nach bestimmten Begriffen gesucht werden. Da die Suche von der im Hintergrund verwendeten SQL-Datenbank übernommen wird, stehen einige Einstellungen zur Verfügung, um die Suche an den Bedarf der jeweiligen Projekte anzupassen.

Bei den Einstellungen DatabaseLeftTruncationCharacter und DatabaseRightTruncationCharacter wird jeweils % angegeben. Das führt dazu, dass die Suche in der Datenbank mit SQL wie folgt ausgeführt wird (Dieses Beispiel dient lediglich der Veranschaulichung und funktioniert nicht so in der eigentlichen Datenbank):

SELECT Title FROM Book WHERE Book.Title LIKE "%suchbegriff%";

Es werden damit also alle Datensätze ausgewählt, in denen der Suchbegriff an beliebiger Stelle vorkommt. Wird zum Beispiel der Präfix % weggelassen und nach suchbegriff% gesucht, so kann am Anfang eines Datensatzes gesucht werden. Damit kann zum Beispiel nach allen Büchern gesucht werden, die mit "The" anfangen. Werden Präfix und Suffix weggelassen, so wird nur noch nach dem Suchbegriff gesucht und es werden alle Datensätze ausgewählt, die exakt dem Suchbegriff entsprechen.

Um Datenbanksuchen einfacher zu machen, können Aliasse definiert werden, mit denen mehrere Eigenschaften als eine Metaeigenschaft zusammengefasst werden. Wenn man zum Beispiel nach einer Person sucht, wäre es recht aufwändig, nach allen Autoren, Veröffentlichern, Sachbearbeitern, anderen Personen usw. zu suchen. Aus diesem Grund können Suchbegriffe aufgelistet und unter einem Namen zusammengefasst werden.

Zum Beispiel könnten folgende Aliasse konfiguriert werden:

index.Person=Author, OtherPerson, Publisher, Editor
index.Institution=University, Museum, Archive

Vorgänge und Vorgangslog

Mit den folgenden Einstellungen können das Vorgangs-Log und einige Details zur Bearbeitung von Vorgängen eingestellt werden.

Konfiguration von Jobs

Für automatisch ausgeführte Hintergrundprozesse kann angegeben werden, wann diese ausgeführt werden sollen. Die ersten drei Eigenschaften in der folgenden Liste, gekennzeichnet mit daily, werden jeden Tag ausgeführt. Die angegebene Zahl an Millisekunden ist die Zeit zwischen 0:00 Uhr und dem Zeitpunkt der Ausführung der Aufgabe. Das hat den Vorteil, dass bestimmte Aufgaben zum Beispiel nachts ausgeführt werden können, wenn die Auslastung des Servers gering ist.

Der zweite Vorteil dieser Konfiguration ist, dass die Tageszeiten entsprechend der Differenz zwischen Serverzeit und der meistbenutzten Nutzer-Tageszeit eingestellt werden können. Das kann vorkommen, wenn ein Server in einem anderen Land steht (oder UTC benutzt) und Mitarbeiter weltweit aus verschiedenen Zeitzonen zusammen auf dem Server arbeiten.

Wird -1 angegeben, so wird der entsprechende Job deaktiviert.

Die Anzahl der Millisekunden kann wie folgt berechnet werden:

• Eine Sekunde hat 1000 Millisekunden

• Eine Minute hat 60 Sekunden und damit 60 000 Millisekunden

• Eine Stunde hat 60 Minuten und damit 3 600 000 Millisekunden

• Ein Tag hat 24 Stunden und damit 86 400 000 Millisekunden

Der angegebene Zeitpunkt sollte also zwischen 0 und 86 400 000 liegen, um Fehler zu vermeiden. Ein paar Beispiele:

• Für 0:00 Uhr wird 0 angegeben

• Für 3:00 Uhr (3:00 AM) wird 3 * 3 600 000 = 10 800 000 angegeben

• Für 18:30 Uhr (6:30 PM) wird 18 * 3 600 000 + 30 * 60 000 = 66 600 000 angegeben

Für die Einstellung goobiAuthorityServerUploadFrequencyInMinutes wird eine Zeit in Minuten angegeben.

Herunterladbare Informationen

In Goobi Workflow können Vorgänge, Vorlagen, Werkstücke und Metadaten nicht nur gesucht und angezeigt, sondern auch in verschiedene Dateiformate exportiert und heruntergeladen werden. Dabei werden einige Daten aus der Datenbank standardmäßig bereits berücksichtigt:

• prozesse.Titel Der Titel eines Vorgangs

• prozesse.ProzesseID Die ID eines Vorgangs

• prozesse.erstellungsdatum Das Erstellungsdatum eines Vorgangs

• prozesse.sortHelperImages Die Anzahl an Bildern im Vorgang

• prozesse.sortHelperMetadata Die Anzahl an Metadaten im Vorgang

• projekte.Titel Der Titel des Projektes, in dem sich der Vorgang befindet

• log.lastError Der zuletzt erkannte Fehler in der Bearbeitung dieses Vorgangs

Zusätzlich können mit der Einstellung downloadAvailableColumn weitere Eigenschaften in den exportierten Dateien berücksichtigt werden. Dafür kann die genannte Einstellung mehrfach verwendet werden. Alle passenden Zeilen werden von Goobi Workflow zusammen eingelesen und als zusammenhängende Liste weiterverarbeitet.

In jeder Zeile wird genau ein Tabellen-Spaltenname aus der Goobi-Datenbank angegeben. Zur Verfügung stehen aktuell (Goobi Version 22.08) folgende Tabellenspalten:

• prozesseeigenschaften.prozesseeigenschaftenID

• prozesseeigenschaften.Titel

• prozesseeigenschaften.WERT

• prozesseeigenschaften.IstObligatorisch

• prozesseeigenschaften.DatentypenID

• prozesseeigenschaften.Auswahl

• prozesseeigenschaften.prozesseID

• prozesseeigenschaften.creationDate

• prozesseeigenschaften.container

• vorlageneigenschaften.vorlageneigenschaftenID

• vorlageneigenschaften.Titel

• vorlageneigenschaften.WERT

• vorlageneigenschaften.IstObligatorisch

• vorlageneigenschaften.DatentypenID

• vorlageneigenschaften.Auswahl

• vorlageneigenschaften.vorlagenID

• vorlageneigenschaften.creationDate

• vorlageneigenschaften.container

• werkstueckeeigenschaften.werkstueckeeigenschaftenID

• werkstueckeeigenschaften.Titel

• werkstueckeeigenschaften.WERT

• werkstueckeeigenschaften.IstObligatorisch

• werkstueckeeigenschaften.DatentypenID

• werkstueckeeigenschaften.Auswahl

• werkstueckeeigenschaften.werkstueckeID

• werkstueckeeigenschaften.creationDate

• werkstueckeeigenschaften.container

• metadata.processid

• metadata.name

• metadata.value

• metadata.print

Zu beachten ist, dass nur der Spaltenname in der Konfiguration angegeben wird. Andernfalls können die Spalten nicht gefunden werden, da die hier angegebenen Spaltennamen direkt mit den erwarteten Tabellennamen zusammengesetzt und gesucht werden. Das hat den Seiteneffekt, dass durch die Angabe von zum Beispiel Titel der Titel von Vorgängen, der Titel von Vorlagen und der Titel von Werkstücken berücksichtigt werden.

Es kann zum Beispiel folgende Konfiguration vorgenommen werden:

downloadAvailableColumn=Titel
downloadAvailableColumn=DatentypenID
downloadAvailableColumn=werkstueckeID
downloadAvailableColumn=name
downloadAvailableColumn=value
downloadAvailableColumn=print

Dies würde dazu führen, dass zusätzlich folgende Tabellenspalten verwendet werden:

• prozesseeigenschaften.Titel

• prozesseeigenschaften.DatentypenID

• vorlageneigenschaften.Titel

• vorlageneigenschaften.DatentypenID

• werkstueckeeigenschaften.Titel

• werkstueckeeigenschaften.DatentypenID

• metadata.name

• metadata.value

• metadata.print

Erfolgs- und Fehlermeldungen für Aufgaben

Manuelle Aufgaben können von Benutzern in Goobi entweder erfolgreich abgeschlossen oder in den Fehlerzustand versetzt werden. Um mehr Informationen über die Ursache und die Behebung von Fehlern zur Verfügung zu stellen, können Fehler- und Erfolgsmeldungen vorkonfiguriert werden, die später beim Abschließen (oder Abbrechen) von Aufgaben als Dropdown-Menü zur Verfügung stehen sollen.

Folgende Beispiele zeigen, wie solche Meldungen verwendet werden können:

task.error.Missing\ pages=The following pages are missing: {}
task.error.Blurred\ images=The images {} are unsharp. Please create these again.
task.solution.Problem\ solved=The problem was solved. {}
task.solution.The\ original\ print\ is\ blurred=The original pages are printed blurry. It is not possible to create sharper images. {}

Hinweis: Die Meldungen können nicht automatisch übersetzt werden und sollten in einer Sprache angegeben werden, die für möglichst alle beteiligten Nutzer verständlich ist. Bei internationalen Projekten sollte Englisch verwendet werden.

Es können beliebig viele Meldungen angegeben werden. Die jeweiligen Dropdown-Menüs stehen nur zur Verfügung, wenn mindestens eine entsprechende Meldung angegeben ist. Alle Meldungen für Fehlerbeschreibungen beginnen mit dem Präfix task.error.. Alle Meldungen für Problembehebungen beginnen mit dem Präfix task.solution..

Nach dem jeweiligen Präfix kommt ein kurzer Text, der als Dropdown-Item angezeigt werden soll. Leerzeichen müssen darin escaped werden. Nach dem Gleichheitszeichen folgt eine ausführliche Beschreibung. Diese wird später in den Schritt-Details angezeigt. An dem Platzhalter {} wird später die zusätzlich angegebene Bemerkung (aus dem Textfeld unterhalb des Dropdown-Menüs) eingesetzt.

Scripts

Es können Scripts zum Einrichten des Dateisystems konfiguriert werden. In einer Goobi Installation sind bereits passende Scripts enthalten, diese sind hier allerdings nicht als Standardwerte gesetzt.

S3 Cloud einbinden

Amazon stellt ein Cloud-System zur Verfügung, in dem Datenobjekte in "Buckets" gespeichert werden können. Dieses kann von Goobi Workflow eingebunden und zum Austausch von Daten mit anderen Servern verwendet werden.

Für die Nutzung von S3 sind Zugangsdaten vom verwendeten S3-Service erforderlich. Diese müssen in dieser Konfigurationsdatei angegeben werden.

Proxy-Server-Einstellungen

Ein Goobi Server kann für bestimmte Transaktionen mit anderen Servern oder Clients einen Proxy-Server verwenden. Standardmäßig ist kein Proxy-Server konfiguriert. Um einen Proxy-Server verwenden zu können, muss zunächst die Verwendung aktiviert werden.

Die Standardwerte für http_proxyIgnoreHost sind wie folgt vordefiniert. Die Liste kann je Bedarf ergänzt werden.

http_proxyIgnoreHost=localhost
http_proxyIgnoreHost=127.0.0.1

Server- und API-Einstellungen

Diese Kategorie umfasst einige Einstellungen, mit denen URLs und Zugangsdaten zu bestimmten Webservices konfiguriert werden können. Außerdem sind Einstellungen verfügbar, mit denen das Verhalten der internen REST-API bestimmt werden kann. Insbesondere bei URL-Angaben ist auf das richtige Protokoll (HTTP oder HTTPS) und auf die Port-Nummer zu achten, sofern der entsprechende Server bzw. Service eine andere als 80 verwendet.

Message Queues konfigurieren

Goobi Workflow verwendet mehrere Message Queues, um mit anderen Prozessen auf dem selben Server (localhost) oder anderen Servern zu kommunizieren. Dabei wird im Produktiveinsatz immer ActiveMQ verwendet. Zu Entwicklungszwecken kann teilweise SQS verwendet werden. Da die gesamte Konstellation und Konfiguration der Message Queues etwas unübersichtlich ist, sind hier der Vollständigkeit halber alle Konfigurationsmöglichkeiten dokumentiert, auch wenn einzelne Konstellationen nicht auf Produktivsystemen zum Einsatz kommen. Es ist jeweils angegeben, welche Konfigurationen für ein Produktivsystem relevant sind.

Verwendete Message Queues

• Goobi Workflow verwendet eine oder mehrere langsame Queues zur Übertragung von normalen Benachrichtigungen im Bereich der Prozesskommunikation.

• Es gibt eine schnelle Queue zum Übertragen von besonders kleinen bzw. zeitlich kritischen Informationen.

• Eine interne DLQ (Dead Letter Queue) wird verwendet, um nicht zustellbare Benachrichtigungen auf dem selben Server aufzufangen.

• Eine externe DLQ wird verwendet, um nicht zustellbare Benachrichtigungen zwischen mehreren Servern aufzufangen.

• Es gibt eine eigene Queue für Befehle, die entweder auf dem selben Server oder zwischen verschiedenen Servern verschickt werden können. Das können zum Beispiel ausführbare Scripts sein.

Simple Queue Service (SQS)

Grundsäzlich können alle Queues mit ActiveMQ betrieben werden. Die externe DLQ und die Queue für Befehle haben die Besonderheit, dass sie entweder mit ActiveMQ oder mit SQS (Simple Queue Service) funktionieren können. Solange für diese Queues ActiveMQ verwendet wird, kann zwischen einem localhost-Service und einem externen Service umgeschaltet werden. Der localhost-Service ist mit Standardparametern belegt und muss nicht weiter konfiguriert werden. Soll ein externer Service verwendet werden oder andere individuelle Konfigurationen vorgenommen werden, so wird dies in der Datei goobi_activemq.xml konfiguriert. Der SQS-Service hingegen befindet sich immer auf dem selben Server (localhost) und muss nicht konfiguriert werden.

Konfiguration

Es können zusätzlich die Namen der jeweiligen Queues konfiguriert werden. Dies ist normalerweise nicht erforderlich und ist hier der Vollständigkeit halber dokumentiert.

Metadateneditor

Der Metadateneditor hat viele Einstellungsmöglichkeiten, die sich sowohl technisch, als auch thematisch sortieren lassen können. Als Kompromiss, und weil es nicht "die" richtige Sortierung gibt, sind alle Einstellungen nach Kategorien, wie zum Beispiel "Benutzeroberfläche", "Export", usw. sortiert. Für OCR-Einstellungen heißt das zum Beispiel, dass das Anzeigen/Nicht Anzeigen des OCR-Buttons im Bereich "Benutzeroberfläche" konfiguriert wird, während technische Details zum OCR im Bereich "Export" beschrieben sind.

Allgemeine Einstellungen

In den Allgemeinen Einstellungen sind Einstellungen zu finden, die den Editor selbst und Standardwerte für neue Dokumente betreffen.

Benutzeroberfläche

In der Kategorie "Benutzeroberfläche" sind Einstellungen dokumentiert, mit denen die Darstellung von Inhalten oder die Anzeige/Nicht-Anzeige von Buttons konfiguriert werden kann.

Bilddateien und Vorschaubilder

In dieser Kategorie sind Einstellungen für Bilddateien, Vorschaubilder, die Darstellung von Bildern und das Tiling (Kachelung) von Bildern in der Benutzeroberfläche dokumentiert.

Die maximale Größe von Bilddateien (in Bytes) wird mit zwei unabhängig konfigurierbaren Werten definiert. Mit dem Wert MaxImageFileSize wird eine Zahl angegeben, wie zum Beispiel 1, 5 oder 10. Mit dem zusätzlichen Wert MaxImageFileSizeUnit wird die Maßeinheit angegeben. Diese in Kombination ergeben die Maximale Anzahl an Bytes, die eine Bilddatei nicht überschreiten darf. Wichtig: Es können nur ganze Zahlen verwendet werden.

Da es viele missverständliche Maßeinheiten gibt, sind in der folgenden Tabelle alle akzeptierten Werte und ihre intern verwendeten numerischen Werte angegeben.

Damit können zum Beispiel folgende Einstellungen vorgenommen werden:

# 20 Megabyte -> 20 * 1000 * 1000 = 20 000 000 Byte
MaxImageFileSize=20
MaxImageFileSizeUnit=MB

oder

# 1 Gibibyte -> 1 * 1024 * 1024 * 1024 = 1 073 741 824 Byte
MaxImageFileSize=1
MaxImageFileSizeUnit=GIB

Mit den folgenden Werten können Informationen zu unterstützten Bild- und Kachel-Größen (Tile-Größen) für JSON-API-Anfragen konfiguriert werden. Mit der folgenden API-Anfrage können diese Informationen zu Bildern aus Vorgängen abgefragt werden:

/process/image/{process}/{folder}/{filename}/info.json

Dabei können alle Werte mehrfach verwendet werden und mehrere Werte in der API-Anfrage zurückgeben.

Eine Konfiguration könnte zum Beispiel wie folgt aussehen:

MetsEditorImageSize=4096

MetsEditorImageTileSize=64
MetsEditorImageTileSize=128
MetsEditorImageTileSize=256

MetsEditorImageTileScale=1
MetsEditorImageTileScale=32

Beim Abschließen von Schritten werden verschiedene interne Datenüberprüfungen vorgenommen. Unter anderem wird die Anzahl an vorhandenen und bearbeiteten Bilddateien überprüft. Mit dem Wert historyImageSuffix können ein oder mehrere Dateitypen angegeben werden, die für diese Zählung berücksichtigt werden.

Diese Einstellung wird zwar für Dateiendungen verwendet und kann auch allgemeine Texte beinhalten, mit denen ein Dateiname enden soll, es werden allerdings keine regulären Ausdrücke interpretiert.

Sollen zum Beispiel alle *.tif, *.jpg und *.jpeg-Dateien berücksichtigt werden, so könnte folgende Liste zusammengestellt werden:

historyImageSuffix=.tif
historyImageSuffix=.jpg
historyImageSuffix=.jpeg

Validierung

Diese Kategorie beinhaltet Einstellungen zur Validierung von Vorgängen, Bilddateien und Metadaten.

Export

In dieser Kategorie werden Einstellungen beschrieben, die den Export von Vorgängen in herunterladbare oder auf dem Server zwischenspeicherbare Dateien mitbeeinflussen.

Die Datei goobi_projects.xml konfiguriert die Maske zum Anlegen von Vorgängen. Hier wird projektweise definiert, welche Metadaten und Eigenschaften für bestimmte Publikationstypen erlaubt sind.

Die Datei befindet sich üblicherweise an folgendem Speicherpfad:

/opt/digiverso/goobi/config/goobi_projects.xml

Beispielhaft sieht diese Konfigurationsdatei wie folgt aus:

<?xml version="1.0" encoding="UTF-8"?>
<goobiProjects>

    <project name="default">
        <name>Example project</name>
        <name>Sample.*</name>
        <createNewProcess>
            <itemlist>
                <!-- Title for all -->
                <item docstruct="topstruct" from="vorlage" isnotdoctype="multivolume" metadata="TitleDocMain" required="true" ughbinding="true"> Title </item>
                <item docstruct="topstruct" from="vorlage" isnotdoctype="multivolume" metadata="TitleDocMainShort" required="true" ughbinding="true"> Sorting title</item>
                <!-- Title just for the Multivolume -->
                <item docstruct="topstruct" from="vorlage" isdoctype="multivolume" metadata="TitleDocMain" required="true" ughbinding="true"> Title </item>
                <item docstruct="topstruct" from="vorlage" isdoctype="multivolume" metadata="TitleDocMainShort" required="true" ughbinding="true"> Sorting title</item>
                <!-- Authors and Creators -->
                <item docstruct="topstruct" from="vorlage" isdoctype="monograph\|multivolume\|periodical" ughbinding="false">Authors</item>
                <!-- Identifer -->
                <item docstruct="topstruct" from="werk" isnotdoctype="periodical" ughbinding="false">ATS</item>
                <item docstruct="topstruct" from="werk" isdoctype="periodical" ughbinding="false">TSL</item>
                <item docstruct="topstruct" from="werk" isdoctype="multivolume" metadata="CatalogIDDigital" required="true" ughbinding="true">Identifier set</item>
                <item docstruct="topstruct" from="werk" isdoctype="monograph" metadata="CatalogIDDigital" required="true" ughbinding="true"> Identifier monograph</item>
                <item docstruct="topstruct" from="werk" isdoctype="periodical" metadata="CatalogIDDigital" required="true" ughbinding="true"> Identifier journal</item>
                <item docstruct="topstruct" from="werk" isdoctype="periodical" metadata="ISSN" required="true" ughbinding="true"> ISSN </item>
                <item docstruct="firstchild" from="werk" isdoctype="multivolume\|periodical" metadata="CatalogIDDigital" required="true" ughbinding="true">Identifier volume </item>
                <!-- Title, number and authors for Multivolumes and Periodicals -->
                <item docstruct="firstchild" from="vorlage" isdoctype="multivolume\|periodical" metadata="TitleDocMain" required="true" ughbinding="true"> Title (volume)</item>
                <item docstruct="firstchild" from="vorlage" isdoctype="multivolume\|periodical" metadata="TitleDocMainShort" required="true" ughbinding="true"> Sorting title (volume)</item>
                <item docstruct="firstchild" from="vorlage" isdoctype="multivolume" ughbinding="false"> Authors (volume)</item>
                <item docstruct="firstchild" from="vorlage" isnotdoctype="monograph" metadata="CurrentNo" ughbinding="true"> Volume number </item>
                <item docstruct="firstchild" from="vorlage" isnotdoctype="monograph" metadata="CurrentNoSorting" ughbinding="true"> Sorting number</item>
                <!-- Other metadata for all -->
                <item docstruct="topstruct" from="vorlage" isdoctype="monograph\|multivolume\|periodical" metadata="PlaceOfPublication" ughbinding="true"> Publishing place </item>
                <item docstruct="topstruct" from="vorlage" isdoctype="monograph" metadata="PublicationYear" ughbinding="true"> Publishing year </item>
                <item docstruct="firstchild" from="vorlage" isdoctype="periodical\|multivolume" metadata="PublicationYear" ughbinding="true">Publishing year </item>
                <item docstruct="firstchild" from="vorlage" isdoctype="multivolume\|periodical" metadata="PublisherName" ughbinding="true"> Publishing house </item>
                <item docstruct="topstruct" from="vorlage" isdoctype="monograph" metadata="PublisherName" ughbinding="true"> Publishing house </item>
                <item from="vorlage" isdoctype="periodical\|multivolume" ughbinding="true" docstruct="firstchild" metadata="shelfmarksource"> Shelfmark </item>
                <item from="vorlage" isdoctype="monograph\|map\|manuscript" ughbinding="true" docstruct="topstruct" metadata="shelfmarksource"> Shelfmark </item>
                <!--dropdown to select the font type -->
                <item docstruct="topstruct" from="prozess" multiselect="false" metadata="FontType" required="true" ughbinding="true">
                    Font type
                    <select label="Antiqua">Antiqua </select>
                    <select label="Gothic">Gothic</select>
                    <select label="Mixed">Mixed </select>
                </item>
                <!-- Hidden fields: dropdown fields with only one value -->
                <item docstruct="topstruct" isnotdoctype="periodical\|multivolume" metadata="_dateDigitization" multiselect="true" required="true" ughbinding="true">
                    Digitisation date
                    <select label="2021"> 2021 </select>
                </item>
                <item docstruct="firstchild" isdoctype="periodical\|multivolume" metadata="_dateDigitization" multiselect="true" required="true" ughbinding="true">
                    Digitisation date
                    <select label="2021"> 2021</select>
                </item>
                <item docstruct="topstruct" from="vorlage" metadata="PhysicalLocation" multiselect="true" required="true" ughbinding="true">
                    Physical location
                    <select label="Berlin"> Berlin </select>
                    <select label="Göttingen"> Göttingen </select>                    
                </item>
                <processtitle isnotdoctype="monograph">ATS+TSL+'_'+Identifier volume+'_'+Volume number</processtitle>
                <processtitle isdoctype="monograph" replacewith="_">ATS+TSL+'_'+Identifier monograph</processtitle>
                <hide>collections</hide>
            </itemlist>
            <opac use="true">
                <catalogue>K10Plus</catalogue>
            </opac>
            <templates use="false" />
            <defaultdoctype>monograph</defaultdoctype>
            <metadatageneration use="true" />
            <fileupload use="true">
                <folder regex="/^.*$/" messageKey="uploadFileErrorIntern">intern</folder>
            	<folder regex="/^.*\\.(jpg\|jpeg\|png\|tif\|jp2)$/" messageKey="uploadFileErrorMaster">master</folder>
                <folder regex="/^.*\\.jpg$/" messageKey="uploadFileErrorMedia">media</folder>
                <folder regex="/^.*\\.pdf$/" messageKey="uploadFileErrorExport">export</folder>
            </fileupload>     
        </createNewProcess>
        <tifheader>
            <monograph>'|[[TYPE]]'+$Doctype+'|[[TITLE]]'+Title+'|[[AUTHORS]]'+Authors+'
                |[[YEAR]]'+Publishing year+'|[[PLACE]]'+Publishing place+'|[[FOLDER]]'+ATS+'_'+Identifier monograph+'|'
            </monograph>
            <multivolume>'|[[TYPE]]'+$Doctype+'|[[TITLE]]'+Title+'|[[AUTHORS]]'+Authors+'
                |[[YEAR]]'+Publishing year+'|[[PLACE]]'+Publishing place+'|[[FOLDER]]'+ATS+'_'+Identifier volume+'_'+Label number+'|'
            </multivolume>
            <periodical>'|[[TYPE]]'+$Doctype+'|[[TITLE]]'+Title+'|[[AUTHORS]]'+Authors+'
                |[[YEAR]]'+Publishing year+'|[[PLACE]]'+Publishing place+'|[[FOLDER]]'+TSL+'_'+Identifier volume+'_'+Label number+'|'
            </periodical>
        </tifheader>
        <dmsImport />
        <validate>
        	<metadata createelementfrom="" docstruct="" metadata="">
        		Create CreatorsAllOrigin
        	</metadata>
        </validate>
    </project>
</goobiProjects>