Generate Docket Files
This Step Plugin allows you to automatically generate docket files in various file formats.

Introduction

This plugin can be used in any task to automatically generate and save a docket when the task is processed. The plugin supports PDF and TIFF files.

Overview

Details
Text
Identifier
intranda_step_save_docket_file
License
GPL 2.0 or newer
Compatibility
Goobi workflow 2022.04
Documentation date
28.04.2022

Installation

The following file must be present to install the plugin:
1
/opt/digiverso/goobi/plugins/step/plugin_intranda_step_save_docket_file.jar
Copied!
To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:
1
/opt/digiverso/goobi/config/plugin_intranda_step_save_docket_file.xml
Copied!

Configuration of the plugin

The configuration of the plugin is as follows:
1
<config_plugin>
2
<!--
3
order of configuration is:
4
1.) project name and step name matches
5
2.) step name matches and project is *
6
3.) project name matches and step name is *
7
4.) project name and step name are *
8
-->
9
<config>
10
<!-- which projects to use for (can be more then one, otherwise use *) -->
11
<project>*</project>
12
<step>*</step>
13
14
<template file="/opt/digiverso/goobi/xslt/docket.xsl" />
15
16
17
<!-- mimeType: image/tiff or application/pdf -->
18
<!-- filename: name of the output file-->
19
<!-- folder: name of the output folder, e.g. 'master' or 'media' -->
20
<output mimeType="image/tiff" filename="00000000.tif" folder="master" />
21
22
<!-- Set the number of dots per inch for the output file here. Common values are 300 or 600 -->
23
<dotsPerInch>150</dotsPerInch>
24
25
</config>
26
</config_plugin>
Copied!
Value
Description
project
This parameter specifies for which project the current <config> block should apply. The name of the project is used here. This parameter can occur multiple times per <config> block. If the value is set to *, all projects will be considered.
step
This parameter defines for which work steps the <config> block should apply. The name of the step is used here. This parameter can occur several times per <config> block. If the value is set to *, all work steps will be considered.
template
This element specifies which docket template should be used for generation. The file parameter specifies an absolute file path to an existing .xsl file.
output
This element specifies where and how the destination file should be stored. The folder parameter specifies the corresponding subfolder within the images folder of a project. For example, master or media can be selected here. The filename parameter specifies the file name. The file extension must match the specified MimeType. This is configured with the mimeType parameter and can be set to either image/tiff or application/pdf.
dotsPerInch
This value specifies the resolution of the exported document. The unit is pixels per inch. The default value is 150 DPI.

Use of the plugin

In case of an automatic task, the plugin will be executed automatically as soon as the corresponding task is executed. There is an additional button at the corresponding task in the task details, with which the docket can be generated manually at any time.

Anwendung des Plugins

This plugin is integrated into the workflow in such a way that it is executed automatically. Manual interaction with the plugin is not necessary. For use within a work step of the workflow, it should be configured as shown in the screenshot below.
Integration of the plugin into the workflow