Import of data records of the BDA Austria

Introduction
This documentation describes the installation, configuration and use of the plugin for the mass import of existing old data of the Federal Monuments Office in Austria. The starting point for the import are existing Excel files as well as provided directories with image files. The special structure of the Excel file made a significant revision of the standard Excel import plugin necessary, so that this plugin differs significantly from it.
Details
Text
Identifier
intranda_import_bka_bda
Source code
​https://github.com/intranda/goobi-plugin-import-bka-bda​
Licence
GPL 2.0 or newer
Compatibility
Goobi workflow 2021.09
Documentation date
30.09.2021
Installation
The plugin must be installed in the following folder:
1
/opt/digiverso/goobi/plugins/import/plugin_intranda_import_bka_bda.jar
Copied!
In addition, there is a configuration file that must be located in the following place:
1
/opt/digiverso/goobi/config/plugin_intranda_import_bka_bda.xml
Copied!
Configuration
The configuration is done via the file plugin_intranda_import_bka_bda.xml. This file can be adapted during operation.
1
<config_plugin>
2
	<config>
3
		<!-- which workflow template shall be used -->
4
		<template>*</template>
5
		<!-- publication type to create -->
6
		<publicationType>Document</publicationType>
7
        <imageType>Photograph</imageType>
8
		<!-- which digital collection to use
9
		<collection>General</collection>
10
		 -->
11
		<processTitleColumn>Vorgang</processTitleColumn>
12
		<!-- define in which row the header is written, usually 1 -->
13
		<rowHeader>1</rowHeader>
14
		<!-- define in which row the data starts, usually 2 -->
15
		<rowDataStart>1</rowDataStart>
16
		<!-- define in which row the data ends, usually 20000 -->
17
		<rowDataEnd>10000</rowDataEnd>
18
		<!-- define if import shall use GoobiScript to run in the background -->
19
		<runAsGoobiScript>true</runAsGoobiScript>
20
        
21
        <!-- column for the path to the images -->
22
        <imageFolderHeaderName>Importpfad Bildobjekt</imageFolderHeaderName>
23
​
24
		<!-- individual metadata fields read from the excel columns -->
25
		<mainMetadata rulesetName="CatalogIDDigital" columnName="DMDB-ID" />
26
		<mainMetadata rulesetName="HerisID" columnName="HERIS-ID" />
27
		<mainMetadata rulesetName="FederalState" columnName="Bundesland" />
28
		<mainMetadata rulesetName="Location" columnName="Ort" />
29
		<mainMetadata rulesetName="Address" columnName="Adresse" />
30
		<mainMetadata rulesetName="TitleDocMain" columnName="Objekttitel" />
31
		<mainMetadata rulesetName="Photographer" columnName="FotografIn" />
32
		<mainMetadata rulesetName="DateRecorded" columnName="Aufnahmejahr" />
33
		<mainMetadata rulesetName="DateRecordedInformation" columnName="Aufnahmedatum Zusatzinfo" />
34
		<mainMetadata rulesetName="KeyNumber" columnName="GZ" />
35
		<mainMetadata rulesetName="Condition" columnName="Erhaltungszustand des Objekts" />
36
		<mainMetadata rulesetName="Remarks" columnName="Sonstiges/Anmerkungen" />
37
		<mainMetadata rulesetName="ObjectType" columnName="Objekttyp" />
38
		<mainMetadata rulesetName="Series" columnName="Serie" />
39
		<mainMetadata rulesetName="SubSeries" columnName="Unterserie" />
40
​
41
		<imageMetadata rulesetName="View" columnName="Ansicht" />
42
		<imageMetadata rulesetName="shelfmarksource" columnName="Signatur" />
43
		<imageMetadata rulesetName="FormerFilePath" columnName="Ursprünglicher Dateipfad" />
44
		<imageMetadata rulesetName="Copyright" columnName="Rechteinhaber" />
45
		<imageMetadata rulesetName="ImportPath" columnName="Importpfad Bildobjekt" />
46
​
47
	</config>
