Zweck
Mit der Validator-Anbindung kann ein erzeugtes elektronisches Ausgangsdokument vor bzw. während der Ausgabe an einen externen Validator übermittelt werden. Das Ergebnis wird am Beleg gespeichert und kann in Business Central eingesehen werden.
Die aktuelle Implementierung bindet folgende Validatoren an:
Die Prüfung kontrolliert das erzeugte Dokument beim Validator; sie ersetzt weder die fachliche Belegprüfung in Business Central noch die Konfiguration des Ausgangsprofils.
Überblick
Die Validierung wird über das dem Beleg zugeordnete eDoc-Profil gesteuert. Im Profil wird ein aktiver Validierungsendpunkt ausgewählt. Zusätzlich legt die Option „Validate Automatically“ fest, ob die Prüfung in den automatischen Ausgabeabläufen ohne Rückfrage gestartet wird.
Einstellungen im Profil
-
Validation Endpoint Verknüpft das Profil mit dem zu verwendenden Validator-Endpunkt. In der Auswahl stehen aktive Endpunkte zur Verfügung.
-
Validate Automatically Startet die Validierung automatisch bei den unter „Automatische Validierung“ beschriebenen Ausgabeabläufen.
-
Ist kein Validierungsendpunkt im Profil hinterlegt, wird keine Validierung gestartet. Die automatische Einstellung ersetzt nicht die Auswahl eines Endpunkts.
Voraussetzungen und Einrichtung
-
Validator-Endpunkt einrichten
Öffnen Sie in Business Central „eDoc Endpoints“ und legen Sie einen Endpunkt für den Validator an bzw. ergänzen Sie den vorhandenen Endpunkt.
Code Eindeutiger Endpunkt-Code, der anschließend im eDoc-Profil ausgewählt wird.
Type beschreibt den Validator.
Active Aktivieren, damit der Endpunkt im Profil ausgewählt und verwendet werden kann.
Endpoint Basis-URL des Validator-Dienstes gemäß den Zugangsdaten bzw. der API-Dokumentation des Dienstes.
Authorization Authentifizierungsart passend zum Validator-Dienst.
Authorization / Header / Parameter Falls vom Dienst benötigt: Zugangsdaten, HTTP-Header und URL-Parameter über die gleichnamigen Endpunktaktionen konfigurieren.
Der Validierungsaufruf sendet einen JSON-Request. Falls der Dienst einen Content-Type-Header verlangt, richten Sie unter „Header“ den Wert Content-Type mit application/json ein. Weitere Authentifizierungs- und Headerangaben richten sich nach dem Vertrag des eingesetzten Validator-Dienstes; sie sind nicht für alle Installationen identisch.
Die Endpunkt-URL, die Authentifizierung und gegebenenfalls weitere Parameter müssen für die verwendete Validator-Umgebung korrekt sein. Ein nicht aktiver Endpunkt wird nicht validiert.
-
eDoc-Profil konfigurieren
Öffnen Sie die eDoc-Profilkarte und setzen Sie in der Gruppe „Outbound“ folgende Werte:
Validation Endpoint Wählen Sie den zuvor eingerichteten und aktiven Validator-Endpunkt aus.
Validate Automatically Legen Sie das gewünschte Verhalten fest:
Ja: Validierung in den automatischen Ausgabeabläufen.
Nein: Keine automatische Prüfung in diesen Abläufen. Bei der manuellen Erstellung eines eDocs kann die Validierung weiterhin einzeln bestätigt werden.
Stellen Sie außerdem sicher, dass das Profil dem Beleg entsprechend zugeordnet ist und ein passendes Ausgangsformat erzeugt.
Wann wird validiert?
Automatische Validierung
Bei aktivierter Option „Validate Automatically“ wird die Prüfung in den automatisierten eDoc-Ausgabewegen gestartet, sofern das Profil einen Validierungsendpunkt enthält. Dazu gehören die Erzeugung des Exportpuffers und der entsprechende automatische PDF-Ausgabeablauf.
Die Validierung erfolgt mit dem gerade erzeugten Dokument. Das Ergebnis wird gespeichert, bevor der jeweilige Ausgabeablauf fortgesetzt wird.
Manuelle Validierung
Bei der Aktion „Create eDoc manually“ wird nach der Erzeugung des Dokuments eine Rückfrage angezeigt, wenn im Profil ein Validierungsendpunkt eingetragen ist. Mit „Ja“ wird die Validierung gestartet; mit „Nein“ wird sie für diesen manuellen Vorgang ausgelassen.
Diese Rückfrage ist unabhängig von „Validate Automatically“. Die Option steuert die automatischen Abläufe, nicht die manuelle Entscheidung.
Unterstützte Belge
Das Ergebnis wird für folgende gebuchte Belegarten gespeichert:
-
Verkaufsrechnung
-
Verkaufsgutschrift
-
Service-Rechnung
-
Service-Gutschrift
-
Einkaufsrechnung
-
Einkaufsgutschrift
Eine offene Bestellung wird nicht als unterstützter Belegtyp für die Ergebnisverarbeitung behandelt. Führen Sie die Validierung für Einkaufsbelege daher erst nach dem Buchen der Rechnung oder Gutschrift aus.
Die aktuelle Anfragebehandlung ordnet dem Format HYBRID den Dateityp pdf und dem Format XML den Dateityp xml zu. Verwenden Sie für die Validator-Anbindung daher ein passendes HYBRID- oder XML-Ausgangsformat. Für andere Formate ist die Übergabe eines Dateityps in der aktuellen Anbindung nicht definiert.
Haftungsausschluss
Die Anbindung an externe Validierungsdienste erfolgt über Drittanbieter, deren Verfügbarkeit, Funktionsumfang und Prüfergebnisse außerhalb unseres Einflussbereichs liegen. Für die Richtigkeit, Vollständigkeit und Aktualität der durch den Drittanbieter bereitgestellten Validierungsergebnisse sowie für Ausfälle oder Änderungen des Dienstes übernehmen wir keine Verantwortung, soweit gesetzlich zulässig.
Die Validierung dient der technischen und fachlichen Unterstützung und stellt keine Garantie für die Rechtskonformität oder Fehlerfreiheit des geprüften Dokuments dar. Die Verantwortung für die Prüfung der Ergebnisse sowie für die ordnungsgemäße Erstellung und den Versand der Dokumente verbleibt beim Anwender. Es gelten ergänzend die Nutzungsbedingungen und Haftungsregelungen des jeweiligen Drittanbieters.
Prüfergebnis einsehen
Das Ergebnis wird je Belegart und Belegnummer gespeichert. Ein erneuter erfolgreicher Validierungslauf ersetzt das zuvor gespeicherte Ergebnis einschließlich der zugehörigen Fehler- und Hinweismeldungen.
Auf den Listpages wird bei vorhandenem Ergebnis die Aktion „Show Validation“ angeboten. Die Validierungskarte zeigt unter anderem folgende Angaben:
-
Valid Vom Validator zurückgelieferter Gültigkeitsstatus.
-
Profile, Version, Syntax und Summary Zusammenfassende Angaben des Validators.
-
Validator Verwendeter Endpunkt.
-
Validation Lines Einzelne Meldungen mit Schweregrad, Regel-ID, Meldung, Korrekturvorschlag sowie Feld- und Zeilenangabe, sofern vom Validator geliefert.
Über „Show Validation Result“ kann zusätzlich die vollständige JSON-Antwort des Validators angezeigt werden. Für die übrigen unterstützten Belegarten ist der Datensatz ebenfalls gespeichert; die Validierungskarte kann über die Business-Central-Seite „Validation Header“ geöffnet werden.
Auswirkung auf den Versand
Ein fachliches Ergebnis „Valid = false“ verhindert den eDoc-Export oder den Versand nicht automatisch. Es wird als Prüfergebnis gespeichert, damit Anwender die Meldungen auswerten und den Beleg bei Bedarf korrigieren können.
Technische Fehler beim Aufruf, beispielsweise eine nicht erfolgreiche HTTP-Antwort, fehlende Pflichtparameter oder ein Verbindungsfehler, werden dagegen als Fehler des Ausgabevorgangs behandelt und im eDoc-Log protokolliert. Bei automatischen Verarbeitungen kann dadurch auch der Job fehlschlagen.
Fehlerbehebung
Es wird keine Validierung gestartet
-
Im eDoc-Profil ist „Validation Endpoint“ nicht gesetzt.
-
Der Endpunkt ist nicht aktiv.
-
Bei der manuellen Erstellung wurde die Rückfrage verneint.
-
„Validate Automatically“ ist deaktiviert und es handelt sich um einen automatischen Ausgabeablauf.
Der Endpunktaufruf schlägt technisch fehl
Prüfen Sie folgende Punkte:
-
Endpunkt-Typ http://Zugferd-Validation.DE und Aktiv-Status
-
Validator-Basis-URL und Erreichbarkeit der Umgebung
-
Erforderliche Authentifizierung, HTTP-Header und URL-Parameter
-
Den eDoc-HTTP-Log sowie den Beleg-Ausgabelog auf die Antwort des Dienstes
Es gibt einen Validierungsdatensatz, aber der Beleg ist ungültig
Das ist ein fachliches Prüfergebnis und nicht notwendigerweise ein technischer Aufruffehler. Lesen Sie Summary und Validation Lines bzw. die vollständige JSON-Antwort, korrigieren Sie den Beleg oder das Mapping und erzeugen Sie das eDoc erneut.