Zum Inhalt

KCForms — Handbuch

Handbuch der Kehrmann Consulting AB

Diese Doku begleitet KCForms — eine Plattform zum Definieren, Ausfüllen, Drucken und Auswerten von Formularen.

KCForms besteht aus

  • einem Spring-Boot-Backend (Java 21, GraalVM-Skripting, PDF-Druck mit PDFBox) auf wahlweise MySQL, PostgreSQL, Oracle oder SQL Server,
  • einem React/TypeScript-Frontend (Vite, Tailwind) zum Ausfüllen und Auswerten,
  • dem Formular-Editor, in dem Formulare ohne neues Deployment entstehen, und
  • serverseitigen JavaScript-Hooks mit Zugriff auf Datenbank, Dateisystem, Mail, PDF, LDAP, HTTP/SOAP und mehr.

Für wen ist diese Doku?

Drei Rollen arbeiten mit dem System. Jede hat „ihren" Pfad durch das Handbuch:

Du betreibst KCForms — kümmerst dich um Updates, Datenbank, Mail-Konfiguration, Anmeldung und Benutzerrechte.

Empfohlener Lesepfad:

  1. Architektur-Überblick
  2. Installation mit Docker bzw. Installation auf Tomcat
  3. System-Administration im Überblick
  4. Anmeldung

Du baust und pflegst Formulare im Formular-Editor. Dich interessieren Layout, Datenquellen, Detail-Tabellen, Regeln und der Druck.

Empfohlener Lesepfad:

  1. Grundlagen und Baukasten
  2. Detail-Tabellen — Klick-Tutorial
  3. Sichtbarkeit & Bedingungen
  4. Druck (PDF)

Du schreibst die Skripte, die Formulare zum Leben erwecken — onLoad, onFieldChange, onValidate, onSubmit und weitere Hooks, dazu Jobs und eigene REST-Services.

Empfohlener Lesepfad:

  1. JavaScript-Grundlagen und JSON und Objekte verstehen — die Grundlage, falls Programmieren neu für dich ist
  2. Scripting-Überblick — Hooks, Host-Objekte, Sandbox
  3. Lifecycle-Hooks
  4. Der ctx-Kontext
  5. Grundlagen der Formular-Definition — was steht im Schema, worauf greift dein Skript zu?

Wegweiser durch dieses Handbuch

Die linke Navigation gliedert sich in vier Bereiche:

  • Einstieg — Was ist KCForms? Wie startet und installiert man es?
  • Formulare — Formular-Editor, Schema und kc:*-Erweiterungen, Datenquellen, Regeln, Druck, Workflow, Mehrsprachigkeit, Import
  • Scripting — Hooks, Host-Objekte, Integrationen, Beispiele
  • Admin — alle Bereiche der Verwaltung: Benutzer und Anmeldung, Schnittstellen, Betrieb

Konventionen in dieser Doku

Schreibweise Bedeutung
monospace Pfade, Code, Bezeichner aus dem Code
kc:* KCForms-Erweiterungen im JSON-Schema
System-Administration → Gruppe → Eintrag Klickpfad über das Zahnrad oben rechts
!!! note Hintergrund und Designentscheidungen
!!! warning Stolperfallen
„Stand vom 05.10.2026“ gilt ab der Version mit diesem Datum — das Datum steht im Paketnamen, z. B. kcforms-docker-0.1.0-20261105
▸ Hinter den Kulissen Aufklappbarer Kasten mit dem JSON, das der Formular-Editor schreibt

Zu den Kästen „Hinter den Kulissen“

Formulare bestehen aus Feldern, die KCForms in einer Textdatei beschreibt — dem Schema. Der Formular-Editor schreibt diese Datei für dich; anfassen musst du sie nicht. Trotzdem zeigt das Handbuch an vielen Stellen, was dort landet, weil es drei Dinge leichter macht: ein Formular mitnehmen (Export in ein anderes System), nachsehen, warum eine Regel nicht greift, und einem Kollegen genau sagen, wie etwas eingestellt ist.

Diese Ausschnitte stehen in zugeklappten Kästen. Sie überspringen zu können, ohne den Faden zu verlieren, ist Teil des Aufbaus: Jede Seite ist so geschrieben, dass sie vollständig zu verstehen ist, wenn du keinen einzigen davon aufklappst.