Vorbehandlung
Validierung
Konfigurieren Sie Validierungsregeln für Vorlagen
Die Datenvalidatoren prüfen Eingaben auf Vollständigkeit, Plausibilität und Richtigkeit, um Fehler in Dokumenten und Prozessen vor Erstellung frühzeitig zu erkennen und zu vermeiden.
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
Springe zu:
Datenvalidatoren-Liste
Die Übersicht zeigt alle konfigurierten Datenvalidatoren mit ihren Metadaten, Fehlermeldungen und Aktivierungsinformationen.
ID, Identifier, Beschreibung, Aktiv ab
| ID | Identifier | Gruppen-Identifier | Aktiv ab | Aktiv | Beschreibung |
|---|---|---|---|---|---|
| identifier_name | Null | Aktiv |
ID
Eindeutige Nummer zur internen Identifikation des Datenvalidators.
Identifier
Eindeutiger Name des Datenvalidators für Rendering und API-Aufrufe.
Eindeutiger Name für eine optionale Gruppierung von verwandten Datenvalidatorn. Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Aktiv ab
Startdatum eines Datenvalidators. Datenvalidators werden erst ab diesem Datum beim Rendern beachtet.
Aktiv
Schnellübersicht, ob das Datenvalidator derzeit freigegeben ist. Deaktivierte Elemente behalten ihre Historie, werden aber nicht mehr automatisch verwendet.
Beschreibung
Beschreibung zur schnellen Einordnung im Backend. Unterstützt frei formulierte, redaktionelle Hinweise zur Funktion oder zum Einsatzzweck des/r Datenvalidators.
Identifier / Details
Je nach App-Version wird die Spalte als "Identifier" oder "Details" bezeichnet. Technisch handelt es sich um den eindeutigen Identifier des Datenvalidators.
Fehlermeldung
Die Fehlermeldung wird bei fehlgeschlagenen Validierungen in Webhooks für ungültige Prozesse und API-Callbacks verwendet. Sie sollte technisch und maschinenlesbar formuliert sein (z.B. customerDataError_missingRequiredFields). Optional kann Output.Rocks Template-Syntax enthalten sein (z.B. <<kunde.id>>), um dynamische Werte einzubinden.
Aktiv, Erstellt am, Aktualisiert am
| Validatoren | Pausiert | Aktiv | Erstellt am | Aktualisiert am |
|---|---|---|---|---|
| Null | NO | Ja | ||
| missing_street | YES | Nein |
Zugewiesene Validierungsregeln für das Datenvalidator. Prüfen Ihre Bedingungen vor der Verarbeitung und aktivieren/deaktivieren das Rendering entsprechend.
Temporäre Deaktivierung des Datenvalidators. Pausierte Elemente werden nicht verarbeitet.
Aktivierungsstatus des Datenvalidators. Nur aktive Elemente werden beim Rendern berücksichtigt.
Erstellt am
Zeitstempel der Datenvalidator-Erstellung.
Aktualisiert am
Zeitstempel der letzten Änderung. Zeigt wann Datenvalidator-Konfiguration zuletzt bearbeitet wurde.
Mandant, Standard für Umgebungs-Mandanten
| Umgebungs-Mandant | Standard für Umgebungs-Mandanten | Benutzerdefinierte ID | Farbe |
|---|---|---|---|
| (1880) Submarke 1 | NO | Null | |
| Null | YES | <<payload.value>> |
Zugeordneter Mandant des/der Datenvalidator. Ermöglicht Mandanten-spezifische Konfiguration.
Kennzeichnet Datenvalidator als Standard und vererbt (verfügbar) für alle Umgebungs-Mandanten.
Optionale benutzerdefinierte Kennung nach dem Rendering für externe Systeme. Wird als Referenzen des/der Datenvalidator bei Callbacks übergeben und beherrscht Vorlagen-Syntax inkl. Zugriff auf Payload-Daten.
Visuelle Kennzeichnung für schnelle Identifikation des/der Datenvalidator. Vor allem nützlich für Dashboard-Statistiken und Charts.
Kontext-Aktionen
Aktions-Dropdown
Aktions-Dropdown
Klicken Sie auf das Drei-Punkte-Menü am Ende jeder Zeile für Aktionen mit dem jeweiligen Datenvalidator.
Anzeigen
Öffnet eine reine Detailansicht der kompletten Meta-Informationen und Einstellungen des Datenvalidator.
Ändern
Öffnet das Bearbeitungsformular für alle Einstellungen und den Upload einer neuen Datenvalidator-Version.
Löschen
Entfernt das Datenvalidator dauerhaft aus dem System. Diese Aktion kann nicht rückgängig gemacht werden.
Spalten konfigurieren
Passen Sie die Anzeige der Datenvalidator-Liste für bessere Übersichtlichkeit an. Spalten können per Drag-and-Drop neu angeordnet und über Checkboxen ein-/ausgeblendet werden.
Für mich anwenden : Spalten-Konfiguration wird nur für Ihren Account gespeichert und beeinflusst andere Benutzer nicht.
Als Standard anwenden : Konfiguration wird für alle Benutzer der Instanz übernommen und als neue Standard-Ansicht gesetzt.
DataValidator erstellen
Aktions-Buttons zum Speichern und Verwalten der DataValidator-Konfiguration.
Verwenden Sie "Erstellen und weiteres Element hinzufügen" für effizientes Batch-Erstellen mehrerer Elemente.
Das Erstellungsformular ist in vier Tabs unterteilt: Details für Metadaten (Details/Identifier, Beschreibung, Fehlermeldung, Aktiv ab, Aktiv), Datenvalidierung für die Validierungsbedingung mit invertierter Logik-Option und Test-Funktion, Vorlagen für die Zuordnung zu Dokument-Vorlagen sowie E-Mail Vorlagen für die Zuordnung zu E-Mail-Vorlagen.
Eindeutige Kennung für diesen Datenvalidator zur programmatischen Verwendung, Logging und Template-Referenzen. Verwenden Sie snake_case wie kundendaten_vollstaendig.
Interne Beschreibung eines/r Datenvalidator für Identifikation und bessere Übersicht bzw. Dokumentation. Diese Beschreibung wird im Output.Rocks-Backend verwendet und nicht im Output angezeigt.
Beschreibungen sollten kurz und prägnant sein, um Übersichtlichkeit zu gewährleisten. Längere Erklärungen sollten im Feld 'Kommentar' platziert werden.
Technische, maschinenlesbare Fehlermeldung, die auch im Dashboard angezeigt wird. Für Logs, Webhooks und API-Callbacks sollte sie dem Schema 'kindOfDataError_errorDescription' folgen.
kindOfDataError_errorDescriptionStartdatum des Datenvalidators. Datenvalidatore werden erst ab diesem Datum beim Rendern beachtet.
Die Aktiv-Checkbox ermöglicht eine sofortige De-/Aktivierung unabhängig vom Datum.
Vor-Terminierung: Mit diesem Feld können Datenvalidatore vor-terminiert werden. Setzen Sie ein zukünftiges Datum, um das Element automatisch ab diesem Zeitpunkt zu aktivieren.
Mehrere Elemente mit gleichem Identifier: unterschiedliches 'Aktiv ab' staffelt die Version; bei einer Anfrage gilt das aktive Element mit dem spätesten Aktiv ab (nicht Erstell- oder Änderungsdatum).
Zuordnung zu einem spezifischen Umgebungs-Mandanten oder Standard-Verwendung für alle Mandanten.
Markiert Element als Standard-Element, das automatisch an alle Umgebungs-Mandanten vererbt wird.
Fehlermeldung: Die Kombination "Standard für Umgebungs-Mandanten" + ausgewählter "Umgebungs-Mandant" erzeugt die Fehlermeldung: Tenant defaults can not be set on tenant assigned entities. Ein Element kann entweder für einen spezifischen Mandant ODER als Standard für alle Umgebungs-Mandanten konfiguriert werden.
Datenvalidierung-Integration und Workflow
Testen Sie neue Validatoren immer mit der Test-Funktion in der Datenvalidierung-Tab, bevor Sie sie produktiv einsetzen. Validatoren blockieren ungültige Prozesse und sollten daher sorgfältig konfiguriert werden.
Ungültige Prozesse können nicht normal gerendert werden. Im Prozess-Leitstand können Sie auftretende Nicht-Validierungen erkennen und einsehen.
Datenvalidatoren werden in Output.Rocks zur Qualitätssicherung von Rendering-Daten verwendet und mit anderen Funktionen kombiniert. Die korrekte Integration ist entscheidend für einen zuverlässigen Dokumentenerstellungs-Workflow.
Wichtige Hinweise zur Validierung
- Daten-Validatoren laufen nach Prerender-Webhooks, aber vor Component-Rendering
- Komponenten sind in diesem Schritt also noch nicht verfügbar
- Mehrere Validatoren pro Template sind möglich (alle müssen dann erfüllt sein für eine Rendering)
- Fehlgeschlagene Validatoren werden als
failedDataValidatorsgespeichert und im Prozess-Leitstand angezeigt - Solche Invalid-Prozesse können dort erzwungen werden (force) oder revalidiert werden (revalidate)
- Throwable → AppException mit Validator-Info
- UnexpectedResultException → Log-Message, Validator wird übersprungen
Verwandte Backend-Bereiche
- Vorlagen: Validatoren werden Vorlagen zugeordnet und validieren Daten vor dem Rendering
- E-Mail-Vorlagen: Validatoren können auch E-Mail-Vorlagen zugeordnet werden
- Datenmapping-Regeln: Bedingungen folgen derselben Syntax wie Custom Mappings
- Prozess-Leitstand: Ungültige Prozesse werden im Prozess-Leitstand angezeigt und können dort verwaltet werden
Validierungs-Funktionen
- Expression Language: Bedingungen verwenden Symfony Expression Language mit verfügbaren Variablen
data,metadata,request,standard - Bedingte Syntax: Detaillierte Erklärung der Expression Language in Output.Rocks
- Output.Rocks Template-Syntax: Fehlermeldungen können Output.Rocks Template-Syntax enthalten
Use Cases
- Validierungen: Detaillierte Einführung in die Validierungs-Funktionalität
- Module und Validierungen: Übersicht über modulare Elemente und deren Integration