Operation: Validate

The Validate operation of the ZUGFeRD adapter validates an input PDF file or an input XML file and outputs an XML file containing data on the validation.

For more information on other operations of the ZUGFeRD adapter, see ZUGFeRD.

Parameters

`Adapter`	Main class of the adapter (do not change!) Possible values: `de.softproject.x4.adapter.pdf.zugferd`: Main class (Default)
`fileName`	This parameter is required for this operation. Name of the input file Note: You must specify a value for this parameter, but you can specify any value, such as `example.pdf`. The value defined in this parameter is later output in the output XML file. This may facilitate matching the validation information to the corresponding document later.

Status values

`1`	The operation was successful and the XML-PDF combination is valid.
`2`	The operation was successful, but the XML-PDF combination is not valid.
`-1`	The operation failed due to a technical error.

Input

The operation expects a PDF file or an XML file as input.

Note:

Please make sure that the correct MIME type or media type is defined for the input file. One of the following MIME types is possible for the Validate operation:

application/pdf
application/xml
text/xml

The MIME type is automatically set if you, for example, import files as resources in the project repository.

If you, for example, load files into your process from a folder on your computer using a File System adapter, you first need to set the MIME type of the file using the Document Properties Changer adapter. For more information on the Document Properties Changer, see Document Properties Changer.

If you do not define the correct MIME type, the adapter issues a corresponding error.

Output

The operation outputs an XML file containing data on version, profile, and standard.

The following is an example XML file:

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>