Merge pull request 'Release v24.07' (#8) from release_24.07 into master

README.md

@@ -1,40 +1,39 @@
-# Goobi workflow Plugin: goobi-plugin-export-fedora
-
-<img src="https://goobi.io/wp-content/uploads/logo_goobi_plugin.png" align="right" style="margin:0 0 20px 20px;" alt="Plugin for Goobi workflow" width="175" height="109">
-
-This is the Goobi Plugin for the export of Goobi processes into a Fedora Repository. It was implemented as a generic solution and might be adapted for individual use cases.
-
-This is a plugin for Goobi workflow, the open source workflow tracking software for digitisation projects. More information about Goobi workflow is available under https://goobi.io. If you want to get in touch with the user community simply go to https://community.goobi.io.
-
-## Plugin details
-
-More information about the functionality of this plugin and the complete documentation can be found in the central documentation area at https://docs.goobi.io
-
-Detail | Description
---- | ---
-**Plugin identifier**       | intranda_export_fedora
-**Plugin type**             | Export plugin
-**Licence**                 | GPL 2.0 or newer  
-**Documentation (German)**  | https://docs.goobi.io/goobi-workflow-plugins-de/export/plugin_intranda_export_fedora
-**Documentation (English)** | https://docs.goobi.io/goobi-workflow-plugins-en/export/plugin_intranda_export_fedora
-
-## Goobi details
-
-Goobi workflow is an open source web application to manage small and large digitisation projects mostly in cultural heritage institutions all around the world. More information about Goobi can be found here:
-
-Detail | Description
---- | ---
-**Goobi web site**  | https://www.goobi.io
-**Twitter**         | https://twitter.com/goobi
-**Goobi community** | https://community.goobi.io
-
-## Development
-
-This plugin was developed by intranda. If you have any issues, feedback, question or if you are looking for more information about Goobi workflow, Goobi viewer and all our other developments that are used in digitisation projects please get in touch with us.  
-
-Contact | Details
---- | ---
-**Company name**  | intranda GmbH
-**Address**       | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
-**Web site**      | https://www.intranda.com
-**Twitter**       | https://twitter.com/intranda
+# Goobi workflow Plugin: goobi-plugin-export-fedora
+
+<img src="https://goobi.io/wp-content/uploads/logo_goobi_plugin.png" align="right" style="margin:0 0 20px 20px;" alt="Plugin for Goobi workflow" width="175" height="109">
+
+This Export plugin for Goobi workflow is a reference implementation for the export of content to fedora.
+
+This is a plugin for Goobi workflow, the open source workflow tracking software for digitisation projects. More information about Goobi workflow is available under https://goobi.io. If you want to get in touch with the user community simply go to https://community.goobi.io.
+
+## Plugin details
+
+More information about the functionality of this plugin and the complete documentation can be found in the central documentation area at https://docs.goobi.io
+
+Detail                      | Description
+--------------------------- | ----------------------
+**Plugin identifier**       | intranda_export_fedora
+**Plugin type**             | export
+**Licence**                 | GPL 2.0 or newer
+**Documentation (German)**  | https://docs.goobi.io/workflow-plugins/v/eng/export/goobi-plugin-export-fedora
+**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/ger/export/goobi-plugin-export-fedora
+
+## Goobi details
+
+Goobi workflow is an open source web application to manage small and large digitisation projects mostly in cultural heritage institutions all around the world. More information about Goobi can be found here:
+
+Detail                      | Description
+--------------------------- | ---------------------------
+**Goobi web site**          | https://www.goobi.io
+**Goobi community**         | https://community.goobi.io
+**Goobi documentation**     | https://docs.goobi.io
+
+## Development
+
+This plugin was developed by intranda. If you have any issues, feedback, question or if you are looking for more information about Goobi workflow, Goobi viewer and all our other developments that are used in digitisation projects please get in touch with us.  
+
+Contact                     | Details
+--------------------------- | ----------------------------------------------------
+**Company name**            | intranda GmbH
+**Address**                 | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
+**Web site**                | https://www.intranda.com

docs/index_de.md

@@ -0,0 +1,100 @@
+---
+title: Fedora Export
+identifier: intranda_export_fedora
+published: true
+description: Goobi Plugin für den Export von Goobi-Vorgängen in ein Fedora Repository
+---
+## Einführung
+Die vorliegende Dokumentation beschreibt die Installation, die Konfiguration und den Einsatz des Fedora Export Plugins in Goobi workflow.
+
+
+## Installation
+Das Plugin muss in den folgenden Ordner installiert werden:
+
+![Integration des Plugins in den Workflow](screen1_de.png)
+
+```bash
+/opt/digiverso/goobi/plugins/export/plugin_intranda_export_fedora*.jar
+```
+
+Daneben gibt es eine Konfigurationsdatei, die an folgender Stelle liegen muss:
+
+```bash
+/opt/digiverso/goobi/config/intranda_export_fedora.xml
+```
+
+
+## Überblick und Funktionsweise
+Es muss ein Export Schritt konfiguriert werden:
+
+* Export DMS
+* Automatische Aufgabe
+* Plugin für Arbeitsschritt: FedoraExport
+
+Bei der Ausführung des Schrittes wird ein Export des Goobi Vorgangs (analog zum Export ins Dateisystem) in das konfigurierte Fedora Repository unter Berücksichtigung der Konfiguration (siehe oben) eingespielt.
+
+Die Daten des Vorgangs lassen sich anschließend über das folgende URL-Muster im Repository abrufen:
+
+```bash
+http(s)://<Fedora REST endpoint>/records/&lt;CatalogIdDigital>/
+```
+
+
+## Beispiele für die URLs nach erfolgreichem Ingest nach Fedora
+
+
+### URL des Datensatzes
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/](http://localhost:8888/fedora/rest/records/PPN123456789/)
+
+
+### URL für die METS-Datei
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/PPN123456789.xml](http://localhost:8888/fedora/rest/records/PPN123456789/PPN123456789.xml)
+
+
+### URL für die Master-Bilder
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000001.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000001.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000002.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000002.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000003.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000003.tif)
+
+
+### URL für die Derivate der Bilder
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/media/00000001.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000001.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/media/00000002.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000002.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/media/00000003.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000003.tif)
+
+
+## Konfiguration
+Die Konfiguration erfolgt über die Konfigurationsdatei `intranda_export_fedora.xml` und kann im laufenden Betrieb angepasst werden.
+
+```xml
+<config_plugin>
+
+    <!-- fedoraUrl: REST endpoint of the target Fedora application. -->
+    <fedoraUrl>http://localhost:8888/fedora/rest</fedoraUrl>
+
+    <!-- useVersioning: If true, for each run of the export step, a new revision of the process will be created. Default is true. -->
+    <useVersioning>true</useVersioning>
+
+    <!-- ingestMasterImages: If true, master images of the Goobi process will be ingested into the container /master. Default is true. -->
+    <ingestMasterImages>true</ingestMasterImages>
+
+    <!-- ingestMediaImages: If true, derivate images of the Goobi process will be ingested into the container /media. Default is true. -->
+    <ingestMediaImages>true</ingestMediaImages>
+
+    <!-- ingestMetsFile: If true, a METS/MODS file will be generated and ingested. Default is true. -->
+    <ingestMetsFile>true</ingestMetsFile>
+
+    <!-- exportMetsFile: If true, the METS/MODS file will be exported into the given destination folder. Default is true. -->
+    <exportMetsFile>true</exportMetsFile>
+
+</config_plugin>
+```
+
+| Parameter | Erläuterung |
+| :--- | :--- |
+| `fedoraUrl` | REST Endpoint des Fedora Applikation |
+| `useVersioning` | Wenn `true` gesetzt ist, wird die Revisionierung von Fedora verwendet. In diesem Fall wird für jeder Ausführung des Exportschrittes eine neue Revision des Vorgangs im Repository angelegt. Standardwert ist `true`. |
+| `ingestMasterImages` | Wenn `true` gesetzt ist, werden die Master-Bilder des Vorgangs in den Subcontainer `/master` exportiert. Standardwert ist `true`. |
+| `ingestMediaImages` | Wenn `true` gesetzt ist, werden die Derivate des Vorgangs in den Subcontainer `/media` exportiert. Standardwert ist `true`. |
+| `ingestMetsFile` | Wenn `true` gesetzt ist, eine METS/MODS Datei erzeugt und im Container exportiert. Standardwert ist `true`. |
+| `exportMetsFile` | Wenn `true` gesetzt ist, eine METS/MODS Datei erzeugt und in den üblichen Export-Ordner (z.B. `/hotfolder`) geschrieben. Standardwert ist `true`. |

