Update Metadata Fields
Step Plugin for automatically updating values in METS files
Last updated
Step Plugin for automatically updating values in METS files
Last updated
Identifier
intranda_step_metadata_update_field
Repository
Licence
GPL 2.0 or newer
Last change
04.09.2024 10:23:38
This Step plugin for Goobi workflow allows to automatically create or update specific metadata fields inside of METS files. To do so it can use the Variable Replacer or neighbor metadata fields to write metadata to logical elements on all hiearchical levels.
To be able to use the plugin, the following files must be installed:
After installing the plugin, it can be selected within the workflow for the respective work steps and thus executed automatically.
To use the plugin, it must be selected in a work step:
First, the values that the plugin is supposed to update must be defined in the configuration file. When the plugin is executed, it collects all relevant structural elements of the METS file. It then checks whether and how the specified values should be updated. If the conditions are met, either new values are inserted into empty fields, or existing values are overwritten if this is forced.
The plugin is configured in the file plugin_intranda_step_metadata_update_field.xml
as shown here:
The <config>
block can occur repeatedly for different projects or work steps in order to be able to perform different actions within different workflows. The other parameters within this configuration file have the following meanings:
project
This parameter defines which project the current block <config>
should apply to. The name of the project is used here. This parameter can occur several times per <config>
block.
step
This parameter controls which work steps the <config>
block should apply to. The name of the work step is used here. This parameter can occur several times per <config>
block.
In addition to these general parameters, the following parameters are available for further configuration:
<field>
Defines the field within the METS file for which the content should be generated.
<element>
Specifies the structural elements for which the content should be updated. Multiple element entries can be listed here. Use *
to match all structural element types.
<forceUpdate>
Indicates whether the content should be overwritten if the field is not empty.
variable
Analyzed and replaced by the variable replacer.
metadata
Uses the value of the metadata field with the given name inside the same structural element.
static
Uses a static string.
random
Generates a random number with a defined length.
uuid
Uses a UUID (Universally Unique Identifier) with 36 characters.
timestamp
Generates a numeric timestamp.
counter
Generates a sequential number that is automatically incremented. For example, using %03d
will count as follows: 001
, 002
, 003
, etc.
groupcounter
A separate counter for each value of the groupField
is used as the content.
<replace>
Allows text replacement, where specified texts are replaced with others.