Configuration editor

This is an Administration Plugin for Goobi workflow which allow to get reading and writing access to all important configuration files of Goobi workflow which are usually located inside of the folder

Introduction
This plugin is used to directly edit the various configuration files of Goobi workflow directly from the user interface within the web browser.
Overview
Details
Description
Identifier
intranda_administration_config_file_editor
Source code
​https://github.com/intranda/goobi-plugin-administration-config-file-editor​
License
GPL 2.0 or newer
Documentation date
06.11.2021
How the plugin works
After installation, the plugin can be found in its own entry in the Administration menu, from where it can be opened.
Open plugin without loaded file
After opening, all Goobi configuration files are listed on the left-hand side. These can be opened by clicking on the respective icon in order to edit them.
Open plugin without loaded file
If you open a file, a text editor appears on the right-hand side in which the file can be edited. If you edit and save a file, a backup is automatically created in the defined backup directory.
Saved file
According to the value set in the configuration file, a certain number of older backups are retained here before they are replaced by newer ones.
Files within the backup directory
If a file has been changed and an attempt is made to change to another file without saving it, the operator is asked how to proceed with the changes.
Demand for unsaved data
Within Goobi, help texts can be defined for configuration files, which can be helpful for editing in this editor. The stored help texts are displayed in the left-hand area depending on the file currently open and also have the option of working with formatting here.
Help texts for the respective configuration files
Installation
The plugin consists in total of the following files to be installed:
1
plugin_intranda_administration_config_file_editor.jar
2
plugin_intranda_administration_config_file_editor-GUI.jar
3
plugin_intranda_administration_config_file_editor.xml
Copied!
These files must be installed in the correct directories so that they are available under the following paths after installation:
1
/opt/digiverso/goobi/plugins/administration/plugin_intranda_administration_config_file_editor.jar
2
/opt/digiverso/goobi/plugins/GUI/plugin_intranda_administration_config_file_editor-GUI.jar
3
/opt/digiverso/goobi/config/plugin_intranda_administration_config_file_editor.xml
Copied!
Configuration
The plugin is configured via the configuration file plugin_intranda_administration_config_file_editor.xml and can be adapted during operation. The following is an example configuration file:
1
<config_plugin>
2
​
3
	<configFileDirectory>/opt/digiverso/goobi/config/</configFileDirectory>
4
	<!-- By editing a config file in the browser GUI, a backup file will be stored in the backup directory -->
5
	<configFileBackupDirectory>/opt/digiverso/goobi/config/backup/</configFileBackupDirectory>
6
	<!-- backup files will be stored as config.xml.1, config.xml.2, ..., config.xml.n -->
7
	<numberOfBackupFiles>8</numberOfBackupFiles>
8
​
9
</config_plugin>
Copied!
The parameters within this configuration file have the following meanings:
Parameter
Description
configFileDirectory
This is the path where the configuration files are located.
configFileBackupDirectory
This sets the path for the backup files where the backups of the configuration files are to be saved after editing.
numberOfBackupFiles
This integer value specifies how many backup files remain stored per configuration file before they are overwritten by new backups.
If help texts for individual configuration files are to be displayed, these must be stored within the messages files. For this purpose, an adjustment is made in these files, for example:
1
/opt/digiverso/goobi/config/messages_de.properties
2
/opt/digiverso/goobi/config/messages_en.properties
Copied!
For each configuration file, a value like the following can be entered there in the respective file.
German version within the file messages_de.properties:
1
plugin_administration_config_file_editor_help_goobi_projects.xml = Dies ist ein Hilfetext für die Konfiguration der Anlegemaske. <br/>Hier kann eine <i>Beschreibung</i>, die <b>formatiert</b> ist.<br/><br/><pre>Und auch Quellcode kann hier stehen</pre>
Copied!
English version within the file messages_en.properties:
1
plugin_administration_config_file_editor_help_goobi_projects.xml = This is a help text for the creation mask. <br/>You can add a <i>Description</i> here, which is <b>formatted</b>.<br/><br/><pre>And you can put source code here as well</pre>
Copied!
Note that the prefix plugin_administration_config_file_editor_help_ is added before the name of the configuration file.
Setting up required rights
This plugin has its own permission level for use. For this reason, users must have the necessary rights.
Kein Zugriff ohne korrekte Rechte
Therefore, please assign the following right to the user group of the corresponding users:
1
Plugin_administration_config_file_editor
Copied!
Korrekt zugewiesenes Recht für die Nutzer