Merge pull request 'Release v24.08.1' (#10) from release_24.08.1 into…

… master

Jenkinsfile

@@ -27,6 +27,7 @@ pipeline {
           anyOf {
             branch 'master'
             branch 'release_*'
+            branch 'hotfix_release_*'
             allOf {
               branch 'PR-*'
               expression { env.CHANGE_BRANCH.startsWith("release_") }
@@ -43,6 +44,7 @@ pipeline {
         anyOf {
           branch 'master'
           branch 'release_*'
+          branch 'hotfix_release_*'
           allOf {
             branch 'PR-*'
             expression { env.CHANGE_BRANCH.startsWith("release_") }
@@ -59,6 +61,7 @@ pipeline {
           anyOf {
             branch 'master'
             branch 'release_*'
+            branch 'hotfix_release_*'
             branch 'sonar_*'
             allOf {
               branch 'PR-*'
@@ -83,6 +86,7 @@ pipeline {
         anyOf {
           branch 'master'
           branch 'develop'
+          branch 'hotfix_release_*'
         }
       }
       steps {
@@ -95,7 +99,12 @@ pipeline {
       }
     }
     stage('tag release') {
-      when { branch 'master' }
+      when {
+        anyOf {
+          branch 'master'
+          branch 'hotfix_release_*'
+        }
+      }
       steps {
         withCredentials([gitUsernamePassword(credentialsId: '93f7e7d3-8f74-4744-a785-518fc4d55314',
                  gitToolName: 'git-tool')]) {

README.md

@@ -12,11 +12,11 @@ More information about the functionality of this plugin and the complete documen
 
 Detail                      | Description
 --------------------------- | ----------------------
-**Plugin identifier**       | -
+**Plugin identifier**       | intranda_workflow_yerusha_aim25
 **Plugin type**             | workflow
 **Licence**                 | GPL 2.0 or newer
-**Documentation (German)**  | This plugin is not yet documented.
-**Documentation (English)** | This plugin is not yet documented.
+**Documentation (German)**  | https://docs.goobi.io/workflow-plugins/v/ger/workflow/goobi-plugin-workflow-yerusha-aim25
+**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/eng/workflow/goobi-plugin-workflow-yerusha-aim25
 
 ## Goobi details
 

docs/index_de.md

@@ -0,0 +1,47 @@
+---
+title: Datenübernahme aus AIM25
+identifier: intranda_workflow_yerusha_aim25
+description: Workflow-Plugin zum Überprüfen und Herunterladen von Datensätzen aus AIM25 für neue EAD-Datensätze und zum Erstellen von Goobi Vorgängen
+published: true
+---
+
+## Einführung
+Dies ist eine technische Dokumentation für das YerushaAim25 Goobi-Workflow-Plugin. Es überprüft AIM25 auf neue EAD-Datensätze, lädt diese herunter und erstellt Goobi-Vorgänge dafür.
+
+## Installation
+Um das Plugin verwenden zu können, müssen die folgenden Dateien installiert werden:
+
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin-workflow-yerusha-aim25-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-workflow-yerusha-aim25-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_workflow_yerusha_aim25.xml
+```
+
+Um dieses Plugin zu verwenden, muss der Benutzer die entsprechende Rollenberechtigung haben.
+
+Weisen Sie daher der Gruppe die Rolle `Plugin_workflow_yerusha_aim25` zu.
+
+![Korrekt zugewiesene Rolle für Benutzer](screen1_de.png)
+
+## Überblick und Funktionalität
+Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es unter dem Menüpunkt `Workflow` zu finden.
+
+![Benutzeroberfläche des Plugins](screen2_de.png)
+
+Auf der Seite des Plugins wird nach Klick auf die Schaltfläche die Liste der Datensätze in AIM25 abgefragt. Für alle Datensätze, für die noch keine Goobi-Vorgänge erstellt wurden, werden die Datensätze heruntergeladen und basierend auf der in der Konfigurationsdatei angegebenen Vorlage als Goobi-Vorgänge erzeugt. Dabei wird die EAD-Datei mit den angegebenen XPath-Ausdrücken durchsucht und entsprechende Metadaten für den Goobi-Vorgang erstellt.
+
+## Konfiguration
+Das Plugin wird in der Datei `plugin_intranda_workflow_yerusha_aim25.xml` wie folgt konfiguriert:
+
+{{CONFIG_CONTENT}}
+
+Die folgende Tabelle enthält eine Zusammenfassung der Parameter und deren Beschreibungen:
+
+Parameter               | Erläuterung
+------------------------|------------------------------------
+|  `templateTitle` | Dieser Parameter gibt den Titel der Workflow-Vorlage an, die bei der Erstellung neuer Vorgänge verwendet wird.  |
+|  `documenttype` | Dieser Parameter definiert den Goobi-Dokumenttyp für importierte Dokumente.  |
+|`importFolder`| Ein Ordner, in dem Daten temporär gespeichert werden können. |
+|`importNumber`   | Für Tests: Wenn dieser Wert nicht leer oder 0 ist, wird bei jedem Durchlauf des Plugins nur diese Anzahl von Datensätzen importiert.   |
+|`mapping`  | XPath-Zuordnungen von den EAD-Dateien zu Goobi-Metadaten. |

docs/index_en.md

@@ -0,0 +1,48 @@
+---
+title: Data transfer from AIM25
+identifier: intranda_workflow_yerusha_aim25
+description: Workflow Plugin to check and dowload new EAD datasets from AIM25 and to create Goobi processes
+published: true
+---
+
+## Introduction
+This is a technical documentation for the YerushaAim25 Goobi workflow plugin. It checks AIM25 for new EAD datasets, downloads them and creates Goobi processes for them.
+
+## Installation
+In order to use the plugin, the following files must be installed:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin-workflow-yerusha-aim25-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-workflow-yerusha-aim25-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_workflow_yerusha_aim25.xml
+```
+
+To use this plugin, the user must have the correct role authorisation.
+
+Therefore, please assign the role `Plugin_workflow_yerusha_aim25` to the group.
+
+![Correctly assigned role for users](screen1_en.png)
+
+
+## Overview and functionality
+If the plugin has been installed and configured correctly, it can be found under the `Workflow` menu item.
+
+![User interface of the plugin](screen2_en.png)
+
+On the page of the plugin, when the button is clicked, the list of datasets in AIM25 is requested, and for any datasets which have not already been given goobi processes, the datasets are downloaded and converted to goobi processes, based on the template specified in the config file. Here the EAD file is searched using the specified xpath expressions, with corresponding metadata created for the goobi process.
+
+
+## Configuration
+The plugin is configured in the file `plugin_intranda_workflow_yerusha_aim25.xml` as shown here:
+
+{{CONFIG_CONTENT}}
+
+The following table contains a summary of the parameters and their descriptions:
+
+Parameter               | Explanation
+------------------------|------------------------------------
+|  `templateTitle` | This parameter specifies the title of the workflow template to be used when creating new processes.  |
+|  `documenttype` | This parameter defines the goobi DocType for imported documents.  |
+|`importFolder`| A folder where data can be temporarily written. |
+|`importNumber`   | For testing: if this is not empty or 0, then only this number of datasets will be imported each time the plugin is carried out.   |
+|` mapping`  | Xpath mappings from the EAD files to goobi metadata. |

module-base/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-yerusha-aim25</artifactId>
-    <version>24.07</version>
+    <version>24.08.1</version>
   </parent>
   <artifactId>plugin-workflow-yerusha-aim25-base</artifactId>
   <packaging>jar</packaging>

module-gui/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-yerusha-aim25</artifactId>
-    <version>24.07</version>
+    <version>24.08.1</version>
   </parent>
   <artifactId>plugin-workflow-yerusha-aim25-gui</artifactId>
   <packaging>jar</packaging>

pom.xml

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