This generic import plugin allows the bulk import of data from JSON files
Name | Wert |
---|---|
This is the technical documentation for the workflow plugin for Goobi workflow, which is used to read metadata from multiple JSON files and create processes based on it.
To install the plugin, the following two files must be installed:
To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:
The content of this configuration file is as follows:
The configuration of the plugin is as follows:
The following attributes can be configured in a group
element:
The following attributes can be configured in a child
element:
There is an option to generate and save a metadata for the partner's URL. The URL to be generated is defined as follows: {urlBase}/{urlPart_1}/{urlPart_2}/.../{urlPart_k}/{urlTail}/
Value | Description |
---|---|
Value | Description |
---|---|
Value | Description |
---|---|
Value | Description |
---|---|
jsonFolder
Path to the directory where the JSON files are located.
importFolder
Path to the directory where the images to be downloaded are to be saved before they are imported into the processes.
workflow
Name of the production template to be used.
publicationType
Publication type for the transactions to be created.
downloadableUrl
Type of metadata in which the URL from which the images are to be downloaded is specified. This value is repeatable.
metadata
A metadata object is generated from each tag. The attribute @source
refers to a JSON path if it begins with $
. The value of the metadata is read from this path. In this case, the attribute refers to a list if it also ends with [:]
. If it does not start with either $
or @
, it is used as the value of the metadata. The attribute @target
configures the name of the metadata type.
group
Metadata groups are configured here. There are six attributes, which are explained below. Several metadata
elements can be configured under a group
element, whose @source
attributes should start with @
.
child
Structure elements are configured here. There are five attributes, which are explained below. Several metadata
elements can be configured under a child
element, whose @source
attributes should start with @
.
@source
JSON path to the parent element of a list. Starts with a $
.
@type
Type of the metadata group.
@altType
Alternative type of the metadata group. If the alternative type is configured correctly, a metadata group of this type is created from all filtered entries. If the attribute is not configured or if the configured type cannot be found, all filtered entries are not imported. This parameter is optional.
@key
Key of the JSON objects for filtering. This parameter is optional.
@value
Value for comparison when filtering. This parameter is optional.
@method
Logic to be used for filtering. Options here are is
, not
, startsWith
, endsWith
and contains
. This parameter is optional. The default value is is
.
@source
JSON path to the parent element of a list. Starts with a $
.
@type
Type of the structure element.
@key
Key of the JSON objects for filtering. This parameter is optional.
@value
Value for comparison when filtering. This parameter is optional.
@method
Logic to be used for filtering. Options here are is
, not
, startsWith
, endsWith
and contains
. This parameter is optional. The DEFAULT value is is
.
partnerUrl
The save
attribute configures whether a metadata should be generated for the partner's URL. The DEFAULT value is false
.
urlBase
Here you configure the URL to the partner's server. This parameter is optional. A maximum of one hit is possible.
urlPart
The parts of the URL whose values from the JSON objects are to be appended to the urlBase
one after the other are configured here. This parameter is optional. Multiple hits are possible.
urlTail
The trailing part of the URL is configured here. This parameter is optional. A maximum of one hit is possible.
urlMetadata
Type of metadata.
Identifier
intranda_workflow_import_json
Repository
Licence
GPL 2.0 or newer
Last change
14.08.2024 19:06:00