Testing und Werkzeuge
API-Anfrage-Simulation
Testen sie Render-Requests, inkl. Workflow-Entscheidungen, Custom Mappings und Validierungen
Die API-Anfrage Simulation (oder auch Render-Anfrage-Simulation) ist ein Werkzeug mit dem Sie Entscheidungen des Verarbeitungs-Workflows nachvollziehen können: Nach einer Eingabe eines Requests sehen Sie die Zuordnung von modalen Vorlagen, die Auswertung von Custom Mappings, Validierungen, die Einbindung von Diagrammen und QR-Codes. Standardmäßig bleibt dies eine reine Workflow-Simulation; optional können Sie zusätzlich eine transiente Dokument- und E-Mail-Preview rendern. Webhooks werden dabei nie ausgeführt.
Hier können Sie z.B. die Routing-Regeln für Rechnungsläufe oder Mahnstufen testen, bevor Lasten in die Produktion gehen.
Im Prozess-Leitstand und in der Liste Rendering Requests sehen Sie reale Jobs.
Diese Simulation hilft dagegen, historische Requests, Entwürfe oder Test-Daten ohne Konsequenzen für die Produktion durchzuspielen. Auch die optionale Preview verändert keinen produktiven Request-Status und löst keinen Versand aus.
Grundlagen zu Rendering Requests und Feldern wie externer ID oder Vorlage-Identifier finden Sie unter Rendering Requests.
Für Veränderungen von Request-Daten vor dem Rendering werden Custom Mappings genutzt.
Gespeicherte Eingaben für Tests laden Sie aus dem Bereich Testdaten.
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
Request-Auswahl oder Entwurf
Zuerst legen Sie fest, welcher Request simuliert wird: entweder laden Sie einen bestehenden Datensatz per numerischer Rendering Request ID (Request laden), oder Sie bearbeiten die Felder des Entwurfs manuell und starten mit Simulieren.
Quell-Request und Entwurf
Laden Sie einen bestehenden Rendering Request oder bearbeiten Sie direkt einen Entwurf. Vorlagen werden nur gerendert, wenn die Dokument- und E-Mail-Preview aktiviert ist.
[
{
"key": "value",
"items": [1, 2, 3]
},
{
"nested": {
"property": "value"
}
}
]Verwenden Sie den "Testdaten laden" Button, um schnell gespeicherte Testdaten aus dem Testdaten-Bereich zu laden.
Dokument- und E-Mail-Preview
Der Schalter Dokument- und E-Mail-Preview startet statt der reinen Simulation einen Preview-Lauf. Die Preview nutzt den aktuell geladenen Request und Ihre Entwurfsänderungen, rendert Dokumente und E-Mail-Inhalte aber nur transient:
- Es wird kein produktiver Request-Status verändert.
- Es werden keine finalen Dokument-, E-Mail- oder Workflow-Prozesse angelegt.
- Es findet kein Versand statt.
- Webhooks werden weiterhin nur als Entscheidungspfad angezeigt und nicht ausgeführt.
Nach einem erfolgreichen Lauf öffnet sich die Request-Preview automatisch. Dort sehen Sie die Workflow-Zusammenfassung, die zugewiesenen Dokument- und E-Mail-Templates, Webhook-Entscheidungen und die ausgeführten Validierungen inklusive Fehlergründen. PDF-, HTML- und TXT-Artefakte werden inline angezeigt; DOC-, ODT- und RTF-Artefakte werden als Download aus der Preview bereitgestellt.
Request-Preview
Workflow-Summary, Zuordnungen, Validierungen, Dokumente und E-Mails aus dem transienten Preview-Lauf.
Zuordnungen und Prüfungen
Rechnung_Strom.pdf
E-Mail-Preview
Über Vollbild öffnen können Sie Dokument- und E-Mail-Previews im gesamten Browser-Viewport prüfen. Das ist besonders hilfreich bei langen PDFs, umfangreichen HTML-E-Mails oder TXT-Ausgaben. Die Vollbildansicht lässt sich über Schließen oder Esc beenden.
Technisch nutzt die Preview den SPA-Pfad /api/spa/rendering-request-simulation/preview. Der Payload bleibt nah an der normalen Simulation: requestId, optionaler draft, executeCustomMappings und locale.
Render-Daten
Ergänzend zum oberen Formularbereich steuern Sie hier die Nutzlast für die Simulation. Sie können Test-Datensätze einspielen oder den vollständigen Render-Request als JSON pflegen.
Das JSON unter Render-Daten ist die Eingabe, gegen die Bedingungen (z. B. in Validierungen oder Zuordnungen) ausgewertet werden. Es entspricht dem Payload-Teil Ihrer API-Anfrage bzw. dem, was nach Custom Mapping als Datengrundlage dient.
Sie können Test-Datensätze einspielen oder den vollständigen Render-Request als JSON pflegen.
[
{
"key": "value",
"items": [1, 2, 3]
},
{
"nested": {
"property": "value"
}
}
]Strukturiertes JSON-Objekt mit Geschäftsdaten (z. B. Vertrag, Rechnung, Zählerstände). Wird für die Simulation als Datenbasis verwendet.
Metadaten
Metadaten umfassen Request-Metadaten sowie Informationen für Review- und Validator-Logik. Sie ergänzen die Render-Daten und fließen in Entscheidungen ein, die nicht nur aus dem reinen Event-Objekt folgen.
[
{
"key": "value",
"items": [1, 2, 3]
},
{
"nested": {
"property": "value"
}
}
]JSON-Objekt für Request-Metadaten, Referenzen und Kontext für Reviews bzw. Validatoren.
In der SPA stehen Render-Daten und Metadaten auf breiten Viewports nebeneinander in JSON-Editoren mit fester Höhe; die Höhe lässt sich per Ziehpunkt anpassen (wie im Diagramm-Editor).
Simulationsergebnis
Solange Sie noch keine Simulation gestartet haben, zeigt der Bereich einen Leerzustand. Nach Simulieren füllt sich dieser Abschnitt mit der schrittweisen Auswertung (Mappings, Zuordnungen, Validierungen, QR-/Diagramm-Entscheidungen, Webhook-Pfade).
Es wurde noch keine Simulation ausgeführt.
Laden Sie einen Request oder bearbeiten Sie den Entwurf oben und starten Sie dann die Simulation, um Mappings, Vorlagen-Zuordnung, Validierungen, Diagramme, QR-Codes und Webhook-Entscheidungen zu prüfen.