Skip to content

Commit 9f17651

Browse files
SteffenHankiewiczSteffenHankiewicz
committed
added docs
1 parent 9d9008b commit 9f17651

File tree

4 files changed

+240
-0
lines changed

4 files changed

+240
-0
lines changed

‎docs/index_de.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Package Export
3+
identifier: intranda_step_exportPackage
4+
published: true
5+
description: Dieses Step Plugin ermöglicht einen flexiblen Export von Metadaten und Inhalten eines Goobi Vorgangs an einen konfigurierbaren Pfad
6+
---
7+
## Einführung
8+
Dieses Plugin erlaubt einen flexiblen Export von Daten eines Vorgangs in ein definiertes Zielverzeichnis. Dabei kann dieses Plugin sehr granular konfiguriert werden, um ausgewählte Daten im Export zu berücksichtigen. Darüber hinaus ist hier ebenfalls eine Transformation der internen und der Export-METS-Datei via XSLT möglich und erlaubt so verschiedenste Einsatzszenarien.
9+
10+
11+
## Installation
12+
Zur Installation des Plugins muss die folgende Datei installiert werden:
13+
14+
```bash
15+
/opt/digiverso/goobi/plugins/step/plugin_intranda_step_exportPackage-base.jar
16+
```
17+
18+
Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:
19+
20+
```bash
21+
/opt/digiverso/goobi/config/plugin_intranda_step_exportPackage.xml
22+
```
23+
24+
25+
## Überblick und Funktionsweise
26+
Zur Inbetriebnahme des Plugins muss dieses für einen oder mehrere gewünschte Aufgaben im Workflow aktiviert werden. Dies erfolgt wie im folgenden Screenshot aufgezeigt durch Auswahl des Plugins `intranda_step_exportPackage` aus der Liste der installierten Plugins.
27+
28+
![Zuweisung des Plugins zu einer bestimmten Aufgabe](screen1_de.png)
29+
30+
Da dieses Plugin üblicherweise automatisch ausgeführt werden soll, sollte der Arbeitsschritt im Workflow als automatisch konfiguriert werden.
31+
32+
Nachdem das Plugin vollständig installiert und eingerichtet wurde, wird es üblicherweise automatisch innerhalb des Workflows ausgeführt, so dass keine manuelle Interaktion mit dem Nutzer erfolgt. Stattdessen erfolgt der Aufruf des Plugins durch den Workflow im Hintergrund und führt den konfigurierten Export in das Zielverzeichnis durch. Dabei werden die angegebenen Inhalte alle in ein Unterverzeichnes des definierten Export-Pfades kopiert.
33+
34+
Je nach Konfiguration kann dabei zusätzlich zu dem Export der Daten auch eine XSLT-Transformation der internen oder auch der Export-METS-Datei erfolgen, um diese in ein gewünschtes Format zu bringen. Abhängig von dieser Transformation sowie der Benennung der Transformationsdatei wird diese abschließend ebenfalls mit in dem Ordner des exportierten Vorganges gespeichert.
35+
36+
37+
## Konfiguration
38+
Die Konfiguration des Plugins ist folgendermaßen aufgebaut:
39+
40+
```xml
41+
<config_plugin>
42+
<!--
43+
order of configuration is:
44+
1.) project name and step name matches
45+
2.) step name matches and project is *
46+
3.) project name matches and step name is *
47+
4.) project name and step name are *
48+
-->
49+
50+
<config>
51+
<!-- which projects to use for (can be more then one, otherwise use *) -->
52+
<project>*</project>
53+
<step>*</step>
54+
55+
<!-- export path -->
56+
<target>/opt/digiverso/export/</target>
57+
<!-- use subfolder for each process -->
58+
<useSubFolderPerProcess>true</useSubFolderPerProcess>
59+
<!-- a zip file with the subfolder-name will be created -->
60+
<createZipPerProcess>true</createZipPerProcess>
61+
<!-- which image folders to use (master|media|jpeg|source|...) -->
62+
<imagefolder>master</imagefolder>
63+
<!-- use the attribute filegroup, if you want to add checksums to the files within the filegroup. The checksums are taken from the configured folder -->
64+
<imagefolder filegroup="PRESENTATION">media</imagefolder>
65+
66+
<!-- which additional folders to use -->
67+
<ocr>false</ocr>
68+
<source>false</source>
69+
<import>false</import>
70+
<export>false</export>
71+
<itm>false</itm>
72+
<validation>false</validation>
73+
74+
<!-- generate UUIDs for each mets:fileGrp and mets:file -->
75+
<uuid>false</uuid>
76+
<!-- add checksums to mets:files -->
77+
<checksum>false</checksum>
78+
<!-- command to use to validate the exported images -->
79+
<checksumValidationCommand>/usr/bin/sha1sum</checksumValidationCommand>
80+
81+
<!-- if the internal METS file shall get transformed into another file define the path of the xsl file here -->
82+
<copyInternalMetaFile>true</copyInternalMetaFile>
83+
<transformMetaFile>true</transformMetaFile>
84+
<transformMetaFileXsl>/opt/digiverso/goobi/xslt/export_meta.xsl</transformMetaFileXsl>
85+
<transformMetaFileResultFileName>xslt_result_meta.xml</transformMetaFileResultFileName>
86+
87+
<!-- if the METS file shall get transformed into another file define the path of the xsl file here -->
88+
<transformMetsFile>true</transformMetsFile>
89+
<transformMetsFileXsl>/opt/digiverso/goobi/xslt/export_mets.xsl</transformMetsFileXsl>
90+
<transformMetsFileResultFileName>xslt_result_mets.xml</transformMetsFileResultFileName>
91+
</config>
92+
93+
</config_plugin>
94+
```
95+
96+
Der Block `<config>` kann für verschiedene Projekte oder Arbeitsschritte wiederholt vorkommen, um innerhalb verschiedener Workflows unterschiedliche Aktionen durchführen zu können. Die weiteren Parameter innerhalb dieser Konfigurationsdatei haben folgende Bedeutungen:
97+
98+
| Wert | Beschreibung |
99+
| :--- | :--- |
100+
| `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. |
101+
| `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. |
102+
| `target` | Mit diesem Parameter wird der Hauptpfad definiert, wohin der Export des Vorgangs als Unterordner mit dem Vorgangsnamen exportiert werden soll. |
103+
| `useSubFolderPerProcess` | Mit diesem Parameter wird festgelegt ob für jeden Prozess ein Unterordner angelegt werden soll. |
104+
| `createZipPerProcess` | Mit diesem Parameter kann festgelegt werden, ob eine zip-Datei je Prozess erstellt werden soll. |
105+
| `imagefolder` | Es können mehrere Verzeichnisse für die Bilder bzw. Digitalisate angegeben werden. Dies kann unter anderem z.B. die Master-Bilder sowie die Derivate umfassen. Wenn die METS Datei Checksummen für die einzelnen Images enthalten soll, kann hier über das Attribut `filegroup` festgelegt werden, für welche `<mets:fileGrp>` die Checksummen der Dateien aus diesem Ordner genutzt werden sollen. |
106+
| `ocr` | Mit diesem Parameter wird angegeben, ob die OCR-Ergebnisse mit exportiert werden sollen. |
107+
| `source` | Wenn die Inhalte des `source` Ordners mit berücksichtigt werden sollen, kann dies hier angegeben werden. |
108+
| `import` | Wenn die Inhalte des `import` Ordners mit berücksichtigt werden sollen, kann dies hier definiert werden. |
109+
| `export` | Wenn die Inhalte des `export` Ordners mit berücksichtigt werden sollen, kann dies hier ebenfalls angegeben werden. |
110+
| `itm` | Sollen die Inhalte des TaskManager-Verzeichnisses `itm` mit exportiert werden, wird dies hier definiert. |
111+
| `validation` | Mit diesem Parameter kann festgelegt werden, dass die Inhalte des Verzeichnisses `validation` ebenfalls exportiert werden sollen. |
112+
| `uuid` | Wenn für die Verlinkung zwischen `<mets:structMap>`, `<mets:fptr>` und `<mets:fileGrp>`, `<mets:file>` UUIDs (v4) genutzt werden sollen, kann dies hier angegeben werden. |
113+
| `checksum` | Wenn diese Option aktiviert wurde, werden die exportierten Daten mit zuvor generierten Checksummen verglichen, um den erfolgreichen Export zu verifizieren. Wurden bei der Konfiguration der `imagefolder` auch Dateigruppen konfiguriert, werden die Checksummen auch in die entsprechenden Dateigruppen eingetragen. |
114+
| `checksumValidationCommand` | Enthält das Kommandozeilentool, mit dem die Verifizierung durchgeführt wird. |
115+
| `transformMetaFile` | Mit diesem Parameter wird festgelegt, ob die interne METS-Datei von Goobi workflow in das Zielverzeichnis kopiert werden soll. |
116+
| `transformMetaFileXsl` | Mit diesem Parameter kann festgelegt werden, ob die interne METS-Datei mittels der hier definierten XSLT-Transformationsdatei verarbeitet werden soll. |
117+
| `transformMetaFileResultFileName` | Wenn eine Transformation der internen METS-Datei mittels XSLT erfolgen soll, kann hier festgelegt werden, wie der Name der zu generierenden Datei lauten soll. |
118+
| `transformMetsFile` | Mit diesem Parameter wird festgelegt, ob die Export-METS-Datei von Goobi workflow in das Zielverzeichnis kopiert werden soll. |
119+
| `transformMetsFileXsl` | Mit diesem Parameter kann festgelegt werden, ob die Export-METS-Datei mittels der hier definierten XSLT-Transformationsdatei verarbeitet werden soll. |
120+
| `transformMetsFileResultFileName` | Wenn eine Transformation der Export-METS-Datei mittels XSLT erfolgen soll, kann hier festgelegt werden, wie der Name der zu generierenden Datei lauten soll. |

