Generate ARKs
Goobi Step Plugin for the creation of Archival Resource Keys (ARK) with metadata according to the DataCite schema.
Einführung
This documentation describes the installation, configuration and use of the Step Plugin for the generation of ARK identifiers in Goobi workflow.
[!WARNING] This update can only be used to a very limited extent from 01.01.2024. ARCs were generated in the plugin via the Rest API of arketype.ch, a service of the Geneva University of Applied Sciences, which will be shut down in the course of 2024. Arketype is a fork of EZID and could theoretically be used with it. However, the operation of a local ARK service using the ARK services of the Lucerne Central Library for ZentralGut is recommended. This Python script generates local identifiers, registers them in the global resolver and enters them into the processes in Goobi Workflow.
Details | |
---|---|
Identifier | intranda_step_ark |
Source code | |
Licence | GPL 2.0 or newer |
Compatibility | Goobi workflow 2022.03 |
Documentation date | 31.05.2022 |
How the plug-in works
The plugin is usually executed fully automatically within the workflow. It first determines whether an Archival Resource Key (ARK) already exists. If there is no ARK yet, a new ARK is registered. If an ARK already exists in the metadata, it attempts to update the metadata of the ARK.
Operation of the plug-in
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.
Installation
The plugin consists of the following file:
This file must be installed in the correct directory so that it is available at the following path after installation:
In addition, there is a configuration file that must be located in the following place:
Configuration
The configuration of the plugin is done via the configuration file plugin_intranda_step_ark.xml
and can be adjusted during operation. The following is an example configuration file:
Parameter | Explanation |
---|---|
| This parameter determines for which project the current block |
| This parameter controls for which workflow steps the block |
| The URL of the API must be stored in this parameter. As a rule, the standard entry |
| NAAN is an acronym for Name Assigning Number Authority. It is a unique identifier to which the account is assigned. |
| Name of the API user |
| Password of the API user |
| Name of the sub-namespace in which the new ARKs are to be created. |
| Corresponds to the |
| Corresponds to the |
| Corresponds to the |
| Corresponds to the |
| Corresponds to 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. |
| Specifies the metadata type under which the URN is to be recorded. The default should not be changed here. |
Last updated