Operation: Validate

Die Operation Validate des ZUGFeRD Adapters validiert eine Input-PDF-Datei oder eine Input-XML-Datei und gibt eine XML-Datei aus, die Daten zur Validierung enthält.

Weitere Informationen zu anderen Operationen des ZUGFeRD Adapters finden Sie unter ZUGFeRD.

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: `de.softproject.x4.adapter.pdf.zugferd`: Hauptklasse (Standard)
`fileName`	Dieser Parameter ist erforderlich für diese Operation. Name der Input-Datei Hinweis: Sie müssen einen Wert für diesen Parameter angeben, können aber einen beliebigen Wert festlegen, z. B.: `example.pdf`. Die Angabe in diesem Parameter wird später in der Output-XML-Datei ausgegeben. Dies erleichtert ggf. eine spätere Zuordnung der Validierungsinformationen.

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt und die XML-PDF-Kombination ist valide.
`2`	Die Operation wurde erfolgreich ausgeführt, jedoch ist die XML-PDF-Kombination nicht valide.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen

Input

Die Operation erwartet als Input eine PDF-Datei oder eine XML-Datei.

Hinweis:

Beachten Sie, dass der korrekte MIME-Typ bzw. Media Typ für die Input-Datei definiert ist. Für die Operation Validate ist einer der folgenden MIME-Typen möglich:

application/pdf
application/xml
text/xml

Dies ist automatisch gegeben, wenn Sie beispielsweise Dateien als Ressourcen in das Project Repository importieren.

Wenn Sie in einem Prozess beispielsweise mittels eines File System Adapters Dateien aus einem Ordner auf Ihrem Rechner in Ihren Prozess laden, müssen Sie zunächst den MIME-Typ der Datei mithilfe des Adapters Document Properties Changer neu setzen. Weitere Informationen zum Document Properties Changer finden Sie unter Document Properties Changer.

Wenn Sie den korrekten MIME-Typ nicht definieren, gibt der Adapter einen entsprechenden Fehler aus.

Output

Die Operation gibt ein XML-Datei mit Daten zur Validierung aus.

Im folgenden sehen Sie eine Beispiel-XML-Datei:

CODE

<?xml version="1.0" encoding="UTF-8"?>
<validation datetime="2024-12-09 10:42:37" filename="example.pdf">
   <pdf>ValidationResult [flavour=3b, totalAssertions=25304, assertions=[], isCompliant=true]
    <info>
         <signature>unknown</signature>
         <duration unit="ms">2029</duration>
      </info>
      <summary status="valid"/>
   </pdf>
   <xml>
      <info>
         <version>2</version>
         <profile>urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended</profile>
         <validator version="2.15.1"/>
         <rules>
            <fired>173</fired>
            <failed>0</failed>
         </rules>
         <duration unit="ms">361</duration>
      </info>
      <summary status="valid"/>
   </xml>
   <summary status="valid"/>
</validation>