uninstall-Struktur anlegen

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des agorum core template managers. Aktualisieren Sie ggf. das hier beschriebene Plug-in, um die Dokumentation verwenden zu können.

Mit dieser Aktion im Kontextmenü legen Sie eine uninstall-Struktur an, mit deren Hilfe Sie Projekte deinstallieren.

Die Begrifflichkeiten Projekt und Plug-in meinen dasselbe und werden in dieser Dokumentation je nach Szenario verwendet.

Allgemeine Informationen zur Uninstall-Struktur

Ein bereits vorhandenes Projekt können Sie anfangs nicht deinstallieren. Damit Sie es deinstallieren können, legen Sie nachfolgend eine uninstall-Struktur in Ihrem Projekt an. Zu dieser Struktur gehören zwei Dateien und ein Unterordner:

Datei uninstall.yml im Unterordner yml des Projekts
Datei uninstall-description.html im Unterordner doc des Projekts
Unterordner uninstall im Projektordner

Der Unterordner uninstall enthält wiederum weitere Unterordner und Dateien, sodass sich folgende Struktur ergibt:

<Projektordner>
- uninstall
  - post
    - js
      - 010 uninstall-post.js
  - pre
    - js
      - 010 uninstall-pre.js

Die beiden JavaScript-Dateien 010 uninstall-post.js und 010 uninstall-pre.js sind Default-Skripte, die das System initial bei der Anlage erstellt und nur auskommentierten Code enthalten. Sie haben in diesen JavaScript-Dateien die Möglichkeit, ein JavaScript zu schreiben, sodass das System am Anfang (pre) und am Ende (post) bei der Deinstallation eines Plug-ins automatisch ausführt.

Angelegte uninstall-Struktur

Die uninstall-Struktur anlegen

Öffnen Sie links in der Seitenleiste Explorer.
Klicken Sie den Ordner des zu deinstallierenden Projekts mit der rechten Maustaste an.
Wählen Sie im Kontextmenü agorum core template manager > Uninstall-Struktur anlegen.

Ergebnis: Das System legt im Hintergrund automatisch die beiden Dateien uninstall.yml und uninstall-description.html in die Ordner post/js und pre/js an.

Hinweis: Möchten Sie in Ihrem Projekt mehrere Bereiche löschen, etwa einzeln mehrere Workflows, kopieren Sie die Datei uninstall.yml und fügen Sie die Datei in den gleichen Ordner ein. Benennen Sie die Datei danach etwa in uninstall-2.yml um. Für die Datei uninstall-description.html verfahren Sie auf die gleiche Art und Weise, etwa uninstall-2-description.html. Zu einer yml-Datei sollte es also immer auch eine passende HTML-Datei geben, sonst fehlt im agorum plugin manager später in der Bedienoberfläche die Beschreibung des zu deinstallierenden Plug-ins.

Zu deinstallierende Daten eines Projekts konfigurieren

Über die Datei uninstall.yml konfigurieren Sie, welche Daten eines Projekts das System deinstallieren soll. Diese Datei enthält bestimmte Keywords, die das System automatisch ausführt, wenn Sie das Projekt über die Bedienoberfläche deinstallieren. Die Keywords tragen Sie exakt so wie in der Datei export.yml ein.

Folgende Keywords existieren:

