7.2 goobi_config.properties

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:

goobi_config.properties
# -----------------------------------
# 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

# Defines the 

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

# -----------------------------------
# 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 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

# 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

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.

Last updated