docs/index_en.md

@@ -0,0 +1,100 @@
+---
+title: Fedora Export
+identifier: intranda_export_fedora
+published: true
+description: Goobi plugin for exporting Goobi processes to a Fedora repository
+---
+## Introduction
+This documentation describes the installation, configuration and use of the Fedora Export Plugin in Goobi workflow.
+
+
+## Installation
+The plugin must be installed in the following folder:
+
+![Integration of the plugin into the workflow](screen1_en.png)
+
+```bash
+/opt/digiverso/goobi/plugins/export/plugin_intranda_export_fedora*.jar
+```
+
+There is also a configuration file, which must be located at the following location:
+
+```bash
+/opt/digiverso/goobi/config/intranda_export_fedora.xml
+```
+
+
+## Overview and functionality
+An export step must be configured:
+
+* Export DMS
+* Automatic task
+* Plugin for step: FedoraExport
+
+When the step is executed, the Goobi process is exported (in the same way as it is exported to the file system) to the configured Fedora Repository, taking into account the configuration (see above).
+
+The process data can then be retrieved from the repository using the following URL pattern:
+
+```bash
+http(s)://<Fedora REST endpoint>/records/&lt;CatalogIdDigital>/
+```
+
+
+## Examples of URLs after successful ingest to Fedora
+
+
+### URL of the data record
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/](http://localhost:8888/fedora/rest/records/PPN123456789/)
+
+
+### URL for the METS file
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/PPN123456789.xml](http://localhost:8888/fedora/rest/records/PPN123456789/PPN123456789.xml)
+
+
+### URL for the master images
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000001.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000001.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000002.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000002.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000003.tif](http://localhost:8888/fedora/rest/records/PPN123456789/master/master_00000003.tif)
+
+
+### URL for the derivatives of the images
+
+[http://localhost:8888/fedora/rest/records/PPN123456789/media/00000001.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000001.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/media/00000002.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000002.tif) [http://localhost:8888/fedora/rest/records/PPN123456789/media/00000003.tif](http://localhost:8888/fedora/rest/records/PPN123456789/media/00000003.tif)
+
+
+## Configuration
+The configuration is done via the configuration file `intranda_export_fedora.xml` and can be adapted during operation.
+
+```xml
+<config_plugin>
+
+    <!-- fedoraUrl: REST endpoint of the target Fedora application. -->
+    <fedoraUrl>http://localhost:8888/fedora/rest</fedoraUrl>
+
+    <!-- useVersioning: If true, for each run of the export step, a new revision of the process will be created. Default is true. -->
+    <useVersioning>true</useVersioning>
+
+    <!-- ingestMasterImages: If true, master images of the Goobi process will be ingested into the container /master. Default is true. -->
+    <ingestMasterImages>true</ingestMasterImages>
+
+    <!-- ingestMediaImages: If true, derivate images of the Goobi process will be ingested into the container /media. Default is true. -->
+    <ingestMediaImages>true</ingestMediaImages>
+
+    <!-- ingestMetsFile: If true, a METS/MODS file will be generated and ingested. Default is true. -->
+    <ingestMetsFile>true</ingestMetsFile>
+
+    <!-- exportMetsFile: If true, the METS/MODS file will be exported into the given destination folder. Default is true. -->
+    <exportMetsFile>true</exportMetsFile>
+
+</config_plugin>
+```
+
+| Parameter | Description |
+| :--- | :--- |
+| `fedoraUrl` | REST Endpoint of the Fedora application |
+| `useVersioning` | If `true`, the versioning of Fedora is used. In this case, each time the export step is executed, a new version of the process is created in the repository. The default value is `true`. |
+| `ingestMasterImages` | If `true` is set, the master images of the operation are exported to the subcontainer `/master`. The default value is `true`. |
+| `ingestMediaImages` | If `true`, the derivatives of the operation are exported to the `/media` subcontainer. The default value is `true`. |
+| `ingestMetsFile` | If `true` is set, a METS/MODS file is created and exported to the container. Default value is `true`. |
+| `exportMetsFile` | If `true` is set, a METS/MODS file is created and written to the usual export folder (e.g. `/hotfolder`). Default value is `true`. |

module-base/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-export-fedora</artifactId>
-    <version>24.06</version>
+    <version>24.07</version>
   </parent>
   <artifactId>plugin-export-fedora-base</artifactId>
   <packaging>jar</packaging>

pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow</groupId>
     <artifactId>workflow-base</artifactId>
-    <version>24.06</version>
+    <version>24.07</version>
     <relativePath />
   </parent>
   <groupId>io.goobi.workflow.plugin</groupId>