Skip to content

Commit 8179d87

Browse files
janvondejanvonde
committed
Merge pull request 'Release v24.07' (#11) from release_24.07 into master
2 parents 7287c30 + 85e2b93 commit 8179d87

File tree

7 files changed

+120
-20
lines changed

7 files changed

+120
-20
lines changed

‎README.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,38 @@
22

33
<img src="https://goobi.io/wp-content/uploads/logo_goobi_plugin.png" align="right" style="margin:0 0 20px 20px;" alt="Plugin for Goobi workflow" width="175" height="109">
44

5-
Opac plugin to import data into Goobi workflow from a PICA source
5+
This OPAC plugin for Goobi workflow allows a data transfer from a source that provides PICA records.
66

77
This is a plugin for Goobi workflow, the open source workflow tracking software for digitisation projects. More information about Goobi workflow is available under https://goobi.io. If you want to get in touch with the user community simply go to https://community.goobi.io.
88

99
## Plugin details
1010

1111
More information about the functionality of this plugin and the complete documentation can be found in the central documentation area at https://docs.goobi.io
1212

13-
Detail | Description
14-
--- | ---
13+
Detail | Description
14+
--------------------------- | ----------------------
1515
**Plugin identifier** | intranda_opac_pica
16-
**Plugin type** | Opac plugin
17-
**Licence** | GPL 2.0 or newer
18-
**Documentation (German)** | https://docs.goobi.io/goobi-workflow-plugins-de/opac/intranda_opac_pica
19-
**Documentation (English)** | https://docs.goobi.io/goobi-workflow-plugins-en/opac/intranda_opac_pica
16+
**Plugin type** | opac
17+
**Licence** | GPL 2.0 or newer
18+
**Documentation (German)** | https://docs.goobi.io/workflow-plugins/v/eng/opac/goobi-plugin-opac-pica
19+
**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/ger/opac/goobi-plugin-opac-pica
2020

2121
## Goobi details
2222

2323
Goobi workflow is an open source web application to manage small and large digitisation projects mostly in cultural heritage institutions all around the world. More information about Goobi can be found here:
2424

25-
Detail | Description
26-
--- | ---
27-
**Goobi web site** | https://www.goobi.io
28-
**Twitter** | https://twitter.com/goobi
29-
**Goobi community** | https://community.goobi.io
25+
Detail | Description
26+
--------------------------- | ---------------------------
27+
**Goobi web site** | https://www.goobi.io
28+
**Goobi community** | https://community.goobi.io
29+
**Goobi documentation** | https://docs.goobi.io
3030

3131
## Development
3232

3333
This plugin was developed by intranda. If you have any issues, feedback, question or if you are looking for more information about Goobi workflow, Goobi viewer and all our other developments that are used in digitisation projects please get in touch with us.
3434

35-
Contact | Details
36-
--- | ---
37-
**Company name** | intranda GmbH
38-
**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
39-
**Web site** | https://www.intranda.com
40-
**Twitter** | https://twitter.com/intranda
35+
Contact | Details
36+
--------------------------- | ----------------------------------------------------
37+
**Company name** | intranda GmbH
38+
**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
39+
**Web site** | https://www.intranda.com

‎docs/index_de.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: PICA Import
3+
identifier: intranda_opac_pica
4+
published: true
5+
description: OPAC Plugin für die Datenübernahme von PICA Datensätzen
6+
---
7+
## Einführung
8+
Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz des Plugins. Mit Hilfe dieses Plugins können Daten aus einem externen System abgefragt und in Goobi übernommen werden. Der Katalog muss eine API bzw. URL haben, über die Datensätze als OPAC ausgeliefert werden können.
9+
10+
11+
## Installation
12+
Das Plugin besteht aus einer Datei:
13+
14+
```bash
15+
plugin_intranda_opac_pica-base.jar
16+
```
17+
18+
Diese Datei muss für den Nutzer `tomcat` lesbar an folgendem Pfad installiert werden:
19+
20+
```bash
21+
/opt/digiverso/goobi/plugins/opac/plugin_intranda_opac_pica-base.jar
22+
```
23+
24+
25+
## Überblick und Funktionsweise
26+
Wenn in Goobi nach einem Identifier gesucht wird, wird im Hintergrund eine Anfrage an die konfigurierte URL gestellt.
27+
28+
![Oberfläche von Goobi workflow zur Abfrage des Katalogs](screen1_de.png)
29+
30+
Nach der Abfrage des eigentlichen Datensatzes aus dem PICA-Katalog erfolgt das Mapping der Metadaten gemäß der im Regelsatz konfigurieren Regeln.
31+
32+
33+
## Konfiguration
34+
Das Plugin selbst verfügt nicht über keine eigene Konfiguration. Stattdessen erfolgt sämtliche Konfiguration über Anpassungen innerhalb von Goobi workflow bzw. der zugehörigen Regelsätze.
35+
36+
In der Datei `goobi_opac.xml` muss die Schnittstelle zum gewünschten Katalogsystem bekannt gemacht werden. Dies geschieht durch einen Eintrag, der wie folgt aussieht:
37+
38+
```xml
39+
<catalogue title="PICA OPAC">
40+
<config address="kxp.k10plus.de" database="2.1"
41+
description="K10plus" iktlist="IKTLIST-GBV.xml" port="80"
42+
ucnf="UCNF=NFC&amp;XPNOFF=1" />
43+
</catalogue>
44+
```
45+
46+
Das Attribut `title` enthält den Namen, unter dem der Katalog in der Nutzeroberfläche ausgewählt werden kann, `address` die URL zum API-Endpoint und `database` die zu verwendende Datenbank.
47+
48+
Das Mapping der Inhalte eines PICA-Datensatzes erfolgt innerhalb des jeweilig verwendeten Regelsatzes von Goobi workflow. Genauere Informationen, wie dieses Mapping konfiguriert werden kann finden sich innerhalb der UGH-Dokumentation hier:
49+
50+
[https://docs.goobi.io/ugh-de/4/4.3/4.3.2](https://docs.goobi.io/ugh-de/4/4.3/4.3.2)
51+

‎docs/index_en.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: PICA Import
3+
identifier: intranda_opac_pica
4+
published: true
5+
description: OPAC Plugin for the data transfer of PICA data records
6+
---
7+
## Introduction
8+
This documentation describes the installation, configuration and use of the plugin. You can use this plugin to retrieve data from an external system and transfer it to Goobi. The catalog must have an API or URL that can be used to deliver records as OPACs.
9+
10+
11+
## Installation
12+
The plugin consists of one file:
13+
14+
```bash
15+
plugin_intranda_opac_pica-base.jar
16+
```
17+
18+
This file must be installed readable for the user `tomcat` at the following path
19+
20+
```bash
21+
/opt/digiverso/goobi/plugins/opac/plugin_intranda_opac_pica-base.jar
22+
```
23+
24+
25+
## Overview and functionality
26+
When you search for an identifier in Goobi, a request is sent to the configured URL in the background.
27+
28+
![Goobi workflow interface for querying the catalogue](screen1_en.png)
29+
30+
After retrieving the actual record from the PICA-catalog, the metadata is mapped according to the rules configured in the rule set.
31+
32+
33+
## Configuration
34+
The plugin itself does not have its own configuration. Instead, all configuration is carried out by making adjustments within Goobi workflow or the associated rule sets.
35+
36+
In the file `goobi_opac.xml`, the interface to the desired catalogue system must be made known. This is done by means of an entry that looks like this:
37+
38+
```xml
39+
<catalogue title="PICA OPAC">
40+
<config address="kxp.k10plus.de" database="2.1"
41+
description="K10plus" iktlist="IKTLIST-GBV.xml" port="80"
42+
ucnf="UCNF=NFC&amp;XPNOFF=1" />
43+
</catalogue>
44+
```
45+
46+
The `title` attribute contains the name under which the catalog can be selected in the user interface, `address` the URL to the API endpoint and `database` the database to be used.
47+
48+
The content of a PICA record is mapped within the Goobi workflow ruleset used in each case. For more information on how to configure this mapping, see the UGH documentation here:
49+
50+
[https://docs.goobi.io/ugh-en/4/4.3/4.3.2](https://docs.goobi.io/ugh-en/4/4.3/4.3.2)

‎docs/screen1_de.png

961 KB
Loading

‎docs/screen1_en.png

952 KB
Loading

‎module-base/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.goobi.workflow.plugin</groupId>
55
<artifactId>plugin-opac-pica</artifactId>
6-
<version>24.06</version>
6+
<version>24.07</version>
77
</parent>
88
<artifactId>plugin-opac-pica-base</artifactId>
99
<packaging>jar</packaging>

‎pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.goobi.workflow</groupId>
55
<artifactId>workflow-base</artifactId>
6-
<version>24.06</version>
6+
<version>24.07</version>
77
<relativePath />
88
</parent>
99
<groupId>io.goobi.workflow.plugin</groupId>

0 commit comments

Comments
 (0)