KitodoScript
KitodoScripte dienen dazu, eine Aktion an mehreren Vorgängen durchzuführen, anstatt jeden Vorgang an sich bearbeiten zu müssen.
Führen Sie zunächst eine Suche durch, die genau die Vorgänge als Treffer anzeigen wird, die bearbeitet werden sollen. Wenn es nicht möglich ist, die Treffermenge durch die Suche exakt zu beschränken, kann Schritt 2 durchgeführt werden.
Soll das KitodoScript nicht auf das gesamte Trefferset oder auf die gesamte Trefferseite angewendet werden, müssen zunächst die gewünschten Vorgänge aus dem Trefferset markiert werden. Dies erreicht man, indem zunächst unterhalb des Treffersets die Aktion "Anzeige anpassen" aufgerufen und dort die Auswahlboxen markiert werden.
Ein Klick auf Übernehmen lädt anschliessend die Seite neu. so dass im Trefferset nun die Auswahlboxen angezeigt werden, mittels denen nun eine Selektion erfolgen kann.
ACHTUNG!: Es muss unbedingt darauf geachtet werden, dass nur die Vorgänge markiert sind, die tatsächlich durch das Script bearbeiten werden sollen. Einige Funktionen können nicht rückgängig gemacht werden.
Wenn die Vorgänge, die bearbeitet werden sollen, korrekt ausgewählt wurden, muss das Script ausgewählt werden, das ausgeführt werden soll.
Mit folgenen Befehlen wird das Script ausgelöst:
-
Auswahl: Das Script wird bei den Vorgängen angewendet, die mit den Auswahlboxen markiert wurden.
-
Treffer dieser Seite: Das Script wird bei den Vorgängen angewendet, die auf der Seite angezeigt werden.
-
Gesamtes Trefferset: Das Script wird bei allen Vorgängen des Treffersets angewendet, also auch Vorgänge, die nicht auf der Seite angezeigt werden, wenn die Vorgangsliste so lange ist, dass es mehrere Listen gibt.
Es werden mehrere Scripte zur Auswahl angeboten. Im Folgenden werden diese mit dem zugehörigen Befehl aufgelistet. Aufgrund mangelnder Erfahrung wird in den meisten Fällen auf eine Beschreibung verzichtet.
Großgeschriebene Textteile (TITLE_STEP, USER_NAME,...) sind Variable, die vor der Anwendung des Scripts durch den entsprechenden Wert (Bezeichnung eines bestimmten Schritts, Name eines Benutzers) ersetzt werden müssen.
Sriptname: addUser
Script: action:addUser "steptitle:TITLE_STEP" username:USER_NAME
Erläuterung: Mit diesem Befehl kann den Vorgängen eines Treffersets einer Aufgabe ein bestimmter Benutzer zugewiesen werden.
Sriptname: addUserGroup
Script: action:addUserGroup "steptitle:TITLE_STEP" group:GROUP_NAME
Erläuterung: Mit diesem Befehl kann den Vorgängen eines Treffersets einer Aufgabe eine bestimmte Benutzergruppe zugewiesen werden.
Sriptname: deleteTiffHeaderFile
Script: action:deleteTiffHeaderFile
Erläuterung: Mit diesem Befehl kann die TiffHeader-Datei (tiffwriter.conf) im Imageverzeichnis gelöscht werden.
Sriptname: swapSteps
Script: action:swapSteps swap1nr:ORDER_NUMBER_FIRST_STEP "swap1title:TITLE_FIRST_STEP"swap2nr:ORDER_NUMBER_SECOND_STEP "swap2title:TITLE_SECOND_STEP"
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: importFromFileSystem
Script: action:importFromFileSystem sourcefolder:SOURCE_FOLDER
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: swapProzessesOut
Script: action:swapProzessesOut
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor. -> Das Script scheint nicht zu funktionieren: https://bugs.launchpad.net/goobi-production/+bug/789027
Sriptname: setRuleset
Script: action:setRuleset "ruleset:TITLE_RULESET"
Erläuterung: Mit diesem Befehl kann den Vorgängen eines Treffersets ein anderer Regelsatz zugewiesen werden.
Sriptname: swapProzessesIn
Script: action:swapProzessesIn
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: deleteStep
Script: action:deleteStep "steptitle:TITLE_STEP"
Erläuterung: Mit diesem Befehl kann in den Vorgängen eines Treffersets eine Aufgabe gelöscht werden.
Sriptname: addStep
Script: action:addStep "steptitle:TITLE_STEP" number:NUMBER_1_TO_?
Erläuterung: Mit diesem Befehl kann den Vorgängen eines Treffersets eine weitere Aufgabe und deren Reihenfolge hinzugefügt werden.
Sriptname: setStepStatus
Script: action:setStepStatus "steptitle:TITLE_STEP" status:NUMBER_0_TO_3
Erläuterung: Mit diesem Befehl kann in den Vorgängen eines Treffersets der Status einer Aufgabe geändert werden.
-
0= Gesperrt -
1= Offen -
2= In Bearbeitung -
3= Abgeschlossen
Sriptname: setStepNumber
Script: action:setStepNumber "steptitle:TITLE_STEP" number:NUMBER_1_TO_?
Erläuterung: Mit diesem Befehl kann in den Vorgängen eines Treffersets die Reihenfolge (Nummer) einer Aufgabe geändert werden.
Sriptname: addModuleToStep
Script: action:addModuleToStep "steptitle:TITLE_STEP" "module:MODULE_NAME"
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: addShellScriptToStep
Script: action:addShellScriptToStep "steptitle:TITLE_STEP" "label:LABEL_FOR_SCRIPT" "script:PATH_TO_SCRIPT"
Erläuterung: Mit diesem Befehl kann in den Vorgängen eines Treffersets der "Script Schritt" in den Eigenschaften einer Aufgabe geändert werden.
-
label= Skriptname -
script= Skriptpfad
Sriptname: setTaskProperty
Script: action:setTaskProperty "steptitle:TITLE_STEP" property:metadata_readimages_writeimages_validate_exportdms_automatic_batch value:true_OR_false
Erläuterung: Mit diesem Befehl kann in den Vorgängen eines Treffersets die Eigenschaften einer Aufgabe geändert werden.
Folgende Aufgabeneigenschaften können aktiviert / deaktiviert werden:
-
metadata= Metadaten -
readimages= Images lesen -
writeimages= Images schreiben -
validate= Beim Abschließen verifizieren -
exportdms= Export DMS -
automatic= Automatische Aufgabe -
batch= Batch Schritt
Aktivierung/Deaktivierung
-
value:true= Aufgabeneigenschaft wird aktiviert -
value:false= Aufgabeneigenschaft wird deaktiviert
ACHTUNG: Dieses Script ist bis zur Kitodo.Production-Version 2.2.0 vorhanden und wurde in der Kitodo.Production-Version 2.3.0. entfernt
Sriptname: tiffWriter
Script: action:tiffWriter
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
ACHTUNG: Dieses Script ist bis zur Kitodo.Production-Version 2.2.0 vorhanden und wurde in der Kitodo.Production-Version 2.3.0. entfernt
Sriptname: export
Script: action:export exportImages:{true|false} exportOcr:{false|true}
Erläuterung: Mit diesem Befehl werden die Vorgänge eines Trefferset exportiert. Über die Parameter exportImages und exportOcr kann bestimmt werden, ob die Bilddaten und / oder OCR Daten mit exportiert werden oder nicht.
Sriptname: exportDms
Script: action:exportDms exportImages:true_OR_false
Erläuterung: Mit diesem Befehl werden die Vorgänge eines Trefferset mit oder ohne Bilddaten exportiert
-
action:exportDms exportImages:false= Export ohne Bilddaten. -
action:exportDms exportImages:true= Export mit Bilddaten.
Sriptname: copydata
Script: action:copyData <rule(s)>
Erläuterung: Mit diesem Befehl können die Metadaten der Vorgänge eines Treffersets kopiert, entfernt oder hinzugefügt werden.
Sriptname: rewriteProcessMetadata
Script: action:rewriteProcessMetadata
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: exportDMSMetadataOnly
Script: action:exportDMSMetadataOnly
Erläuterung: Mit diesem Befehl werden die Metadaten der Vorgänge eines Trefferset ohne OCR- oder Bilddaten exportiert.
Sriptname: exportDMSMetadataAndOcr
Script: action:exportDMSMetadataAndOcr
Erläuterung: Mit diesem Befehl werden die Metadaten und OCR-Daten der Vorgänge eines Trefferset ohne Bilddaten exportiert.
Sriptname: exportDmsCustomizedConfiguration
Script: action:exportDmsCustomizedConfiguration exportImages:true_OR_false exportOcr:true_OR_false
Erläuterung: Mit diesem Befehl werden die Metadaten der Vorgänge eines Trefferset exportiert. Der Export der Images der OCR- und der Bilddaten kann konfiguriert werden. Wenn Bilddaten exportiert werden, werden immer OCR-Daten exportiert.
Sriptname: runscript
Script: action:runscript "stepname:TITLE_STEP" "script:SCRIPT_NAME"
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: deleteProcess
Script: action:deleteProcess contentOnly:true_OR_false
Erläuterung: Mit diesem Befehl können die Vorgänge eines Treffersets gelöscht werden. Es stehen zwei Optionen zur Verfügung:
- Löschen des Vorgangs: Der komplette Datensatz wird in Kitodo.Production gelöscht.
- Löschen des Vorgang-Inhalt: Der Inhalt (Metadaten, Images, ...) des Vorgangs wird in Kitodo.Production gelöscht. Der Vorgang bleibt erhalten.
Sriptname: updateContentFiles
Script: action:updateContentFiles
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: updateImagePath
Script: action:updateImagePath
Erläuterung: Zu diesem Befehl liegen keine gesicherten Informationen vor.
Sriptname: importProcesses
Script: action:importProcesses indir:/path/to/directory/ project:#id template:#id [errors:/path/to/directory/]
Erläuterung: Importiert Vorgänge, die nur als Vorgangsverzeichnisse existieren, aber noch nicht, oder nicht mehr, in der Datenbank.
-
indir= Pfad zu dem Ordner, in dem die zu importierenden Vorgangsordner liegen -
project= Nummer des Projektes, in dem die Vorgänge erstellt werden sollen -
template= Nummer der Produktionsvorlage, auf Basis derer die Vorgänge erstellt werden sollen -
errors= (optional) Pfad zu einem Ordner, in den nicht importierbare Vorgänge kopiert werden sollen. In den Vorgangsordnern wird jeweils eine Textdatei erstellt, die angibt, warum der Import nicht möglich war.