JSON report – ähnlich dem XML-Report

Der JSON-Report ermöglicht einen einfacheren Zugang zu Details über die PDF-Datei und ihre Verarbeitung. Das Parsen der Struktur kann für verschiedene Automatisierungsumgebungen einfacher sein als mit dem bestehenden XML-Report.

Mit pdfToolbox 15 wurde ein weiterer JSON-Report hinzugefügt. Somit kann zwischen zwei verschiedenen JSON-Reports gewählt werden:

  1. JSON Report – basierend auf JS-Objekt: Struktur ähnelt dem app.doc.results Array, das in JavaScript-Variablen in callas-Produkten verfügbar ist.
  2. JSON Report – ähnlich dem XML-Report: Die Struktur ist ähnlich der des XML-Berichts und umfasst eine Liste der Ressourcen, auf die im  "result"  Abschnitt Bezug genommen wird.

Vorteile des JSON v2 (ähnlich dem XML-Report) Reports

  • Zugriff auf zusätzliche Ergebnisdateien wie SaveAsImage oder Reports
  • Verbesserte Übersicht über die Prozessschritte
  • Auflistung nur vorhandener Druckplattennamen (erfolgt durch Analyse); Beispiel: nur Schwarz für CMYK

Der JSON v2 Report ist verfügbar:

  • Nach der normalen Profilausführung in pdfToolbox Desktop unter "Bericht erstellen" im Ergebnisdialog: JSON Report – ähnlich dem XML-Report

  • In Prozessplänen als Berichtstyp in Übergängen nach geeigneten Schritten (Profil, Korrektur, Prüfung): JSONv2

  • Auf der CLI zur Profilausführung mit --report=JSONV2 (alle Parameter für den JSON-Report auf der CLI sind hier dokumentiert).

Bestandteile des JSON v2 Reports

Der JSON v2 Report umfasst vier 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.
  4. settings: Zeigt die gewählten Optionen für die Report-Erstellung an.

doc Abschnitt

  1. info: Informationen über die PDF-Datei, z. B. Erstellungsdatum, PDFX-Version, Titel.
  2. outputIntents: Enthält einen Verweis auf die in "resources" gespeicherten Informationen zum Output Intent.
  3. pages: Enthält die Dimensionen (relativ und absolut) und die Druckplatten aller Seiten.
  4. plates: Listet alle Druckplatten im PDF-Dokument auf.
  5. resources: Enthält alle Ressourceninformationen für Kommentare, Lesezeichen, Farbräume, eingebettete Dateien, Schriftarten, Form-XObjekte, Bilder, Ebenen, Output Intents, Muster (Pattern) und Smooth Shades.

"resources" Syntax

  1. id: Jede Dokumentressource hat einen eindeutigen ID-Namen zur Identifizierung.
  2. idRef: Referenzierte ID zu einer Ressourcen-ID.

result Abschnitt

Der result Abschnitt listet alle ausgeführten Schritte im steps Abschnitt auf. Das folgende Beispiel zeigt das Ergebnis einer Preflight-Prüfung, bei der Bilder mit einer Auflösung von mehr als 300 ppi gefunden wurden:

1. checks: Listet alle Prüfungen auf, die einen Treffer erzielt haben, während Prüfungen ohne Treffer nicht aufgelistet werden.  

2. hits: Wenn eine Prüfeigenschaft einer Prüfung einen Treffer erzeugt, wird der Triggerwert angegeben.

3. idRef: Der Treffer bezieht sich auf eine bestimmte Ressourcen-ID, die im Abschnitt "doc" unter "resources" aufgeführt ist. Auf diese Weise lässt sich feststellen, welches Objekt auf welcher Seite den Treffer ausgelöst hat.

settings Abschnitt

In diesem Abschnitt werden die für die Report-Erstellung ausgewählten Optionen angezeigt:

allchecks: Prüfungen ohne Treffer einbeziehen. Standardmäßig werden Prüfungen nur aufgelistet, wenn sie mindestens einen Treffer erzeugen. 
allfixups: Korrekturen ohne Änderungen einbeziehen. Standardmäßig werden Korrekturen nur aufgelistet, wenn sie mindestens ein Objekte ändern.
compact:  Der JSON-Report wird in einer einzigen Zeile geschrieben.
variables: Alle verwendeten Variablen werden ebenfalls aufgelistet.