{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
JSON Export
The plugin command.jsonexport adds a new export feature to the command line tool. Enabling this export format will store a summary of the result in JSON format to the default export location. The JSON export format is especially intended to automate batch comparisons.
| Parameter | Description |
|---|---|
| -j | -json | Activates the export of the JSON summary and will export to a .json file in the result folder. This folder can be changed with the -r option |
JSON data format
The JSON written to the result file has the following format:
| Field | Value Type | Description |
|---|---|---|
results |
object array | Array of single job results |
numberOfComparisons |
number | The total number of comparisons in the batch job |
numberOfDifferentDocuments |
number | The total number of comparisons that detected differences |
startTimestamp |
number | The start timestamp in milliseconds 1/1/1970 00:00:00 |
endTimestamp |
number | The end timestamp in milliseconds 1/1/1970 00:00:00 |
jobDuration |
number | The total duration of the batch job in seconds |
pagesFirst |
number | Number of pages compared in the first documents |
pagesSecond |
number | Number of pages compared in the second documents |
pagesTotal |
number | Summary of 'maximum number of pages' per comparison; not just pagesFirst + pagesSecond |
The single job result object has the following format:
| Field | Value Type | Description |
|---|---|---|
firstName |
string | The name of the first document |
secondName |
string | The name of the second document |
totalDifferences |
number | The total number of differences detected in the comparison |
added |
number | The number of elements added in the second document |
removed |
number | The number of elements removed in the first document |
replaced |
number | The number of replaced elements |
modified |
number | The number of elements that were modified in style |
pagesFirst |
number | Number of pages in the first document |
pagesSecond |
number | Number of pages in the second document |
comparisonFailed |
boolean | Indicates whether the comparison has failed due to an error. In that case the differences numbers are invalid. |
© Copyright 1996 - 2025, i-net software GmbH; All rights Reserved. Imprint
