Catalogue Poller
Goobi Administration Plugin for the periodic update of existing METS files with contents from a catalog query.
This documentation describes how to install, configure and use the Administration plugin to automatically repeat a catalog query to update records in Goobi workflow.
Details | |
|---|---|
Identifier | intranda_administration_catalogue_poller |
Source code | |
Licence | GPL 2.0 or newer |
Compatibility | Goobi workflow 2021.02 |
Documentation date | 20.10.2022 |
The Catalogue Poller plugin is automatically activated by Goobi. Its runtime starts at the configured start time and repeats according to the configured number of hours.
If, in addition to this automatic process, a user also wants access to the plugin's user interface, he or she must belong to a user group that has been granted the following plugin-specific right to do so:
Plugin_Goobi_CataloguePoller
In order to assign this right, the desired user group must first be assigned the right authorization in the right-hand area.
User group with assigned authorization
If the authorization for the user group is re-entered, the user must first log into Goobi again in order to be able to use this authorization level. The user can then click on the Catalogue Poller plugin in the Administration menu and manually trigger an update of the records at any time.
User interface of the Catalgue Pollers
Possibility to download the results of a test run
Downloaded Excel file
If the plugin finds updated metadata for a process and therefore updates the METS file, a backup of the current METS file
meta.xml and, if relevant, the meta_anchor.xml is created automatically. The backup is saved next to the updated METS file.
Multiple versions of METS files are kept as backups
The updates of the metadata by the plugin usually take place fully automatically in the background. In order to be able to track what happened to a data record at any time, the events are logged. Detailed entries are automatically added to the process log for each process for which there were changes from this plugin. In addition to the timestamp, these entries also contain an exact list of the changed metadata fields and their contents. Thus, it is possible to trace the previous or the new value at any time.
Within the process log the changes of the Catalogue Poller are traceable
The plugin consists of the following files to install:
plugin_intranda_administration_catalogue-poller.jar
plugin_intranda_administration_catalogue-poller-GUI.jar
These files must be installed in the correct directories so that they are available in the following paths after the installation:
/opt/digiverso/goobi/plugins/administration/plugin_intranda_administration_catalogue-poller.jar
/opt/digiverso/goobi/plugins/GUI/plugin_intranda_administration_catalogue-poller-GUI.jar
There is also a configuration file, which must be located at the following location:
/opt/digiverso/goobi/config/plugin_intranda_administration_catalogue_poller.xml
The plugin is configured via the configuration file
plugin_intranda_administration_catalogue_poller.xml and can be adapted during operation. The following is an example configuration file:plugin:intranda:administration:catalogue:poller.xml
<?xml version="1.0" encoding="UTF-8"?>
<config_plugin>
<!-- multiple different rules can be defined for individual use cases -->
<rule title="SampleProject" startTime="22:00:00" delay="24">
<!-- filter which items to run through (can be more then one, otherwise use *)
please notice that blanks inside of the filter query need to be surrounded by quotation marks -->
<filter>project:SampleProject</filter>
<filter>"project:Manuscript items"</filter>
<!-- which catalogue to use (GBV, Wiener, CBL Adlib ...) -->
<catalogue>Wiener</catalogue>
<!-- which catalogue field to use and which identifier to use for the catalogue request (use
standard variable replacer compatible value here) -->
<catalogueField fieldName="12" fieldValue="$(meta.CatalogIDDigital)" />
<!-- define if existing structure subelements shall be kept (true),
otherwise a complete new mets file is created and overwrites the
existing one (false) -->
<mergeRecords>true</mergeRecords>
<!-- define if children shall be analysed as well. If a sub element contains an identifier, the metadata will get imported as well -->
<analyseSubElements>true</analyseSubElements>
<!-- execute an automatic export of updated records;
this is only executed if mergeRecords is set to true -->
<exportUpdatedRecords>false</exportUpdatedRecords>
<!--fieldList: Must have a mode attribute which can contain either blacklist or whitelist as a value.
blacklist: All fields are updated except the defined ones. This is a potentially dangerous setting!
whitelist: Only the definied fields are updated. All others are skipped.
field: Use the internal metadata names from the ruleset as field definition
-->
<fieldList mode="blacklist">
<field>viewerinstance</field>
<field>singleDigCollection</field>
<field>pathimagefiles</field>
<field>_urn</field>
<field>_representative</field>
</fieldList>
</rule>
<!-- internal timestamp for the plugin to know when it was last executed -->
<lastRun>1551731078691</lastRun>
</config_plugin>
Parameter | Description |
|---|---|
rule title | At this point, an internal name is specified, which is mainly used for the user interface to distinguish between the different rules |
rule startTime | This parameter sets the start time when the plugin should execute this rule. |
rule delay | This can be used to specify how often the plugin should be executed. The information is given here in the form of hours. |
filter | The filter can be used to define one or more Goobi projects for which the rules defined here apply. With * the rule applies to all projects. Any spaces contained within the filter must be enclosed in quotation marks in the same way as within the Goobi interface. |
catalogue | Here you can define which catalog is to be used for querying new data. This is the name of a catalog as it was defined within the global Goobi catalog configuration within goobi_opac.xml. |
fieldName | This parameter controls within which field the catalogue is queried. Often this value is 12 for example. |
fieldValue | Definition of the metadata from the METS file to be used for the catalog query. Usually this is the same identifier that was used for the first catalog query and is usually stored within the metadata ${meta.CatalogIDDigital}. |
exportUpdatedRecords | If this value is set to true, the catalog query is followed by a new data export for all records that were actually updated during the catalog query. In this case, the data export is the step that was defined as the first export step within the workflow for the operation. This usually refers to the export and publication of the process within the Goobi viewers. It should be noted here that the processes are only exported if the mechanism for mergeRecords is also set to false. |
mergeRecords | If the value true is set, the existing METS file is updated with the current data from the catalog. Any additional metadata can be excluded from the update. The logical and physical structure tree within the METS file also remains unchanged. If the value is set to false, the existing METS file will be completely replaced by a new METS file generated by the catalog query. |
analyseSubElements | This parameter can be used to define whether metadata for structural elements already existing within the METS files should also be queried by the catalogue. For this, the specified metadata for the identifier to be queried must be available for each sub-element. |
fieldList | The modes blacklist and whitelist are available here. If the 'whitelist' mode is selected, the metadata fields that are to be updated by a catalogue query can be defined here. If the 'blacklist' mode is used, several metadata fields can be defined that should not be changed by a catalogue query. This is particularly useful for those fields that do not come from a catalogue query and were therefore previously recorded in addition to the catalogue data. Typical examples of such fields include singleDigCollection,accesscondition and pathimagefiles.Please note that this parameter only applies if the value for mergeRecords is set to true. |
Last modified 7mo ago