Config Editor

This editor allows direct editing of the Goobi workflow configuration files from within the user interface in the web browser.

Overview

The editor can be found as a separate entry in the Administration menu, from where it can be opened.

Opened configuration editor without a loaded file

After opening, all Goobi configuration files are listed on the left side. These can be opened for editing by clicking the respective icon.

Opened configuration editor with a loaded file

When a file is opened, a text editor appears on the right side where the file can be edited.

After making changes to a file and clicking the Save button, a confirmation message is displayed indicating that the file was saved successfully.

Confirmation message erfolgreiche Speichern

If a file has been modified and the user attempts to switch to another file without saving first, a prompt will appear asking how to proceed with the unsaved changes.

Prompt for unsafed changes

Configuration

The configFileDirectories element contains a list of directories that are used to collect all displayed files in the browser interface.

Each directory should be an absolute path that contains xml or properties files. Other file types are not supported until now. The directory name may end with a slash (/), otherwise it will be added automatically.

Backups are automatically created in a subfolder called "backup/". You can override this with the optional attribute backupFolder="myOwnBackupPath/".

IMPORTANT: The directory must be an absolute path while the backupFolder parameter must be a relative path. The backup directory name may end with a slash (/), otherwise it will be added automatically. To save backup files in the selected configuration directory, overwrite the backup folder with backupFolder="".

By default 8 backup files are kept, older files will be deleted. You can override this with the optional attribute backupFiles="".

You can filter the displayed configuration files in a directory with the fileRegex="" parameter. If the parameter is not used or is empty, it will be ignored.