PicApport Add-on Installation Guide

Hier finden sie alle nötigen Informationen zur Installation der Add-ons auf einem PicApport-Server.

Eine Übersicht aller verfügbaren Add-ons mit dem jeweiligen Download-Link findet sich hier: PicApport Add-on Guide

Installation mit dem Windows Installer

Einfach die gewünschten Add-ons im Installer auswählen, Server starten, fertig.

Ob ein Add-on über den Windows-Installer verfügbar ist, ist jeweils bei den Add-ons dokumentiert.

Manuelle Installation (alle Betriebssysteme)

  • Alle für die Installation notwendigen Dateien sind jeweils als ZIP-Datei verfügbar und werden in das .picapport/groovy Verzeichnis kopiert.
  • Bei jedem Start des PicApport Servers wird dieses Verzeichnis nach neuen Add-on Dateien durchsucht und neue Add-ons werden automatisch installiert.
    Für jedes Add-on wird ein eigenes Verzeichnis angelegt und die Installationsdatei wird von PicApport dort ausgepackt und gesichert.
  • Nach erfolgreicher Installation der Add-ons werden die .zip ZIP-Dateien in das erstellte Add-on Verzeichnis kopiert, so dass im Groovy-Verzeichnis immer nur das aktuelle apache-groovy-binary-v.v.v.zip erhalten bleibt.
  • Wird zum ersten Mal ein Add-on installiert muss einmalig auch eine Groovy-Laufzeit-Umgebung installiert werden. Anders als bei den Add-ons bleibt die entsprechende ZIP-Datei für die Groovy-Laufzeit-Umgebung immer im .picapport/groovy Verzeichnis stehen.
    Beispiel: apache-groovy-binary-3.0.5.zip (nach erfolgreicher Installation wird zusätzlich ein verstecktes Verzeichnis groovy-3.0.5 erzeugt)
    (Warnung) Nur wenn eine apache-groovy-binary-x.x.x.zip verfügbar ist wird das Add-on Subsystem in PicApport aktiviert.
  • In der Datei .picapport/groovy/logfiles/currentConfiguration.log kann nach dem Serverstart die erfolgreiche Installation der Add-ons überprüft werden.
    Die Logdatei ist auch über die PicApport Web-Gui Serververwaltung->Logdateien->groovyaddons/currentConfiguration.log einsehbar.

    Beispiel einer Logdatei nach erfolgreicher Installation Quelle erweitern
  • (Warnung) Kurz zusammengefasst:
    Server beenden, ZIP-Datei(en) ins Groovy-Verzeichnis kopieren, Server starten, fertig (Zwinkern)

Namenskonventionen und Versionen

Groovy Laufzeitumgebung

  • apache-groovy-binary-v.v.v.zip
    Die jeweils aktuelle Laufzeitumgebung gibt es auf der PicApport Add-on Downloadseite oder auf https://groovy.apache.org/download.html
  • PicApport Version 9.x benötigt eine Groovy – Laufzeitumgebung ab Version 3.0.x (Stand September 2020: apache-groovy-binary-3.0.5.zip)

Add-on-Dateien

Die Namen der Add-on-Installationsdateien sind wie folgt aufgebaut:

typNameVersion.zip

  • typ
    • pagc (Crawlerfilter)
    • pagf (Felderweiterung)
    • pagp (Prozedur)
  • Name
    Name des Addons (wird auch für den Verzeichnisnamen verwendet, welches bei der Installation des Add-ons generiert wird).
  • Bindestrich
    Dieser trennt Name von Version
  • Version
    immer in der Form x.x.x
  • .zip

Besonderheiten

Wurde beim Serverstart bereits eine Groovy Runtime installiert, können bestimmte Add-ons auch im laufenden Betrieb des Servers installiert bzw. aktualisiert werden.

Hierzu ist folgender Konsolenbefehl auf dem PicApport-Server einzugeben: reloadaddons

Die Ausnahme sind Add-ons, die neue Datenbankfelder hinzufügen. Diese müssen bei beendetem Server installiert werden. (Eine Aktualisierung, wenn keine neuen Datenbank-Felder dazukommen ist auch im laufenden Betrieb möglich)

Siehe hierzu auch die Entwicklerdoku.

Wenn man sich nicht sicher ist: Vor dem Installieren von Add-ons den Server beenden.