Step plugin for Goobi workflow for generating OCR using Transkribus
| Name | Wert |
|---|---|
This documentation describes the installation, configuration and use of the Step plug-in for OCR using Transkribus.
To be able to use the plugin, the following files must be installed:
Once the plugin has been installed, it can be selected within the workflow for the respective work step and thus executed automatically. A workflow could look like the following example:
The work step must be configured so that the plugin is selected and the checkbox for the time delay is set.
The plugin is designed in such a way that it first uploads all images of a process to Transkribus at the start and then leaves the work step in processing. A file processing.json is created in the file system within the ocr subdirectory of the process, which shows the exact status of the respective pages. This looks like this as an example:
Goobi periodically calls all delay plug-ins in the background, including this one. With every automatic call and also every manual call via the administrative interface for the regular tasks, the plugin attempts to download the pages that have not yet been completed.
If all pages could be downloaded, the step is closed and the workflow continues. In the event of an error, however, the step changes its status to an error with corresponding error messages in the journal.
If a page is not uploaded, processed or downloaded correctly, it is recommended to proceed as follows:
Open the corresponding processing.json file from the ocr directory of the process
Set the value in status to NEW for the corresponding image
If necessary, set the number for failCounter and downloadCounter back to 0
Set the workflow step to In work again
Manually restart the delay job from the administrative interface for the regular tasks
The plugin is configured in the file plugin_intranda_step_transkribus.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:
In addition to these general parameters, the following parameters are available for further configuration:
| Parameter | Explanation |
|---|---|
| Parameter | Explanation |
|---|---|
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.
url
URL for the intranda licence server
login
Login for the intranda licence server
password
Password for the intranda licence server
model
Process property to be used, in which the Transkribus model ID is stored. This property is usually called Transkribus Model.
model-default
Transkribus model ID to be used if there is no property with a value in the process. Example: 36202
max-failed
Maximum number of new attempts if an OCR cannot be performed for a page. The workflow step remains in error status if the number of attempts is exceeded.
max-download
Maximum number of attempts to download the OCR result from Transkribus. The workflow step remains in error status if the number of attempts is exceeded.
Identifier
intranda_step_transkribus
Repository
Licence
Proprietary commercial
Last change
28.11.2024 07:24:10
