February 2021

Documentation home Goobi workflow Handbook Goobi workflow Plugins
Search…
February 2021
Developments and innovations to Goobi workflow in February 2021
Coming soon
Extension of the processing of GoobiScripts
New rights management for the execution of GoobiScript
Better support for corporate bodies and metadata groups
Flex editor for capturing manuscripts and more
New search options for a search for processes by date
We have extended the search options so that it is now possible to find processes by their creation date. The search syntax is as follows.
1
processdate=2021
Copied!
It is also possible to filter for processes created before or after a certain date (or even time):
1
"processdate<2020-01-01 12:00:00"
Copied!
These new search parameters thus also allow processes to be searched for a period of time:
1
processdate>2020-01-01 processdate<2020-12-31
Copied!
Search for workflow steps by date
Analogous to the new search options for processes, it is also possible to filter by workflow steps. Here the distinction is between stepstartdate as the time of the start of processing and stepfinishdate for the time of the end of processing.
To filter for the end of processing, the status of a step must also be searched for in the same search query. This looks accordingly as follows:
1
stepdone:Export stepfinishdate:2019
Copied!
Example of search by completion date
The following filter searches for processes where Scanning and Export were completed in 2021:
1
stepdone:Scanning stepdone:Export stepfinishdate:2021
Copied!
The use of the search has been adapted to the new possibilities within the documentation and can still be found at this address:
7.1. Filtering processes
Goobi workflow (English)
https://docs.goobi.io/goobi-workflow-en/manager/7/7.1
Adaptation for the Change Workflow Plugin
The functionality of the Change Workflow plug-in has been extended. From now on, not only the status of tasks can be changed, but also the assignment of user groups. A configuration for this looks as follows, for example:
1
<config>
2
    <!-- which projects to use for (can be more then one, otherwise use *) -->
3
    <project>*</project>
4
    <step>*</step>
5
​
6
    <!-- multiple changes can be done within one configuration rule; simply add another 'change' element with other properties here -->
7
    <change>
8
      <!-- name of the property to check -->
9
      <propertyName>{meta.ISBN}</propertyName>
10
      <!-- expected value (can be blank too) -->
11
      <propertyValue></propertyValue>
12
      <!-- condition for value comparing, can be 'is' or 'not' or 'missing' or 'available' -->
13
      <propertyCondition>missing</propertyCondition>
14
​
15
      <!-- list of steps to deactivate -->
16
      <steps type="deactivate">
17
          <title>Metadata enrichment</title>
18
      </steps>
19
​
20
      <!-- user groups to assign -->
21
      <usergroups step="Metadata enrichment">
22
          <usergroup>Administration</usergroup>
23
      </usergroups>
24
    </change>
25
</config>
Copied!
In addition, with this update, properties of the processes can no longer be checked for their values alone. Instead, all available values that can be expressed as variables can now be used. From the previous configurations in this form:
1
<propertyName>Template</propertyName>
Copied!
such wording must now be used in the configuration files:
1
<propertyName>{process.Template}</propertyName>
Copied!
Further explanations about the possibilities of the variables can be found at the following URL:
8. Variables
Goobi workflow (English)
https://docs.goobi.io/goobi-workflow-en/manager/8
The updated documentation for the Change Workflow plugin can be found here:
Changing the workflow based on process properties
Goobi workflow Plugins (English)
https://docs.goobi.io/goobi-workflow-plugins-en/step/intranda_step_changeworkflow
Plugin for automatic generation of metadata within the METS file
In several projects, the requirement arose that metadata within the METS file should be dynamically updatable. For example, it should be possible to generate metadata for hierarchically subordinate structural elements and, if necessary, enrich them with data from other structural elements or properties.
As with many other plug-ins, this plug-in has been kept quite generic and can be configured very individually depending on the purpose and workflow. Such a configuration looks like this, for example:
1
<config_plugin>
2
    <config>
3
        <!-- which projects to use for (can be more then one, otherwise use *) -->
4
        <project>*</project>
5
        <step>*</step>
6
​
7
        <!-- multiple updates can happen within one call. 
8
            Repeat the update blocks for each additional change -->
9
        <update>
10
            <!-- define for which field inside of the METS file the content shall be generated -->
11
            <field>TitleDocMain</field>
12
​
13
            <!-- for which structure elements shall the content be updated? 
14
                Multiple 'element' can be listed here. 
15
                Use '*' to match all structure element types. -->
16
            <element>Monograph</element>
17
​
18
            <!-- define if the content shall be overwritten if the field is not empty -->
