# Workflows testen und dokumentieren ## Workflows testen ### Testing * Customizings müssen immer vor Livegang getestet werden. Dies ist insbesondere bei Shops, die noch nicht Live sind, manchmal schwierig, aber zwingend notwendig * Es sollte in der Dokumentation festgehalten werden, wie das Customizing getestet werden kann **Tipp:** Um Sales Order Importe im Xentral-Projekt zu testen kann man im Standardprozess “Sales Order Single” zwei Komponenten auskommentieren: Die überprüfende Xentral-Komponente, die nach einer bestehenden Sales Order im Xentral sucht und die schreibende Xentral-Komponente, die die Sales Order zu Xentral schreibt. So vorbereitet kann der Prozess problemlos manuell ausgeführt und damit eventuelle Customizings getestet werden. ### Typische Fehlerquellen **Variablen aus Versehen überschreiben** * In Customizings nur Variablen überschreiben, die auch überschrieben werden sollen. * Dafür insbesondere auf die Benennung der Variablen achten. * Um ungewolltes Überschreiben zu verhindern bietet es sich an, alle Variablen mit einem Prefix zu beginnen, z.B CUSTOM, das verhindert Konflikte mit Variablen in Elternprozessen **Queue nicht aktiv** * Workflow muss einer Queue zugeordnet sein * Die jeweilige Queue muss aktiv sein * Bitte unbedingt beachten, dies kann auch zu einem Fehler im Elternprozess führen **Workflow nicht aktiv** * Damit ein Workflow ausgeführt werden kann, muss dieser aktiv sein * Im Gegensatz zur nicht aktiven Queue ist ein nicht aktiver Workflow aber unproblematisch für den Elternprozess **Falsches Projekt ausgewählt im Trigger** * Der Verwendete Hook-Trigger muss das korrekte Projekt identifizieren. Teilweise sind gleichnamige Hooks in unterschiedlichen Projekten aktiv (z.B. Shopify und Xentral) und liefern dann auch unterschiedliche Payloads **0-Werte und andere Ausnahmen werden nicht abgefangen** * Leere Variablen dürfen nicht zu Fehler führen * Unerwartete Werte dürfen nicht zu Fehlern führen * Es sollte wenn möglich immer ein sinnvoller Defaultwert definiert werde **Fehler aktiv abfangen** * Wenn möglich Fehler aktiv abfangen, so dass im Zweifel nur das Customizing failed, nicht der Elternprozess ### Dokumentation eines Workflows #### Titel Sprechenden Namen für jedes Customizing verwenden. Ein sprechender Prefix in der Benennung des Workflows zur Unterscheidung zwischen Customizations, Custom Workflows, Custom CSV Imports und Process Engine Workflows bietet sich an **Beispiel:** “CUSTOM / Sales Order after mapping / Mapp Order freefield to internal comment” #### **Beschreibung** Bitte immer eine Beschreibung pro Workflow hinterlegen. So kann insbesondere der Support schnell erfassen, was das Customizing macht. Wichtige Infos in der Beschreibung: * Was ist der Zweck des Customizings? * Warum war ein Customizing nötig? * Wer hat das Customizing gebaut und wann? * Gibt es ein zugehöriges Ticket? * Welcher Workflow wird angepasst? * Welcher Hook wird verwendet? * Welche Bedingungen gibt es, in welchen Fällen greift das Customizing? * Welche Variablen werden in dem Workflow angepasst? * Wie kann ich das Customizing testen? **Beispiel:**\ “Dieses Mapping mappt die von PlugIn XY im Payload bereitgestellten Zusatzfelder A und B auf das Feld “Interner Kommentar” in Xentral. Das Customizing greift nur in Projekt ABC und verwendet den Hook “Sales Order before Mapping”. Testbar durch erneute Ausführung des Sales Order Import Single Workflows im Projekt ABC. Erstellt von XY am 01.01.2026” #### **Links** * Rechtliche Dokumente (Angebote, Verträge), auch z.B. als JURO Link * ReadMe Datei * JIRA Ticket * … #### Support-Adresse * Insbesondere bei Customizings / Custom Workflows von Partnern * Adresse unter der Kunden Hilfe zu dem Customizing bekommen können #### Autor * Wer hat den Workflow angelegt * Wer hat den Workflow zuletzt bearbeitet --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://connect.xentral.com/guidelines/workflows-testen-und-dokumentieren.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.