Pdfa-Parameter

Bei dem Webservice "Pdfa" können die beiden Operationen

 

"<convert>" und

"<analyze>"

 

angesprochen  werden. Die Operation "convert" dient zum Konvertieren von PDF-Dokumenten nach PDF/A und die Operation "analyze" dient zum Validieren eines existierenden PDF/A-Dokumentes.

 

 

convert-Operation

 

Konvertiert ein PDF-Dokument nach PDF/A.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<pdfa>
  <convert errorReport="message" level="3u" imageQuality="75" successReport="linked">
    <zugferd>
      <xmlFile version="v10Comfort">
         PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCg0KPHBy
         ...
         dD4=
      </xmlFile>
    </zugferd>
  </convert>
</pdfa>
</operation>

{
"pdfa": {
  "convert": {
    "errorReport": "message",
    "level": "3u",
    "imageQuality": "75",
    "successReport": "linked",
    "zugferd": {
      "xmlFile": {

       "version": "v10Comfort",
        "value": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCg0KPHBy...dD4="
       }
     }
   }
 }
}

 

 

convert-Element

 

Definiert die Parameter für die PDF/A-Konvertierung.

 

<convert errorReport="message" level="3u" imageQuality="75" successReport="linked" autoTagging="false">
...
</convert>
 

"convert": {
  "errorReport": "message",
  "level": "3u",
  "imageQuality": "75",
  "successReport": "linked",

  "autoTagging": false,
     ...
}

 

level (Default: "1b")

Gibt die Konformitätsebene für die PDF/A-Erstellung (gemäß ISO 19005) an.

1a = PDF/A-1a

1b = PDF/A-1b

2a = PDF/A-2a

2b = PDF/A-2b

2u = PDF/A-2u

3a = PDF/A-3a

3b = PDF/A-3b

3u = PDF/A-3u

 

imageQuality (Default: 75)

Über diesen Parameter wird die Qualität für Bilder festgelegt, die während der Konvertierung umgewandelt werden müssen, weil sie eine nicht erlaubte Komprimierung (z.B. JPX ist nicht in PDF/A-1 erlaubt) verwenden. Es sind Werte im Bereich von 1 bis 100 erlaubt, wobei ein höherer Wert bessere Qualität bedeutet, aber auch größere PDF-Dokumente.

 

errorReport (Default: "none")

Über diesen Parameter wird bestimmt, ob und wenn in welcher Form der XML-Bericht für eine fehlgeschlagene Konvertierung zurückgeliefert wird.

 none = XML-Bericht wird nicht zurückgeliefert

message = XML-Bericht wird als Bestandteil der Fehlernachricht geliefert

file = XML-Bericht wird in Datei gespeichert

 

successReport (Default: "none")

 Über diesen Parameter wird bestimmt, ob und wenn, in welcher Form, der XML-Bericht für eine erfolgreiche Konvertierung zurückgeliefert wird.

 none = XML-Bericht wird nicht zurückgeliefert

 linked = XML-Bericht wird an das Ende des PDF/A-Dokuments angehängt.

 zip = PDF/A-Dokument und XML-Bericht werden zusammen in ein ZIP-Archiv gepackt.

 

tipp

Das Format des Dokuments, das bei "errorReport" und "successReport" erstellt wird, wird über das Schema http://schema.webpdf.de/1.0/report/pdfa.xsd beschrieben.

 

autoTagging (Default: false)

Für die Umwandlung eines Dokumentes in die Konformitätsebenen PDF/A 1a-3a muss das gesamte Dokument mit entsprechenden Strukturinformationen (Tags) versehen sein. Wird auto tagging aktiviert, so werden die entsprechenden Strukturinformationen (in Form von Seitentags) automatisch vor der eigentlichen Umwandlung generiert.

 

zugferd-Element

 

Mit diesem Bereich kann optional ein ZUGFeRD-Dokument eingebunden werden. Das Dokument muss mindestens als PDF/A-3 Dokument konvertiert werden.

 

<zugferd>
  <xmlFile version="V10_COMFORT">
      PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCg0KPHBy
      ...
      dD4=
  </xmlFile>
</zugferd>

"zugferd": {
  "xmlFile": {

       "version": "V10_COMFORT",
      "value": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCg0KPHBy...dD4="
  }
}
 

 

xmlFile-Element

 ZUGFeRD-Datei (XML) als "Base64 encoded". Die Datei wird vor der Einbettung gegen das ZUGFeRD XSD-Schema validiert. Sollte Sie nicht gültig sein, so wird der Vorgang abgebrochen.

 

version (Default: v10Comfort)

Definiert die Version der ZUGFeRD XML-Datei, die über "xmlFile" eingebettet werden soll. Es werden die Versionen 1.0, 2.0 und 2.1.x unterstützt. Bei der Version 1.0 ist nur das Profil "Comfort" vorhanden. Bei der Version 2.0 werden die Profile "Minimum", "Basic WL", "Basic", "EN16931" (Comfort) und "Extended" unterstützt. Bei Version 2.1.x sind die gleichen Profile wie bei Version 2.0 vorhanden und zusätzlich noch das Profile "X-Rechnung".

 

Liste der Versionen mit ihren Profilen:

v10Comfort

v20Minimum

v20BasicWL

v20Basic

v20EN16931

v20Extended

v21Minimum

v21BasicWL

v21Basic

v21EN16931

v21Extended

v21XRechnung

 

 

analyze-Operation

 

Überprüft ein PDF-Dokument auf  PDF/A-Konformität.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<pdfa>
  <analyze level="1b"/>
</pdfa>
</operation>

 

{
"pdfa": {
  "analyze": {
    "level": "1b"
   }
 }
}

 

 

analyze-Element

 

Definiert die Parameter für die PDF/A-Überprüfung.

 

<analyze level="1b"/>
 

 

"analyze": {
"level": "1b"
}

 

level (Default: "1b")

PDF/A-Level, zu dem die Konformität geprüft wird (siehe convert-Operation)