Creation of Uniform Resource Names (URN)

Goobi Step Plugin for the creation of Uniform Resource Names (URN).

Overview

Name	Wert
Identifier	intranda_step_urn
Repository	https://github.com/intranda/goobi-plugin-step-urn
Licence	GPL 2.0 or newer
Last change	25.07.2024 11:18:17

Introduction

This documentation describes the installation, configuration and use of the Step Plugin for the generation of Uniform Resource Names in Goobi workflow.

Installation

The plugin consists of the following file:

plugin-intranda-step-urn-base.jar

This file must be installed in the correct directory so that it is available at the following path after installation:

/opt/digiverso/goobi/plugins/step/plugin-intranda-step-urn-base.jar

In addition, there is a configuration file that must be located in the following place:

/opt/digiverso/goobi/config/plugin_intranda_step_urn.xml

Overview and functionality

The plugin is usually executed fully automatically within the workflow. It first determines whether a Uniform Resource Name (URN) already exists. If no URN exists yet, a new URN is registered. If a URN already exists in the metadata, an attempt is made to update the metadata of the URN.

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 workflow step, it should be configured as shown in the screenshot below.

Integration of the plugin into the workflow

Note

This plugin uses a slightly modified table structure than the old URN plugin. When updating, it must be ensured that the urn column exists in the corresponding table. Furthermore, it must be ensured that e.g. for anchor elements whose URN was generated before the update, there is also a URN in the database.

Configuration

The configuration of the plugin is done via the configuration file plugin_intranda_step_urn.xml and can be adjusted during operation. The following is an example configuration file:

<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>
		
		<!-- name of the API user -->
		<apiUser>user</apiUser>

		<!-- password of the API user -->
		<apiPassword>password</apiPassword>

		<!-- URI of the URN API, must use https -->
		<apiUri>https://api.nbn-resolving.org/v2/</apiUri>

		<!-- namespace in which new URNs shall be created -->
		<!-- example urn:nbn:de:{SIGEL} -->
		<namespace>urn:nbn:de:{SIGEL}</namespace>

		<!-- infix that you want to use (optional) -->
		<infix></infix>
		
		<!-- optional Element, 
			increment if you want to use incrementation (300,301,302...) to generate the part after the infix
			timestamp if you want to use a time stamp (20420923063015) to generate the part after the infix
			default method is increment!
		  -->
		<generationMethod>increment</generationMethod>
		
		<!-- optional Element, 
			false if you don't want URNs with a Checksum
			true if you want URNs with a Checksum
		 -->
		<checksum>false</checksum>
	
		<!-- example URN urn:nbn:de:{SIGIL}-goobi-20220404123 -->

		<!--target url the newly generated urn will forward to. {pi.urn} will be 
			replaced with the newly minted urn -->
		<url>https://viewer.example.org/viewer/resolver?urn={pi.urn}</url>

		<!--Generate URN for the work (e.g. for Monograph, Manuscript, Volume, etc.)  -->
		<work>true</work>

		<!--Generate URN for the anchor Element -->
		<anchor>false</anchor>

		<!--Elements listed here will receive a URN. If work is set to true the 
			work element will receive a URN even if it is not listed here -->
		<!--
		<allowed>
			<type>Chapter</type>
		</allowed>
		-->
		<!-- metadata name for urns in METS-bloc "_urn" -->
		<typeNameMets>_urn</typeNameMets>

		<!--metadata name for URNs in MODS-bloc. -->
		<typeNameMods>URN</typeNameMods>

		<!--Shall the plugin create URNs in the MODS-bloc. The rule set entries 
			of certain elements may have to be altered, if you wish to use this -->
		<createModsUrns>false</createModsUrns>
	</config>
</config_plugin>

Parameter	Explanation
project	This parameter determines for which project the current block <config> should apply. The name of the project is used here. This parameter can occur several times per <config> block.
step	This parameter controls for which workflow steps the block <config> should apply. The name of the workflow step is used here. This parameter can occur several times per <config> block.
apiUser	The name of the API user.
apiPassword	The name of the API user.
apiUri	The URL of the API must be stored in this parameter. As a rule, the standard entry https://api.nbn-resolving.org/v2/ can be used.
namespace	The namespace in which the new URNs are created.
infix	Infix to be inserted in the generated URNs after the namespace. A new URN would have the form {namespace}{infix}{generatedValue}.
generationMethod	The plugin currently offers 2 options for generating a URN. timestamp and increment. The default value is increment. If you use timestamp, the time of generation of the URN will be appended after the infix in the form 2022-12-23-12-00-35. If you choose increment, a counter (1,2, ...301,302,..) is used.
checksum	Here you can specify whether a check digit should be generated (true) or not (false).
url	The URL under which the digitised work will be available in the future. As a rule, the publication URL will follow a pattern, e.g. https://viewer.example.org/viewer/resolver?urn={pi.urn}. The placeholder {pi.urn} will be replaced by the plugin with the new URN.
work	Switch that activates the setting of work URNs (Monograph, Manuscript, Volume, etc.).
anchor	Switch that activates the setting of URNs for the anchor element.
allowed -> type	Here you can list elements for which a URN is to be generated. For each element, a <type>ElementName</type> entry must be created in the <allowed> element. Note: If you set anchor or work to true, the anchor element and the work element will receive a URN even if their type names are not listed.
typeNameMets	Specifies the metadata type under which METS-URNs are to be recorded. The default should not be changed here.
typeNameMods	Specifies the metadata type under which MODS-URNs are to be recorded. The default should not be changed here.
createModsUrns	If you want to write URNs in the MODS block, set this switch to true. However, bear in mind that it may be necessary to adjust the rule sets of individual structural elements.