Keyword	Beschreibung
ac	Löscht einen Ordner. Beispiel - ac: /agorum/roi/customers/acbasicarchive
MetaDb	Löscht einen MetaDB-Eintrag. Beispiel - MetaDb: MAIN_MODULE_MANAGEMENT/home/control/Apps/[ acbasicarchive ]
DocForm Training	Löscht ein docform-Training. Sie können RegEx-Ausdrücke verwenden. Beispiel - DocForm Training: DOCFORM.*
Active Folder	Löscht einen Aktiven Ordner. Sie können RegEx-Ausdrücke verwenden. Beispiel - Active Folder: DocForm Template - .*
FileWorkflow	Löscht einen Fileworkflow. Sie können RegEx-Ausdrücke verwenden. Beispiel - FileWorkflow: DOCFORM.*
Smart assistant	Löscht eine agorum core smart assistant-Konfiguration. Beispiel - Smart assistant: agorum core basic archive
QueryScript	Löscht einen QueryWorker. Beispiel - QueryScript: acbasicarchive_centerInbox ACL
ScriptWorker	Löscht einen ScriptWorker. Beispiel - ScriptWorker: acbasicarchive_centerInbox public move
Package	Führt den Ordner pre oder post und die dort enthaltenen JavaScript-Dateien 010 uninstall-post.js oder 010 uninstall-pre.js aus. Beispiel - Package: /agorum/roi/customers/acbasicarchive/uninstall/pre
Workflow	Löscht einen deployten Workflow mit allen Versionen, die dieser besitzt. Beispiel - Workflow: /agorum/roi/customers/agorum.workflow/workflows/agorum.workflow.test1 Hinweis: Sie erhalten beim Deinstallieren zwar eine ZIP-Datei für alle gelöschten, deployten Workflows und können diese auch wieder herstellen; alle Workflow-Instanzen, die auf diese deployten Workflows gelaufen sind, sind jedoch nicht mehr funktionsfähig, weil diese auf die UUID des deployten Workflows zugreifen. Löschen Sie daher die deployten Workflows nur dann, wenn Sie die dazu erstellten Workflow-Instanzen nicht mehr benötigen.
UninstallSub	Übergibt eine weitere uninstall-Datei, die das System ausführen soll. Sie müssen den kompletten Pfad zur uninstall-Datei angeben. Durch die Position innerhalb der uninstall.yml können Sie entscheiden, wann das System diese weiteren uninstall-Dateien ausführen soll. Dadurch können Sie etwa uninstall-Dateien erstellen, die aufeinander aufbauen. Beispiel - UninstallSub: /agorum/roi/customers/acbasicarchive/yml/uninstall-2.yml Sie legen eine uninstall-Datei an, die einen bestimmten Bereich löscht. Sie legen eine weitere Datei an, die einen zweiten Bereich löscht, danach eine dritte Datei, die das gesamte Projekt löscht. Die erste Datei enthält die Löschbefehle für den Bereich, den Sie löschen möchten. Die zweite Datei ruft zuerst die erste auf, danach folgen die Löschbefehle für den zweiten Bereich. Die dritte Datei ruft zuerst die zweite Datei auf, die dann die erste aufruft. Dann folgen in der dritten Datei die Befehle, die das gesamte Projekt löschen.
verifyProjectDependencies	Prüft, ob das zu deinstallierende Projekt weitere abhängige Projekte hat. Beispiel - verifyProjectDependencies: acbasicarchive Wenn Sie wie hier im Beispiel acbasicarchive (agorum core basic archive) im Keyword angeben und dieses Projekt von anderen Projekten abhängig ist und sie es deinstallieren möchten, erscheint eine Fehlermeldung beim Deinstallieren. Im Log darunter finden Sie eine detailliertere Beschreibung des Fehlers: Hier ist das Projekt etwa vom Projekt acbasicarchiveDocForm (agorum core basic archive docform) abhängig. Deinstallieren Sie zuerst die hier aufgeführten Projekte, damit Sie das eigentliche Projekt deinstallieren können. Das Keyword funktioniert auch bei aktiviertem Testmodus.

Beispiel der Datei „uninstall.yml“

# Prüfen, ob es Abhängigkeiten anderer Projekte gibt
- verifyProjectDependencies: acbasicarchive

# Package pre
- Package: /agorum/roi/customers/acbasicarchive/uninstall/pre

- Smart assistant: agorum core basic archive

- Package: /agorum/roi/customers/acbasicarchive/deploy/pre

- QueryScript: acbasicarchive_centerInbox ACL
- QueryScript: acbasicarchive_centerInbox public move
- QueryScript: update-acbasicarchive-collection

- Active Folder: DocForm Template - .*

- FileWorkflow: DOCFORM.*

- DocForm Training: DOCFORM.*

- Workflow: /agorum/roi/customers/agorum.workflow/workflows/agorum.workflow.test1

# Home - Erweiterungen
- MetaDb: MAIN_MODULE_MANAGEMENT/home/control/Apps/[ acbasicarchive ]

# Weitere uninstall.yml übergeben
- UninstallSub: /agorum/roi/customers/acbasicarchive/yml/uninstall-2.yml

# Package post
- Package: /agorum/roi/customers/acbasicarchive/uninstall/post

# Projekt komplett deinstallieren
- ac: /agorum/roi/customers/acbasicarchive

Beschreibung der Deinstallation festlegen

Über die Datei uninstall-description.html legen Sie die Beschreibung der Deinstallation fest, die der Benutzer in der Bedienoberfläche lesen kann.

Der Benutzer sieht nach der Auswahl des gewünschten Plug-ins rechts diese Beschreibung, also was die Deinstallation des Plug-ins enthält.

Beschreibung des zu deinstallierenden Plug-ins (rechts)

Diesen Text können Sie in dem HTML-Dokument individuell anpassen, um klar zu benennen, was genau bei einer Deinstallation gelöscht wird.