‎docs/index_en.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Package Export
3+
identifier: intranda_step_exportPackage
4+
published: true
5+
description: This step plugin allows you to export the metadata and content of a Goobi process to a configurable path
6+
---
7+
## Introduction
8+
This plugin allows a flexible export of data of a process into a defined target directory. This plugin can be configured very granularly to include selected data in the export. In addition, a transformation of the internal and the export METS file via XSLT is also possible here and thus allows a wide range of usage scenarios.
9+
10+
11+
## Installation
12+
To install the plugin, the following file must be installed:
13+
14+
```bash
15+
/opt/digiverso/goobi/plugins/step/plugin_intranda_step_exportPackage-base.jar
16+
```
17+
18+
To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:
19+
20+
```bash
21+
/opt/digiverso/goobi/config/plugin_intranda_step_exportPackage.xml
22+
```
23+
24+
25+
## Overview and functionality
26+
To use the plugin, it must be activated for one or more desired tasks in the workflow. This is done as shown in the following screenshot by selecting the plugin 'intranda_step_exportPackage' from the list of installed plugins.
27+
28+
![Assigning the plugin to a specific task](screen1_en.png)
29+
30+
Since this plugin is usually to be executed automatically, the step in the workflow should be configured as automatic.
31+
32+
Once the plugin is fully installed and set up, it is usually executed automatically within the workflow, so there is no manual interaction with the user. Instead, the workflow calls the plugin in the background and performs the configured export to the target directory. The specified contents are all copied into a subdirectory of the defined export path.
33+
34+
Depending on the configuration, an XSLT transformation of the internal or the export METS file can be carried out in addition to the export of the data in order to bring it into a desired format. Depending on this transformation as well as the name of the transformation file, it is finally also saved in the folder of the exported processes.
35+
36+
37+
## Configuration
38+
The configuration of the plugin is structured as follows:
39+
40+
```xml
41+
<config_plugin>
42+
<!--
43+
order of configuration is:
44+
1.) project name and step name matches
45+
2.) step name matches and project is *
46+
3.) project name matches and step name is *
47+
4.) project name and step name are *
48+
-->
49+
50+
<config>
51+
<!-- which projects to use for (can be more then one, otherwise use *) -->
52+
<project>*</project>
53+
<step>*</step>
54+
55+
<!-- export path -->
56+
<target>/opt/digiverso/export/</target>
57+
<!-- use subfolder for each process -->
58+
<useSubFolderPerProcess>true</useSubFolderPerProcess>
59+
<!-- a zip file with the subfolder-name will be created -->
60+
<createZipPerProcess>true</createZipPerProcess>
61+
<!-- which image folders to use (master|media|jpeg|source|...) -->
62+
<imagefolder>master</imagefolder>
63+
<!-- use the attribute filegroup, if you want to add checksums to the files within the filegroup. The checksums are taken from the configured folder -->
64+
<imagefolder filegroup="PRESENTATION">media</imagefolder>
65+
66+
<!-- which additional folders to use -->
67+
<ocr>false</ocr>
68+
<source>false</source>
69+
<import>false</import>
70+
<export>false</export>
71+
<itm>false</itm>
72+
<validation>false</validation>
73+
74+
<!-- generate UUIDs for each mets:fileGrp and mets:file -->
75+
<uuid>false</uuid>
76+
<!-- add checksums to mets:files -->
77+
<checksum>false</checksum>
78+
<!-- command to use to validate the exported images -->
79+
<checksumValidationCommand>/usr/bin/sha1sum</checksumValidationCommand>
80+
81+
<!-- if the internal METS file shall get transformed into another file define the path of the xsl file here -->
82+
<copyInternalMetaFile>true</copyInternalMetaFile>
83+
<transformMetaFile>true</transformMetaFile>
84+
<transformMetaFileXsl>/opt/digiverso/goobi/xslt/export_meta.xsl</transformMetaFileXsl>
85+
<transformMetaFileResultFileName>xslt_result_meta.xml</transformMetaFileResultFileName>
86+
87+
<!-- if the METS file shall get transformed into another file define the path of the xsl file here -->
88+
<transformMetsFile>true</transformMetsFile>
89+
<transformMetsFileXsl>/opt/digiverso/goobi/xslt/export_mets.xsl</transformMetsFileXsl>
90+
<transformMetsFileResultFileName>xslt_result_mets.xml</transformMetsFileResultFileName>
91+
</config>
92+
93+
</config_plugin>
94+
```
95+
96+
The block `<config>` can occur repeatedly for different projects or workflow steps in order to be able to carry out different actions within different workflows. The other parameters within this configuration file have the following meanings:
97+
98+
| Value | Description |
99+
| :--- | :--- |
100+
| `project` | This parameter determines the project for which the current block `<config>` is to apply. The name of the project is used here. This parameter can occur several times per `<config>` block. |
101+
| `step` | This parameter controls for which workflow steps the block `<config>` is to apply. The name of the step is used here. This parameter can occur several times per `<config>` block. |
102+
| `target` | This parameter defines the main path where the export of the process as a subfolder with the process name should be exported to. |
103+
| `useSubFolderPerProcess` | This parameter determines whether a subfolder is to be created for each process. |
104+
| `createZipPerProcess` | This parameter can be used to determine whether a zip file is to be created for each process. |
105+
| `imagefolder` | Several directories can be specified for the images or digital copies. This can include, for example, the master images and the derivatives. If the METS file is to contain checksums for the individual images, the attribute `filegroup` can be used here to specify for which `mets:fileGrp>` the checksums of the files from this folder are to be used. |
106+
| `ocr` | This parameter specifies whether the OCR results are to be exported as well. |
107+
| `source` | If the contents of the `source` folder should be included, this can be specified here. |
108+
| `import` | If the contents of the `import` folder should be included, this can be defined here. |
109+
| `export` | If the contents of the `export` folder are to be included, this can also be specified here. |
110+
| `itm` | If the contents of the TaskManager directory `itm` are to be exported as well, this is defined here. |
111+
| `validation` | With this parameter you can specify that the contents of the `validation` directory should also be exported. |
112+
| `uuid` | If UUIDs (v4) are to be used for linking between `<mets:structMap>`, `<mets:fptr>` and `<mets:fileGrp>`, `<mets:file>`, this can be specified here. |
113+
| `checksum` | When this option is enabled, the exported data is compared with previously generated checksums to verify successful export. If file groups were also configured when configuring the `image folders`, the checksums are also entered into the corresponding file groups. |
114+
| `checksumValidationCommand` | Contains the command line tool used to perform the verification. |
115+
| `transformMetaFile` | This parameter defines whether the Goobi workflow internal METS file should be copied to the target directory. |
116+
| `transformMetaFileXsl` | This parameter can be used to specify whether the internal METS file should be processed using the XSLT transformation file defined here. |
117+
| `transformMetaFileResultFileName` | If the internal METS file is to be transformed using XSLT, you can specify here what the name of the file to be generated should be. |
118+
| `transformMetsFile` | This parameter defines whether the export METS file from Goobi workflow should be copied to the target directory. |
119+
| `transformMetsFileXsl` | This parameter can be used to specify whether the export METS file should be processed using the XSLT transformation file defined here. |
120+
| `transformMetsFileResultFileName` | If the export METS file is to be transformed using XSLT, you can specify here what the name of the file to be generated should be. |

‎docs/screen1_de.png

1.02 MB
Loading

‎docs/screen1_en.png

1020 KB
Loading

0 commit comments

Comments
 (0)