Merge pull request 'Release v24.08.1' (#9) 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_close_step
 **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-close-step
+**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/eng/workflow/goobi-plugin-workflow-close-step
 
 ## Goobi details
 

docs/index_de.md

@@ -0,0 +1,78 @@
+---
+title: Arbeitsschritte schließen
+identifier: intranda_workflow_close_step
+description: Step Plugin für Goobi workflow für das gleichzeitige Abschließen mehrerer Arbeitsschritte
+published: true
+---
+
+## Einführung
+Dieses Workflow-Plugin ermöglicht es, einen bestimmten Schritt in mehreren Vorgängen gleichzeitig zu schließen. Die dafür zur Verfügung stehenden Schritte werden vorher in einer Konfigurationsdatei festgelegt und stehen später auf der Web-Oberfläche zur Auswahl. Die Vorgänge, in denen der ausgewählte Schritt geschlossen werden soll, werden per Datei-Upload festgelegt. 
+
+## Installation
+Zur Installation müssen folgende Dateien installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin_intranda_workflow_closestep.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_workflow_closestep-GUI.jar
+```
+
+Um für das Plugin die schließbaren Schritte festzulegen, muss folgende Konfigurationsdatei angelegt und angepasst werden:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_closestep.xml
+```
+
+Für eine Nutzung dieses Plugins muss der Nutzer über die korrekte Rollenberechtigung verfügen.
+
+Bitte weisen Sie daher der Gruppe die Rolle `Plugin_Goobi_Closestep` zu.
+
+![Korrekt zugewiesene Rolle](screen1_de.png)
+
+## Überblick und Funktionsweise
+Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es innerhalb des Menüpunkts `Workflow` zu finden.
+
+![Nutzeroberfläche des Plugins](screen2_de.png)
+
+Zunächst wird eine Excel-Datei im `XLS`- oder im `XLSX`-Format hochgeladen, um die gewünschten Vorgänge festzulegen. Diese beinhaltet eine Auflistung aller IDs der gewünschten Vorgänge.
+
+Am einfachsten bekommen Sie eine solche Datei, wenn Sie auf der Seite `Vorgänge suchen` eine Liste mit den von Ihnen gewünschten Vorgängen zusammenstellen und das Ergebnis von der Seite `Vorgänge` in eine Excel-Datei exportieren.
+
+**Wichtig:** Achten Sie darauf, dass `Alle Felder auswählen` ausgewählt ist, da sonst die Datei die erforderlichen IDs nicht in der zweiten Spalte beinhaltet und nicht kompatibel zu diesem Plugin ist.
+
+Als nächstes wird der zu schließende Schritt ausgewählt. Dafür steht ein Drop-Down-Menü zur Verfügung, welches alle in der Konfigurationsdatei angegebenen Schritte anbietet.
+
+Klicken Sie nun auf `Datei hochladen`.
+
+Wenn die Excel-Datei keine Vorgangs-IDs beinhaltet, wird nun eine entsprechende Fehlermeldung angezeigt.
+
+Ansonsten erscheint nun eine Liste mit allen Vorgängen. Je nach dem, ob ein Schritt geschlossen werden kann, bereits geschlossen ist, oder aus bestimmten Gründen nicht geschlossen werden kann, wird nun eine passende Box angezeigt. Gibt es Fehlermeldungen, so ist die Liste an Fehlermeldungen innerhalb eines Vorgangs ausklappbar.
+
+Wenn es schließbare Schritte gibt, werden diese mit einem Klick auf "Schritte schließen" geschlossen und die Boxen für die entsprechenden Schritte ändern sich von "Kann geschlossen werden" zu "Ist geschlossen".
+
+Sie können optional die Liste der Status- und Fehlerbeschreibungen als Excel-Datei herunterladen.
+
+
+## Konfiguration
+Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_workflow_closestep.xml` wie hier aufgezeigt:
+
+{{CONFIG_CONTENT}}
+
+Die folgende Tabelle enthält eine Zusammenstellung der Parameter und ihrer Beschreibungen:
+
+Parameter               | Erläuterung
+------------------------|------------------------------------
+| `config_plugin` | Dies ist das Hauptelement in der Konfigurationsdatei und muss genau einmal vorkommen. Es beinhaltet alle Konfigurationen. |
+| `maximum_megabyte_per_file` | Die maximal erlaubte Dateigröße in Megabyte kann hier im Parameter `mb` festgelegt werden. Überschreitet der Datei-Upload diese Größe, wird eine Fehlermeldung zurückgegeben. |
+| `step_to_close` | Diese Codeblöcke zeichnen jeweils genau einen Schritt aus, der auf der Benutzeroberfläche zum Schließen zur Auswahl stehen soll. Der Parameter `name` gibt den Namen des zu schließenden Schritts an. |
+| `condition` | Mit diesen Unterelementen von `step_to_close` lassen sich die Vorbedingungen zum Schließen des jeweiligen Schritts angeben. Dafür wird mit den Parametern `stepname` und `status` der geforderte Zustand eines anderen Schritts angegeben. Der Status wird immer groß geschrieben. |
+
+Der in `stepname` angegebene Schritt ist ein anderer Schritt, der in jedem Vorgang existieren muss, in dem der vom Nutzer ausgewählte Schritt geschlossen werden soll. Dieser muss zusätzlich in einem bestimmten Status sein. Dieser wird aus folgender Liste ausgewählt:
+
+| Status | Bezeichnung |
+| :--- | :--- |
+| `DEACTIVATED` | Deaktiviert |
+| `DONE` | Abgeschlossen |
+| `ERROR` | Fehler |
+| `INWORK` | In Bearbeitung |
+| `LOCKED` | Gesperrt |
+| `OPEN` | Offen |

docs/index_en.md

@@ -0,0 +1,80 @@
+---
+title: Close steps
+identifier: intranda_workflow_close_step
+description: Step plugin for Goobi workflow for the simultaneous completion of several work steps
+published: true
+---
+
+## Introduction
+This workflow plugin makes it possible to close a specific step in several processes at the same time. The steps available for this are defined beforehand in a configuration file and are available for selection later on the web interface. The processes in which the selected step is to be closed are specified via file upload.
+
+## Installation
+The following files must be installed for the installation:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin_intranda_workflow_closestep.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_workflow_closestep-GUI.jar
+```
+
+To set the closable steps for the plugin, the following configuration file must be created and customized:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_closestep.xml
+```
+
+To use this plugin, the user must have the correct role permission.
+
+Therefore, please assign role `Plugin_Goobi_Closestep` to the group.
+
+![Correctly assigned role](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)
+
+First, an Excel file is uploaded in `XLS` or `XLSX` format to specify the desired processes. This contains a listing of all IDs of the desired processes.
+
+The easiest way to get such a file is to compile a list of the processes you want on the 'Search processes' page and export the result from the 'Processes' page to an Excel file.
+
+**Important:** Make sure that `Select all fields` is selected, otherwise the file will not contain the required IDs in the second column and will not be compatible with this plugin.
+
+Next, the step to be closed is selected. A drop-down menu is available for this purpose, which offers all the steps specified in the configuration file.
+
+Now click on `Upload file`.
+
+If the Excel file does not contain any task IDs, a corresponding error message is now displayed.
+
+Otherwise, a list with all processes will now appear. Depending on whether a step can be closed, is already closed, or cannot be closed for certain reasons, an appropriate box is now displayed. If there are error messages, the list of error messages within an operation is expandable.
+
+If there are closable steps, these are closed with a click on "Close steps" and the boxes for the corresponding steps change from "Can be closed" to "Is closed".
+
+You can optionally download the list of status and error descriptions as an Excel file.
+
+## Configuration
+The plugin is configured in the file `plugin_intranda_workflow_closestep.xml` as shown here:
+
+{{CONFIG_CONTENT}}
+
+The following table contains a summary of the parameters and their descriptions:
+
+Parameter               | Explanation
+------------------------|------------------------------------
+| :--- | :--- |
+| `config_plugin` | This is the main element in the configuration file and must occur exactly once. It contains all configurations. |
+| `maximum_megabyte_per_file` | The maximum allowed file size in megabytes can be specified here in the `mb` parameter. If the file upload exceeds this size, an error message is returned. |
+| `step_to_close` | These code blocks each draw exactly one step to be available for selection on the user interface for closing. The `name` parameter specifies the name of the step to be closed. |
+| `condition` | These sub-elements of `step_to_close` can be used to specify the preconditions for closing the respective step. For this purpose, the parameters `stepname` and `status` are used to specify the required state of another step. The status is always written in capital letters. |
+
+The step specified in `stepname` is another step that must exist in each operation where the step selected by the user is to be closed. This step must also be in a certain state. This is selected from the following list:
+
+| Status | Description |
+| :--- | :--- |
+| `DEACTIVATED` | Deactivated |
+| `DONE` | Completed |
+| `ERROR` | Error |
+| `INWORK` | In process |
+| `LOCKED` | Locked |
+| `OPEN` | Open |
+

module-base/pom.xml

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

module-gui/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-close-step</artifactId>
-    <version>24.07</version>
+    <version>24.08.1</version>
   </parent>
   <artifactId>plugin-workflow-close-step-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>