JSON reports

With pdfToolbox 13, beside the existing human-readable PDF reports, the JSON report has been added. This report type allows easier access to details about the PDF and its processing. Parsing the structure might be simpler than with the existing XML report for several automation environments.

While the XML report contains lots of information regarding the PDF and the used Profile, the JSON report is focused on basic information about the PDF.
The used structure is similar to the app.doc.results array available in JavaScript Variables within callas products.

Beside the DocInfo details, the XMP metadata of the PDF is contained in the JSON report.
Furthermore only the dimension (relative and absolute) of all pages are included.
Some information about the system the Profile was executed is also part of this report.
The "result" area lists all checks which created a hit, whereas Checks without hits will not be listed:

If a Property used in the respective Check provides a trigger value, it will be listed of course. Also pages and coordinates will be provided.

In the "result" part for Fixups, all executed Fixups will be listed and the number of corrections is included:

For Process plan execution, all executed steps will be listed. The given results are derived from the last step of course.

To keep the JSON report simple and straight forward, there are no further parameters for adjustments available.

The JSON report is available:

  • After the normal Profile execution in Desktop in the "Create Report" functionality of the results dialog
  • In Process plans as a report type in transitions after suitable Steps (Profile, Fixup, Check)
  • On the CLI for Profile execution using --report=JSON