„custom-commands“ hinzufügen

custom-commands.md

@@ -0,0 +1,62 @@
+# Commands
+Konova bietet verschiedene Kommandos, die von der CLI aufgerufen werden können und insbesondere administrative Hilfestellungen geben. 
+Alle Kommandos werden nach dem üblichen Schema 
+```shell
+python manage.py COMMAND_XY PARAMETER_1 PARAMETER_2
+```
+aufgerufen. Vgl. https://docs.djangoproject.com/en/5.0/howto/custom-management-commands/ für mehr Infos.
+
+## generate_report
+Parameter
+* `--from`: Startdatum (ISO Format)
+* `--to`: Enddatum (ISO Format)
+* `--for`: Liste von ETS short names (vgl. zug. Codeliste)
+
+Mit diesem Kommando kann in einem bestimmten Zeitraum für eine beliebige Anzahl Eintragungsstellen (ETS) der Bericht erstellt werden. Die Berichte werden gezippt und an die in `ADMINS` hinterlegten Mailadressen per Mail verschickt.
+
+## handle_resubmissions
+Parameter
+* keine
+
+Iteriert über sämtliche Wiedervorlagen, die bis zum heutigen Tag hätten verarbeitet sein sollen. Schickt entsprechende Mails mit Wiedervorlageinhalten an die jeweiligen Nutzer und löscht die zugehörige Wiedervorlage. Kann mittels cronjobs automatisiert werden.
+
+## quality_check
+Parameter
+* `--identifier-like`: SQL-like ähnliche Angabe eines Bruchteils der Kennung. Vergleichbar mit `%[KENNUNG]%` in SQL Syntax
+* `--title-like`: SQL-like ähnliche Angabe eines Bruchteils des Titels.
+
+Iteriert über sämtliche gefundenen Einträge, unabhängig des Objekttyps (EIV, KOM, EMA, OEK), und führt den zugehörigen Qualitätscheck durch. Resultate werden im Terminal angezeigt.
+
+## sanitize_db
+Parameter
+* keine
+
+Erkennt verwaiste Einträge ohne Zugehörigkeit und entfernt diese. Analysiert
+* UserActionLogEntry
+* CompensationState
+* CompensationAction
+* Deadline
+* Geometry
+* Parcels
+* Districts
+* Municipal
+* ParcelGroup
+
+## send_to_egon
+Parameter
+* `--intervention-ids`: Komma separierte Liste der IDs (nicht Kennungen!) von Eingriffen, die an EGON übertragen werden sollen
+
+Überträgt Eingriffe an EGON. Kann genutzt werden, um Kommunikationsausfälle nachträglich zu korrigieren.
+
+## setup
+Parameter
+* keine
+
+Input geführtes initiales Setup Kommando. Wird zum erstmaligen Aufsetzen aller relevanten Konfigurationen und Laden grundlegender Daten genutzt. Legt auf Wunsch Superuser an.
+
+## update_all_parcels
+Parameter
+* keine
+
+Berechnet sämtliche Flurstücke vorhandener Geometrien erneut. Geometrien werden nach Größe sortiert, sodass kleinere Geometrien zuerst und große zuletzt bearbeitet werden. 
+Ist für gewöhnlich nicht notwendig auszuführen, da jedes Speichern der allgemeinen Daten (und Geometrie) eines Eintrags eine Neuberechnung anstößt.