KSH-API-Konfiguration – Datenmodell und Regeln

Überblick

Die Seite verwaltet Einstellungen externer Daten-APIs, vor allem der offenen KSH-Daten-API: Code, Name, Basis-URL, API-Schlüssel, eine erweiterte JSON-Einstellung und den Geltungsbereich (global, Unternehmensgruppe, Unternehmen). Die KSH-Aufrufe führt die Bibliothek ksh aus.

Datenmodell

Die Tabellennamen tragen in der Datenbank das installationseigene Präfix.

Bekannte Schlüssel von config_json: raw_datasets (zu ladende Rohdatensätze) und stat_indicators (Indikatoren des Statistikimports).

Ablauf

1. Formular-Standardwerte: Code ksh, Basis-URL des Datenportals des Amts. Beim Code ksh erscheint die KSH-Datensatzliste mit Kontrollkästchen; die angehakten landen in raw_datasets.
2. Beim Speichern wird config_json entitätsdekodiert und als gültiges JSON gespeichert; api_code ist Pflicht.
3. Der Geltungsbereich ergibt sich aus den Feldern Unternehmen und Unternehmensgruppe: company: plus ID, group: plus ID oder global.
4. Bei einem neuen Datensatz liefert die Antwort die neue ID, der nächste Speichervorgang ist damit eine Änderung.
5. Der Verbindungstest ruft mit der angegebenen Basis-URL die KSH-Datensatzliste ab und meldet die Anzahl oder den Fehler.

Die Verwender (Statistikimport, Datensatzabruf) lösen die Konfiguration in der Reihenfolge Unternehmen → Unternehmensgruppe → global auf und nutzen nur aktive Zeilen.

Berechtigungen

• Liste: list; Formular und Test: edit; Speichern: canSave() (add bei neuem, edit bei bestehendem Datensatz); auch die Hinzufügen-Schaltfläche erscheint mit dem Recht edit.
• Aktivieren, Deaktivieren: status; Löschen: delete, einzeln oder gesammelt.
• Die Auswahl der Unternehmensgruppe zeigt die Unternehmen gemäß Inhaltsbereich.

Bekannte Einschränkungen

• Das Löschen ist physisch, ohne Verweisprüfung.
• Der Schlüssel statusdelete steht im Rechtekatalog, ein Endpunkt dazu existiert jedoch nicht.