JSON report – basierend auf JS-Objekt

Mit pdfToolbox 13 wurde neben den bestehenden, von Menschen lesbaren PDF-Reports der JSON-Report hinzugefügt. Dieser Reporttyp ermöglicht einen einfacheren Zugang zu Details über das PDF und seine Verarbeitung. Das Parsen der Struktur kann für verschiedene Automatisierungsumgebungen einfacher sein als mit dem bestehenden XML-Report.

Die verwendete Struktur ähnelt dem app.doc.results Array, das in JavaScript-Variablen in callas-Produkten verfügbar ist.

Der JSON-Report ist verfügbar:

  •  Nach der normalen Profilausführung im Desktop in der Funktionalität "Bericht erstellen" des Ergebnisdialogs
  • In Prozessplänen als Berichtstyp in Übergängen nach geeigneten Schritten (Profil, Fixup, Check)
  • Auf der CLI zur Profilausführung mit  --report=JSON (alle Parameter für den JSON-Report auf der CLI sind hier dokumentiert).

Bestandteile des JSON-Reports

Der JSON-Report umfasst fünf Abschnitte:

  1. doc: Informationen über das Dokument. Diese Informationen sind unabhängig von dem ausgeführten Profil.
  2. env:  Informationen über verschiedene Aspekte der Umgebung wie Plattform und Version.
  3. result:  Zeigt die durchgeführten Schritte (Checks/Fixups) und die Anzahl der Korrekturen an.
  4. settings: Gibt die für die Berichterstellung gewählten Optionen wider.
  5. steps: Auflistung der Namen, Kommentare und Typen aus allen Schritten.

The doc section

  1. info: Informationen über die PDF-Datei, z. B. Erstellungsdatum, PDFX-Version, Titel
  2. metadata: Enthält die XMP-Metadaten der PDF-Datei.
  3. pages: Enthält die Dimensionen (relativ und absolut) aller Seiten.
  4. quickcheck: Seit pdfToolbox 14 ist eine vordefinierte Quick Check Konfigurationsdatei in der Reporterstellung enthalten. Diese Datei versorgt den JSON-Report mit zusätzlichen Informationen über das Dokument, wie z.B. verwendete Ressourcen (Bilder, Schriften, Schmuckfarben), Anmerkungen, eingebettete Dateien, Ebenen oder der Output Intent. Wenn ein JSON-Report auf der CLI oder innerhalb eines Prozessplans erzeugt wird, können verschiedene Einstellungen für den JSON-Report getroffen werden.

The result section

  1. checks: listet alle Prüfungen auf, die einen Treffer erzielt haben, während Checks ohne Treffer nicht aufgelistet werden. Wenn eine im jeweiligen Check verwendete Eigenschaft einen Auslösewert liefert, wird dieser ebenfalls aufgelistet.
  2. fixups: listet alle ausgeführten Korrekturen auf, die Anzahl der Korrekturen ist ebenfalls enthalten. Bei der Prozessplanausführung wird nur der letzte Sequenzschritt im Ergebnisteil aufgeführt.

The steps section

Im Abschnitt steps werden alle ausgeführten Schritte mit Name, Kommentar und Typ aufgelistet. Bezüglich Prozessplänen: Im Gegensatz zum Abschnitt result werden im Abschnitt steps alle in einem Prozessplan enthaltenen Sequenzschritte aufgeführt (nicht nur der letzte).