19
            <forceUpdate>true</forceUpdate>
20
​
21
            <!-- define a list of content here to be used for the field as metadata value
22
                variable: this content gets analyzed and replaced by the variable replacer 
23
                metadata: value of the metadata field with the given name inside of the same docstruct element
24
                static: a static string
25
                random: a random number with a defined length 
26
                uuid: a UUID with 36 characters
27
                timestamp: a numeric timestamp 
28
                groupcounter: a separate counter for each value of 'groupField' -->
29
            <content type="variable">{meta.CatalogIDDigital}</content>
30
            <content type="metadata">DocLanguage</content>
31
            <content type="static">_</content>
32
            <content type="random">9</content>
33
            <content type="uuid" />
34
            <content type="timestamp" />
35
            <content type="counter">%03d</content>
36
            <content groupField="{meta.PublicationYear}" type="groupcounter">%03d</content>
37
        </update>
38
​
39
        <update>
40
            <field>DocLanguage</field>
41
            <element>Chapter</element>
42
            <forceUpdate>false</forceUpdate>
43
            <content type="variable">{meta.DocLanguage}</content>
44
        </update>
45
​
46
    </config>
47
​
48
</config_plugin>
Copied!
In the case of this configuration example, several different data are inserted consecutively into the field 'TitleDocMain' within monographs. These are field contents from the Mets file, static values, timestamps, counters and other types. Such combinations can also be used for deeper structural elements and thus allow very flexible application possibilities.
The detailed documentation of the plugin has not been written yet and will follow soon. The source code of the plugin itself is available at the following URL:
GitHub - intranda/goobi-plugin-step-metadata-update-field: This plugin 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.
GitHub
https://github.com/intranda/goobi-plugin-step-metadata-update-field
Websockets for notifying users
By switching to current technologies (CDI, JSF 2.3), websockets can now be used in Goobi worflow. These enable a high-performance bidirectional communication between server and browser. This means that we are now able to send messages to the user from the server side. A first use case where this is applied are the following two areas:
Administrative messages that are to be displayed to all users are now immediately displayed to all users, not just at the next reload.
The progress of GoobiScript executions is displayed live, without the need for a manual reload to update the progress bar.
Display of administrative warnings to users
Goobi now monitors dead letter queue for external queue
When a message in a message queue repeatedly generates errors, it is marked as undeliverable and sent to another message queue, the "dead letter queue". Goobi now monitors this "Dead Letter Queue" for messages and sets the step associated with the message to error status so that a human user can view the error.
Dashboard enhanced for backlogged tasks
The most frequently used dashboard has received a helpful enhancement. There, it is now possible for those tasks to be listed that the user completed last. In addition to the display of which tasks the user is currently working on, there is now an immediate view of the recently completed tasks.
Display tasks that have already been completed on the dashboard
At the same time, a frequently expressed wish was realised: Recently completed tasks that have already disappeared from the task list and have progressed further in the workflow can also be undone from the dashboard in order to process them again. However, this is only possible if the subsequent task has not already been accepted for processing by a user or started by an automatism.
Extended logic for adjustments to the sequence of workflow steps
The mostly sequential order of workflow steps basically allows a very good overview of the sequence of tasks involved and their progress. However, we found the operation too cumbersome if the sequence of tasks should be changed or new tasks should be integrated between existing tasks of a workflow. Therefore, some major changes were made here. In the revised user interface, tasks can be moved by means of the arrow icon so that the corresponding sequence numbers of the workflow steps concerned are automatically adjusted without having to change the sequence numbers manually.
Extended possibilities for adjusting the sequence of workflow steps
The second major innovation in this context is that new tasks to be integrated into an existing workflow are automatically given a correct sequence number, so that the new task is automatically placed correctly at the end of the existing workflow.
Insertion of new tasks with extended logic for the sequence position
If, however, a sequence number is specified at this point that lies in the middle of the workflow, the already existing tasks are automatically shifted by one position each in order to insert the new task in between. However, this behaviour can also be prevented if desired, so that parallel execution of tasks is still possible.
To benefit from these new developments, this logic has also been extended to the execution of GoobiScript. For this reason, a new GoobiScript exists that allows the insertion of tasks into the workflow, taking into account the correct sequences to be changed for inserted tasks, even in bulk.
New GoobiScript for inserting new tasks for many processes
For the use of the new GoobiScript, see the relevant section within the Goobi workflow documentation:
7.4. GoobiScript
Goobi workflow (English)
https://docs.goobi.io/goobi-workflow-en/manager/7/7.4#goobiscript-addstepatotherstepposition