Merge pull request 'Release v24.11' (#3) from release_24.11 into master

intranda · Dec 5, 2024 · d92a760 · d92a760
2 parents 80b1764 + 5ffabb5
commit d92a760
Show file tree

Hide file tree

Showing 30 changed files with 859 additions and 389 deletions.
diff --git a/DO_NOT_PUBLISH b/DO_NOT_PUBLISH
diff --git a/README.md b/README.md
@@ -10,31 +10,30 @@ This is a plugin for Goobi workflow, the open source workflow tracking software
 
 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
---- | ---
+Detail                      | Description
+--------------------------- | ----------------------
 **Plugin identifier**       | intranda_workflow_wu_wma_import
-**Plugin type**             | Workflow plugin
-**Licence**                 | GPL 2.0 or newer  
-**Documentation (German)**  | - no documentation available -
-**Documentation (English)** | - no documentation available -
+**Plugin type**             | workflow
+**Licence**                 | GPL 2.0 or newer
+**Documentation (German)**  | https://docs.goobi.io/workflow-plugins/v/ger/workflow/goobi-plugin-workflow-wu-wma-import
+**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/eng/workflow/goobi-plugin-workflow-wu-wma-import
 
 ## 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
+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
-**Twitter**       | https://twitter.com/intranda
+Contact                     | Details
+--------------------------- | ----------------------------------------------------
+**Company name**            | intranda GmbH
+**Address**                 | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
+**Web site**                | https://www.intranda.com
diff --git a/docs/index_de.md b/docs/index_de.md
@@ -1,27 +1,27 @@
 ---
-title: ZZZ
-identifier: intranda_workflow_ZZZ
-description: Workflow Plugin für ZZZ
-published: false
+title: Massenimport für Markenstudien und Werbemittel
+identifier: intranda_workflow_wu_wma_import
+description: Workflow Plugin für den Import von Markenstudien und Werbemitteln an der WU Wien
+published: true
 ---
 
 ## Einführung
-Dieses Workflow-Plugin erlaubt ZZZ.
+Dieses Workflow-Plugin erlaubt einen Massenimport für die Markenstudien und das Werbemittelarchiv an der Wirtschaftsuniversität Wien.
 
 ## Installation
 Um das Plugin nutzen zu können, müssen folgende Dateien installiert werden:
 
 ```bash
-/opt/digiverso/goobi/plugins/workflow/plugin-workflow-ZZZ-base.jar
-/opt/digiverso/goobi/plugins/GUI/plugin-workflow-ZZZ-gui.jar
-/opt/digiverso/goobi/config/plugin_intranda_workflow_ZZZ.xml
+/opt/digiverso/goobi/plugins/workflow/plugin-workflow-wu-wma-import-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-workflow-wu-wma-import-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_workflow_wu_wma_import.xml
 ```
 
 Für eine Nutzung dieses Plugins muss der Nutzer über die korrekte Rollenberechtigung verfügen.
 
 ![Ohne korrekte Berechtigung ist das Plugin nicht nutzbar](screen1_de.png)
 
-Bitte weisen Sie daher der Gruppe die Rolle `ZZZ` zu.
+Bitte weisen Sie daher der Gruppe die Rolle `Plugin_workflow_wu_wma_import` zu.
 
 ![Korrekt zugewiesene Rolle für die Nutzer](screen2_de.png)
 
@@ -31,42 +31,22 @@ Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es innerhalb des
 
 ![Nutzeroberfläche des Plugins](screen3_de.png)
 
-ZZZ
+Hier kann nun auf der rechten Seite ein Import für ein Datenset gestartet werden.
 
+![Gestarteter Import](screen4_de.png)
+
+Nach Beginn des Imports der Daten ist ein Fortschritt über den Forschrittsbalken ersichtlich. Details über den Import der einzelnen Datensätze lassen sich im darunter aufgeführten Log einsehen.
 
 ## Konfiguration
-Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_workflow_ZZZ.xml` wie hier aufgezeigt:
+Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_workflow_wu_wma_import.xml` wie hier aufgezeigt:
 
 {{CONFIG_CONTENT}}
 
 Die folgende Tabelle enthält eine Zusammenstellung der Parameter und ihrer Beschreibungen:
 
 Parameter               | Erläuterung
 ------------------------|------------------------------------
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
+`title`                 | Hier kann ein individueller Titel für die Anzeige im Menü und die Überschriften des Plugins festgelegt werden.
+`importSet`             | Mit diesem Element lassen sich individuelle Importsets definieren. Sie bestehen jeweils aus einem `title` für den anzuzeigenden Namen, sowie einer Angabe für den Speicherort, von dem die Daten importiert werden sollen. Der Speicherort kann dabei beliebig tiefe Verzeichnisstrukturen aufweisen.
+`workflow`              | Hiermit läßt sich festlegen, welche Produktionsvorlage für das Anlegen von Goobi-Vorgängen verwendet werden soll.
+
diff --git a/docs/index_en.md b/docs/index_en.md
@@ -1,27 +1,27 @@
 ---
-title: ZZZ
-identifier: intranda_workflow_ZZZ
-description: Workflow Plugin to ZZZ
-published: false
+title: Mass import for brand studies and advertising material
+identifier: intranda_workflow_wu_wma_import
+description: Workflow plugin for the import of brand studies and advertising material at WU Vienna
+published: true
 ---
 
 ## Introduction
-This workflow plugin allows you to ZZZ.
+This workflow plugin allows a mass import for the brand studies and the advertising material archive at the Vienna University of Economics and Business.
 
 ## Installation
 In order to use the plugin, the following files must be installed:
 
 ```bash
-/opt/digiverso/goobi/plugins/workflow/plugin-workflow-ZZZ-base.jar
-/opt/digiverso/goobi/plugins/GUI/plugin-workflow-ZZZ-gui.jar
-/opt/digiverso/goobi/config/plugin_intranda_workflow_ZZZ.xml
+/opt/digiverso/goobi/plugins/workflow/plugin-workflow-wu-wma-import-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-workflow-wu-wma-import-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_workflow_wu_wma_import.xml
 ```
 
 To use this plugin, the user must have the correct role authorisation.
 
 ![The plugin cannot be used without correct authorisation](screen1_en.png)
 
-Therefore, please assign the role `ZZZ` to the group.
+Therefore, please assign the role `Plugin_workflow_wu_wma_import` to the group.
 
 ![Correctly assigned role for users](screen2_en.png)
 
@@ -31,42 +31,22 @@ If the plugin has been installed and configured correctly, it can be found under
 
 ![User interface of the plugin](screen3_en.png)
 
-ZZZ
+An import for a data set can now be started here on the right-hand side.
+
+![Started import](screen4_en.png)
+
+Once the import of the data has started, the progress bar shows the progress. Details about the import of the individual data records can be viewed in the log below.
 
 
 ## Configuration
-The plugin is configured in the file `plugin_intranda_workflow_ZZZ.xml` as shown here:
+The plugin is configured in the file `plugin_intranda_workflow_wu_wma_import.xml` as shown here:
 
 {{CONFIG_CONTENT}}
 
 The following table contains a summary of the parameters and their descriptions:
 
 Parameter               | Explanation
 ------------------------|------------------------------------
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
-``                      | 
+`title`                 | An individual title for the display in the menu and the headings of the plugin can be defined here.
+`importSet`             | Individual import sets can be defined with this element. They each consist of a `title` for the name to be displayed and a specification for the storage location from which the data is to be imported. The storage location can have any depth of directory structure.
+`workflow`              | This allows you to specify which production template is to be used for creating Goobi processes.
diff --git a/docs/screen1_de.png b/docs/screen1_de.png
diff --git a/docs/screen1_en.png b/docs/screen1_en.png
diff --git a/docs/screen2_de.png b/docs/screen2_de.png
diff --git a/docs/screen2_en.png b/docs/screen2_en.png
diff --git a/docs/screen3_de.png b/docs/screen3_de.png
diff --git a/docs/screen3_en.png b/docs/screen3_en.png
diff --git a/docs/screen4_de.png b/docs/screen4_de.png
diff --git a/docs/screen4_en.png b/docs/screen4_en.png
diff --git a/install/plugin_intranda_workflow_wu_wma_import.xml b/install/plugin_intranda_workflow_wu_wma_import.xml
@@ -1,19 +1,14 @@
 <config_plugin>
 
-	<!-- import set existing of excel files and pdf files -->
-	<importSet title="a" source="Source Field A" target="TitleDocMain"/>
-	<importSet title="b" source="Source Field B" target="CatalogIDSource"/>
-	<importSet title="c" source="Source Field C" target="CatalogIDDigital"/>
-	<importSet title="d" source="Source Field D" target="shelfmarksource"/>
-	<importSet title="e" source="Max Mustermann" target="Author" person="true"/>
-
-	<!-- which folder to use as import source -->
-	<importFolder>/opt/digiverso/import/wu_wma_import/</importFolder>
+	<title>Mass import for the WU</title>
+
+	<!-- importsets with source folder definition -->
+	<importSet title="Markenstudien 1" source="/opt/digiverso/import/markenstudien01/" />
+	<importSet title="Markenstudien 2" source="/opt/digiverso/import/markenstudien02/" />
+	<importSet title="Markenstudien 3" source="/opt/digiverso/import/markenstudien03/" />
+	<importSet title="Markenstudien 4" source="/opt/digiverso/import/markenstudien04/" />
 
 	<!-- which workflow to use -->
-	<workflow>WuWmaImport_Workflow</workflow>
-
-	<!-- which publication type to use -->
-	<publicationType>Monograph</publicationType>
-
+	<workflow>Sample_Workflow</workflow>
+
 </config_plugin>
diff --git a/module-base/pom.xml b/module-base/pom.xml
@@ -3,8 +3,8 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-wu-wma-import</artifactId>
-    <version>24.10</version>
+    <version>24.11</version>
   </parent>
   <artifactId>plugin-workflow-wu-wma-import-base</artifactId>
   <packaging>jar</packaging>
-</project>
+</project>