added docs

Author: SteffenHankiewicz

docs/index_de.md

@@ -0,0 +1,51 @@
+---
+title: PICA Import
+identifier: intranda_opac_pica
+published: true
+description: OPAC Plugin für die Datenübernahme von PICA Datensätzen
+---
+## Einführung
+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.
+
+
+## Installation
+Das Plugin besteht aus einer Datei:
+
+```bash
+plugin_intranda_opac_pica-base.jar
+```
+
+Diese Datei muss für den Nutzer `tomcat` lesbar an folgendem Pfad installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/opac/plugin_intranda_opac_pica-base.jar
+```
+
+
+## Überblick und Funktionsweise
+Wenn in Goobi nach einem Identifier gesucht wird, wird im Hintergrund eine Anfrage an die konfigurierte URL gestellt.
+
+![Oberfläche von Goobi workflow zur Abfrage des Katalogs](screen1_de.png)
+
+Nach der Abfrage des eigentlichen Datensatzes aus dem PICA-Katalog erfolgt das Mapping der Metadaten gemäß der im Regelsatz konfigurieren Regeln.
+
+
+## Konfiguration
+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.
+
+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:
+
+```xml
+<catalogue title="PICA OPAC">
+  <config address="kxp.k10plus.de" database="2.1"
+    description="K10plus" iktlist="IKTLIST-GBV.xml" port="80"
+    ucnf="UCNF=NFC&amp;XPNOFF=1" />
+</catalogue>
+```
+
+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.
+
+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:
+
+[https://docs.goobi.io/ugh-de/4/4.3/4.3.2](https://docs.goobi.io/ugh-de/4/4.3/4.3.2)
+

docs/index_en.md

@@ -0,0 +1,50 @@
+---
+title: PICA Import
+identifier: intranda_opac_pica
+published: true
+description: OPAC Plugin for the data transfer of PICA data records
+---
+## Introduction
+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.
+
+
+## Installation
+The plugin consists of one file:
+
+```bash
+plugin_intranda_opac_pica-base.jar
+```
+
+This file must be installed readable for the user `tomcat` at the following path
+
+```bash
+/opt/digiverso/goobi/plugins/opac/plugin_intranda_opac_pica-base.jar
+```
+
+
+## Overview and functionality
+When you search for an identifier in Goobi, a request is sent to the configured URL in the background.
+
+![Goobi workflow interface for querying the catalogue](screen1_en.png)
+
+After retrieving the actual record from the PICA-catalog, the metadata is mapped according to the rules configured in the rule set.
+
+
+## Configuration
+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.
+
+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:
+
+```xml
+<catalogue title="PICA OPAC">
+  <config address="kxp.k10plus.de" database="2.1"
+    description="K10plus" iktlist="IKTLIST-GBV.xml" port="80"
+    ucnf="UCNF=NFC&amp;XPNOFF=1" />
+</catalogue>
+```
+
+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.
+
+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:
+
+[https://docs.goobi.io/ugh-en/4/4.3/4.3.2](https://docs.goobi.io/ugh-en/4/4.3/4.3.2)