1 of 1

Generation of docket files

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

Overview

Name

Wert

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.

Installation

The following file must be present to install the plugin:

/opt/digiverso/goobi/plugins/step/plugin-intranda-step-save-docket-file-base.jar

To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:

/opt/digiverso/goobi/config/plugin_intranda_step_save_docket_file.xml

Overview and functionality

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.

This plugin can also be 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.

Configuration

Configuration of the plugin

The configuration of the plugin is as follows:

<config_plugin>
    <!--
        order of configuration is:
          1.) project name and step name matches
          2.) step name matches and project is *
          3.) project name matches and step name is *
          4.) project name and step name are *
    -->
    <config>
        <!-- which projects to use for (can be more then one, otherwise use *) -->
        <project>*</project>
        <step>*</step>

        <template file="/opt/digiverso/goobi/xslt/docket.xsl" />


        <!-- mimeType: image/tiff or application/pdf -->
        <!-- filename: name of the output file-->
        <!-- folder: name of the output folder, e.g. 'master' or 'media' -->

        <!--
        In the filename parameter, following variables can be used:
            {process} - inserts the whole process title
            {process_suffix} - inserts the suffix of the process title behind the first underscore

        Examples:
            process title: "media_abc_def"
            EPN_{process}_0000.tif -> EPN_media_abc_def_0000.tif
            EPN_{process_suffix}_0000.tif -> EPN_abc_def_0000.tif
        -->
        <output mimeType="image/tiff" filename="EPN_{process}_0000.tif" folder="master" />

        <!-- Set the number of dots per inch for the output file here. Common values are 300 or 600 -->
        <dotsPerInch>150</dotsPerInch>

    </config>
</config_plugin>

Output file name

The file name of the generated docket file can optionally be specified individually with the following parameters.

If a process title does not contain an underscore and {process_suffix} is used anyway, the entire process title will be inserted instead.

Examples:

Generation of docket files

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

Overview

Name

Wert

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.

Installation

The following file must be present to install the plugin:

/opt/digiverso/goobi/plugins/step/plugin-intranda-step-save-docket-file-base.jar

To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:

/opt/digiverso/goobi/config/plugin_intranda_step_save_docket_file.xml

Overview and functionality

Configuration

Configuration of the plugin

The configuration of the plugin is as follows:

<config_plugin>
    <!--
        order of configuration is:
          1.) project name and step name matches
          2.) step name matches and project is *
          3.) project name matches and step name is *
          4.) project name and step name are *
    -->
    <config>
        <!-- which projects to use for (can be more then one, otherwise use *) -->
        <project>*</project>
        <step>*</step>

        <template file="/opt/digiverso/goobi/xslt/docket.xsl" />


        <!-- mimeType: image/tiff or application/pdf -->
        <!-- filename: name of the output file-->
        <!-- folder: name of the output folder, e.g. 'master' or 'media' -->

        <!--
        In the filename parameter, following variables can be used:
            {process} - inserts the whole process title
            {process_suffix} - inserts the suffix of the process title behind the first underscore

        Examples:
            process title: "media_abc_def"
            EPN_{process}_0000.tif -> EPN_media_abc_def_0000.tif
            EPN_{process_suffix}_0000.tif -> EPN_abc_def_0000.tif
        -->
        <output mimeType="image/tiff" filename="EPN_{process}_0000.tif" folder="master" />

        <!-- Set the number of dots per inch for the output file here. Common values are 300 or 600 -->
        <dotsPerInch>150</dotsPerInch>

    </config>
</config_plugin>

Value

Description

Output file name

The file name of the generated docket file can optionally be specified individually with the following parameters.

Variable

Description

If a process title does not contain an underscore and {process_suffix} is used anyway, the entire process title will be inserted instead.

Examples:

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. The filename parameter also allows variables. They are described in more detail below.