Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- adm:config:base:scripts [2025/11/18 12:37] – angelegt agoldman
+++ adm:config:base:scripts [2026/03/09 09:39] (aktuell) – nullrich
@@ Zeile 1: / Zeile 1: @@
-====== Scripte ======
+====== 🧾 CAATS Skripte ======
+> **Zielgruppe:** Administrator:innen, technische Systemverantwortliche
+> **Modul:** ADM Konfiguration → Basis
+<WRAP lo>
+**Schlagworte:** skripte, systembefehle,
+datenkorrektur, wartung, migration,
+automatisierung, systempflege,
+importpaket, zip-import, manifest,
+workflows, assessments, caats
+</WRAP>
+===== 🧭 Überblick =====
+Der Bereich **„CAATS Skripte“** ermöglicht das Ausführen
+technischer Systembefehle direkt innerhalb der CAATS-Instanz.
+Skripte greifen unmittelbar auf den Datenbestand zu
+und führen vordefinierte Operationen automatisiert aus.
+Typische Anwendungsfälle:
+  * Datenbereinigungen
+  * technische Migrationen
+  * Systemupdates
+  * Wartungsaufgaben
+  * Massenkorrekturen
+  * strukturierte Datenanpassungen
+----
+===== 📦 Import von Systempaketen =====
+Neben einzelnen Skripten unterstützt CAATS auch den **Import strukturierter ZIP-Pakete**.
+Diese werden häufig verwendet, um **Workflows, Assessments, Aggregationen oder Systemkonfigurationen** zu installieren oder zu aktualisieren.
+Damit ein ZIP-Archiv als Importpaket erkannt wird, muss es eine **Manifestdatei** enthalten.
+==== Aufbau eines Importpakets ====
+Ein gültiges CAATS-Importpaket besteht aus:
+  * einer **info.json** Datei (Manifest)
+  * optionalen **CAATS-Skriptdateien (.caats)**
+  * **Begleitdateien** für Konfiguration oder Darstellung
+<WRAP info>
+Die Datei **info.json** beschreibt Inhalt und Version des Pakets
+und dient dem System als Identifikation für den Import.
+</WRAP>
+----
+===== 📂 Typische Inhalte eines Import-ZIP =====
+Ein Importpaket kann verschiedene Dateitypen enthalten:
+| Datei | Zweck |
+|------|------|
+| **.caats** | technische Skripte zur Daten- oder Systemlogik |
+| **HTML** | Layout oder Dokumentvorlagen |
+| **.xlsx** | Definitionen für Formulare oder Prozesse |
+| **Ressourcendateien** | zusätzliche Inhalte für Workflows |
+Typische Excel-basierte Definitionen sind:
+  * **chkdef** → Assessment-Definitionen
+  * **flowdef** → Workflow-Definitionen
+  * **pageaggregation** → gespeicherte Seitenabfragen / UI-Strukturen
+<WRAP tip>
+Ein häufiges Beispiel für ein ZIP-Importpaket sind **Workflow-Pakete**,
+die Workflowdefinitionen, Formulare, Skripte und Vorlagen gemeinsam enthalten.
+</WRAP>
+----
+===== 📊 Besonderheit: Excel-Import für Assessments =====
+Assessmentdefinitionen (**chkdef**) können zusätzlich auch **direkt über den Menüpunkt „Excel importieren“** eingespielt werden.
+In diesem Fall ist **kein ZIP-Paket mit info.json erforderlich**.
+Vorteile dieser Methode:
+  * schneller Import einzelner Assessments
+  * praktische Bearbeitung von Formularstrukturen
+  * häufige Anpassungen ohne vollständiges Paket
+<WRAP info>
+Diese Importmethode wird besonders häufig verwendet,
+wenn nur **Formulare oder Formularfelder erweitert oder angepasst werden sollen**.
+</WRAP>
+----
+===== ⚙️ Funktionsweise von Skripten =====
+Skripte werden:
+  * vom Systemanbieter bereitgestellt
+  * versionsabhängig verwaltet
+  * einmalig oder wiederkehrend ausgeführt
+Je nach Skript können folgende Aktionen erfolgen:
+  * Aktualisierung von Datensätzen
+  * Neuberechnung von Vorpositionen
+  * Strukturkorrekturen
+  * Lösch- oder Archivierungsoperationen
+  * technische Reparaturen
+<WRAP warning>
+Die Ausführung erfolgt direkt im produktiven Datenbestand.
+</WRAP>
+----
+===== 🔐 Berechtigungen =====
+Nur Benutzer:innen mit entsprechenden Administratorrechten
+dürfen Skripte ausführen oder Importpakete einspielen.
+Empfohlen:
+  * Durchführung außerhalb von Spitzenzeiten
+  * Dokumentation jeder Skriptausführung
+  * Mandantenexport vor größeren Eingriffen
+<WRAP important>
+⚠️ Skripte und Importpakete können nicht automatisch rückgängig gemacht werden.
+</WRAP>
+----
+===== ⭐ Best Practices =====
+<WRAP tip>
+✔ Vor Ausführung genaue Beschreibung lesen
+✔ Auswirkungen auf Geschäftsfälle prüfen
+✔ Testumgebung nutzen, wenn verfügbar
+✔ Nachlaufkontrolle durchführen (z. B. Reporting, Stichproben)
+✔ Änderungen intern dokumentieren
+</WRAP>
+----
+<WRAP center round box 75%>
+**❓ Was passiert, wenn …? (CAATS Skripte & Importpakete)**
+^ Situation ^ Ursache ^ Maßnahme ^
+| ❌ ZIP wird nicht erkannt | info.json fehlt | Paketstruktur prüfen |
+| ⚠️ Import schlägt fehl | inkompatible Version | Paketversion prüfen |
+| 🔄 Daten unerwartet geändert | Skriptwirkung falsch interpretiert | Beschreibung prüfen |
+| 📊 Reporting abweichend | Massenkorrektur durchgeführt | Reports neu prüfen |
+| 🚫 Skript nicht sichtbar | Keine Berechtigung | Rollen prüfen |
+| ⏳ System langsam | Skript läuft im Hintergrund | Jobstatus prüfen |
+</WRAP>
+----
+===== 📘 Zusammenfassung =====
+CAATS Skripte und Importpakete sind zentrale Werkzeuge
+für technische Anpassungen der Plattform.
+Sie ermöglichen:
+  * strukturierte Systemmigrationen
+  * Installation komplexer Workflows
+  * Import von Formularen und Konfigurationen
+  * automatisierte Datenanpassungen
+Ihre Anwendung erfordert jedoch:
+  * Fachkenntnis
+  * sorgfältige Planung
+  * Dokumentation
+  * kontrollierte Durchführung