Ruleset editor

This editor is used to directly edit the ruleset files of Goobi workflow directly from the user interface within the web browser.

Übersicht

The editor can be found in its own entry in the Administration menu, from where it can be opened.

Open editor without loaded file

After opening, all Goobi ruleset files are listed on the left-hand side. These can be opened by clicking on the respective icon in order to edit them.

Open editor with 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.

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.

Dateien innerhalb des Backup-Verzeichnisses

The file can also be validated by clicking the Validate button. All listed checks will be performed during this process.

Validated ruleset

After modifying a file and clicking the Save button, a confirmation message appears indicating the file was saved successfully.

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

Validation

When the Validatebutton is pressed, the following checks are performed.

Well-Formedness

Are all opening tags <> properly closed? Are any invalid characters used? Are attributes placed in the wrong position?

Invalid Names

Do all <MetadataType>, <Group>, <DocStrct>, and export formats have a <Name> element (or, for some export formats, an <InternalName> element) and is its value not empty? (ValidateNames)

Empty Translations

Is every value listed within a <language> element non-empty and not composed solely of whitespace? (ValidateTranslations)

Invalid Cardinality

Does each <metadata> and <group> subelement of <DocStrctType> have a valid value for the num attribute? Valid values are: 1o, *, 1m, and +. (ValidateCardinality)

Duplicate Definitions

Are all <MetadataType>, <Group>, and <DocStrctType> elements defined only once? (ValidateDataDefinedMultipleTimes)

Duplicates

Are the same <metadata>, <allowedChildType>, or <group> elements used multiple times within a <Group> or <DocStrctType>? (ValidateDuplicatesInGroups and ValidateDuplicatesInDocStrct)

Incorrect Use of Publication Types

Have <DocStrctType> elements with the attribute <topStruct="true"> been incorrectly used as <allowedChildType> within other <DocStrctType> elements? (ValidateTopstructs)

Undefined Metadata Types

Is there a <metadata> element used within <Group>, <DocStrct>, or in the export formats that has not been defined as a <MetadataType>?(ValidateUsedButUndefinedData)

Unused Metadata Types

Is a <MetadataType> element defined but not used in <Group>, <DocStrct>, or within export formats?(ValidateUnusedButDefinedData)

Unused Structure Types

Is a <DocStrctType> element defined but not used as an <allowedChildType> in any other <DocStrctType>? (ValidateUnusedButDefinedData)

Unmapped Structure Types

Are <DocStrctType>, <MetadataType>, and <Group> elements defined but not used in any export configuration? (ValidateDataNotMappedForExport)