Umbenennung von Dateien

Dieses Step Plugin erlaubt die automatische Anpassung von Dateinamen innerhalb von Goobi Vorgängen.

Einführung

Dieses Plugin dient zu bedingen Umbenennung von Dateien innerhalb der verschiedenen Ordner eines Vorgangs von Goobi workflow. Die Benennung erfolgt dabei abhängig von einer Konfigurationsdatei, die für unterschiedliche Workflows jeweils anders aufgebaut sein kann.

Übersicht

Details

Version

1.0.0

Identifier

intranda_step_rename-files

Source code

https://github.com/intranda/goobi-plugin-step-rename-files

Lizenz

GPL 2.0 oder neuer

Kompatibilität

Goobi workflow 2020.02

Dokumentationsdatum

10.05.2020

Installation

Zur Installation des Plugins muss die folgende Datei installiert werden:

/opt/digiverso/goobi/plugins/workflow/plugin_intranda_step_rename-files.jar

Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:

/opt/digiverso/goobi/config/plugin_intranda_step_rename-files.xml

Dabei sieht der Inhalt dieser Konfigurationsdatei beispielhaft wie folgt aus:

<config_plugin>
<config>
<project>Monographs 1900-1950</project>
<project>Monographs 1950-2000</project>
<step>Automatic renaming</step>
<startValue>1</startValue>
<namepart type="counter">00000</namepart>
<namepart type="static">-</namepart>
<namepart type="variable">{projectid}</namepart>
</config>
<config>
<project>*</project>
<step>*</step>
<startValue>1</startValue>
<namepart type="variable">{processtitle}</namepart>
<namepart type="static">_</namepart>
<namepart type="counter">00000</namepart>
</config>
</config_plugin>

Allgemeine Konfiguration des Plugins

Die Konfiguration des Plugins erfolgt innerhalb der bereits erwähnten Konfigurationsdatei. Dort können verschiedene Parameter konfiguriert werden. Der Block <config> kann für verschiedene Projekte oder Arbeitsschritte wiederholt vorkommen, um innerhalb verschiedener Workflows unterschiedliche Aktionen durchführen zu können. Die Elemente <namepart> sind hierbei maßgeblich für die Generierung der Dateinamen.

Wert

Beschreibung

project

Dieser Parameter legt fest, für welches Projekt der aktuelle Block <config> gelten soll. Verwendet wird hierbei der Name des Projektes. Dieser Parameter kann mehrfach pro <config> Block vorkommen.

step

Dieser Parameter steuert, für welche Arbeitsschritte der Block <config> gelten soll. Verwendet wird hier der Name des Arbeitsschritts. Dieser Parameter kann mehrfach pro <config> Block vorkommen.

startValue

Dieser Wert steuert, mit welchem Startwert der hochzählende counter beginnen soll.

namepart

Dieser ebenfalls mehrfach verwendbare Parameter steuert die Generierung der Dateinamen. Er kann statische Elemente beinhalten (static), Variablen aus Goobi nutzen (variable) sowie einen Zähler erzeugen (counter). Für die Generierung des Zählers ist entscheidend, welche Anzahl an Stellen definiert wurden. Der Wert 00000 würde beispielsweise fünfstellige Zahlen mit ggf. vorangestellten Nullen erzeugen.

Die so definierten Bestandteile des Dateinamens werden für die Benennung miteinander verkettet und anschließend um die eigentliche Dateiendung ergänzt, um so die Datei zu benennen.

Arbeitsweise

Das Plugin wird üblicherweise vollautomatisch innerhalb des Workflows ausgeführt. Es ermittelt zunächst, ob sich innerhalb der Konfigurationsdatei ein Block befindet, der für den aktuellen Workflow bzgl. des Projektnamens und Arbeitsschrittes konfiguriert wurde. Wenn dies der Fall ist, werden die einzelnen Elemente <namepart> ausgewertet, mit den entsprechenden Werten für den Zähler und die Variablen aus Goobi workflow ausgestattet und anschließend miteinander verkettet. Die somit erzeugten Dateinamen werden nun für sämtliche relevanten Verzeichnisse des Goobi Vorgangs angewendet und mit den jeweils korrekten Dateinamenerweiterungen ergänzt (z.B. .tif).

Sollte innerhalb des Dateien eine Datei vorgefunden werden, die barcode innerhalb des Dateinamens enthält, so wird diese ebenfalls entsprechend des Namensschemas benannt. Als Zähler wird hier jedoch der Wert 0 gesetzt.

Details über die in diesem Plugin verwendbaren Variablen aus Goobi workflow finden sich innerhalb dieser Dokumentation.

Das Plugin berücksichtigt für die Benennung die Dateien innerhalb der folgenden Unterverzeichnisse:

  • master

  • media

  • jpeg

  • alto

  • pdf

  • txt

  • xml

Bedienung des Plugins

Dieses Plugin wird in den Workflow so integriert, dass es automatisch ausgeführt wird. Eine manuelle Interaktion mit dem Plugin ist nicht notwendig. Zur Verwendung innerhalb eines Arbeitsschrittes des Workflows sollte es wie im nachfolgenden Screenshot konfiguriert werden.

Integration des Plugins in den Workflow