48
</config_plugin>
Copied!
Individual configurability
It is possible to create a global configuration for all production templates as well as individual settings for single production templates. To do this, the config element can be repeated in the XML file. If mass import is selected in Goobi, the system searches for the configuration block that contains the name of the selected production template in the template element. If such an entry does not exist, the default configuration is used. This is indicated by *.
1
<!-- which workflow template shall be used -->
2
<template>*</template>
Copied!
Publication type
The following parameter can be used to globally define the publication type to be used:
1
<!-- publication type to create -->
2
<publicationType>Monograph</publicationType>
Copied!
Every process that is created in Goobi with this plugin receives the application type defined here.
Structure types
The special feature of this plugin is that structural elements are to be generated from the partially repeating Excel table rows, which are to be created as sub-elements for the previously created publication type. The type to be used for this is specified with this parameter:
1
<imageType>Photograph</imageType>
Copied!
Collection
With the optional element collection it is possible to define a collection to be inserted in all records. In addition, collections can also be selected from the interface, or the collection can be imported as part of the Excel file or from the catalogue.
1
<!-- which digital collection to use -->
2
<collection>Example collection</collection>
Copied!
Row range
The following elements describe the structure of the Excel file to be imported.
In rowHeader it is defined in which row the column headers are entered that are later relevant for the mapping. Usually this is the first line. However, this can also deviate in the case of multi-line entries.
1
<!-- define in which row the header is written, usually 1 -->
2
<rowHeader>1</rowHeader>
Copied!
The elements rowDataStart and rowDataEnd describe the area that contains the data. Usually these are the lines that directly follow the rowHeader, but in the case of special formatting there may also be empty lines that can be removed via this.
1
<!-- define in which row the data starts, usually 2 -->
2
<rowDataStart>2</rowDataStart>
3
<!-- define in which row the data ends, usually 20000 -->
4
<rowDataEnd>20000</rowDataEnd>
Copied!
Identifier
The entry identifierHeaderName contains the heading of the column that contains an identifier. This field is used internally to identify the rows. In an OPAC query, this value is used. In addition, this value is also used for generating the case title if no other generation for case titles has been specified.
1
<!-- define which column is the one to use for catalogue requests and to identify the row during the import -->
2
<identifierHeaderName>Identifier</identifierHeaderName>
Copied!
Process title
The processTitleRule element is used to generate the process title. The same options are available here that can be used in the Goobi configuration file goobi_projects.xml.
1
<!-- Rules to generate the process title, the same syntax as in goobi_projects.xml can be used.
2
     Use the column names to get the right metadata values.
3
     If the field is missing or empty, the value of the identifier column is used.
4
-->
5
<processTitleRule>'StaticPrefix_'+Identifier</processTitleRule>
Copied!
Importing images
With the help of the elements imageFolderHeaderName, imageFolderPath and moveImages, images can be imported in addition to the metadata. In imageFolderHeaderName the column name is entered for this purpose, in which the folder names containing the images can be found in the Excel file. Either an absolute path or a relative path can be entered. If a relative path is specified, the element imageFolderPath must contain the root path to the images.
The element moveImages can be used to control whether the images are to be copied or moved.
1
<!-- define which column contains the image folder name. Can be combined with <imageFolderPath> prefix or an absolute path.
2
      If the field is missing, empty or does not contain an existing directory, no images will be imported -->
3
<imageFolderHeaderName>image folder</imageFolderHeaderName>
4
​
5
<!-- prefix path to the image folder. Can be empty or missing if the import doesn't contain images or if the excel field contains absolute path  -->
6
<imageFolderPath>/mnt/images/</imageFolderPath>
7
​
8
<!-- defines, if images are moved from the source folder to the destination (true) or copied (false) -->
9
<moveImages>true</moveImages>
Copied!
Execution via GoobiScript
The element runAsGoobiScript controls whether an import should be processed asynchronously in the background via the GoobiScript queue or whether the import should be processed directly within the user session. Here you have to decide which setting makes sense. If an import is to include images or if the Excel file contains a large number of data records, it is probably more sensible to perform this import as a GoobiScript.
1
<!-- Run the import as GoobiScript -->
2
<runAsGoobiScript>true</runAsGoobiScript>
Copied!
Attention: If the column identifierHeaderName does not contain a unique identifier or has not been configured, the option runAsGoobiScript cannot be used.
Configuration of the individual Excel columns
The fields metadata, person and group can be used to import individual columns as metadata or as transaction properties. For this purpose, each field contains a number of attributes and sub-elements.
Importing metadata
The element metadata is used to create descriptive metadata.
Name
Type
Description
headerName
Attribut
Column title in the Excel file
ugh
Attribut
Metadate name
property
Attribut
Property name
docType
Attribut
anchor or child
normdataHeaderName
Attribut
Column title of a column with associated identifiers
opacSearchField
Attribut
Definition of which search field is to be used for the catalogue query. This is necessary for the use of the JSON Opac plugin.
The attribute headerName contains the column title. The rule only applies if the Excel file contains a column with this title and the cell is not empty. At least one of the two attributes ugh and name must exist. The field ugh can contain the name of a metadatum. If this is the case (and the metadatum is allowed for the configured publication type), a new metadatum is created. A property with this name is created using name.
The attribute docType becomes relevant if a multi-volume work or a journal has been imported from the catalogue. It can be used to control whether the field should belong to the complete record or to the volume.
If, in addition to the content, another column with standard data identifiers or URIs exists, this column can be added in the attribute normdataHeaderName.
Use in Goobi
To use the import, the mass import area must be opened in the production templates and the plugin intranda_import_bka_bda must be selected in the File Upload Import tab. An Excel file can then be uploaded and imported.
The import is then carried out line by line. A new process is created for each object and the configured rules are applied. If a valid data record has been created and the generated process title has not yet been assigned, the process is actually created and saved. Within the Excel file, subsequent lines belonging to the Goobi process to be generated are created with the desired structure type depending on the configuration. Associated images are also automatically transferred and assigned to the generated structural elements and processes.