Report creation and command line output

Report creation

For each pdfaPilot CLI run several reports may be generated by inserting --report or -r switches into the pdfaPilot call. Following all options and reporttypes are listed. The options of --report are treated case insensi-­tive and have to be separated by commas.

--report=[<type>,][<trigger>,][<options>,]<PATH=path>

Parameters

type
 Optional, see "Report types and their options"
trigger
 Optional, see "Report triggers"
options
 Optional, see "Report types and their options"
path
 Optional, see "Report path"

Report types and their options

HTML (default)

A html file is created. The format may be modified by combining this option with other options. It can be opened by any webbrowser.

Additional options for HTML reports

All following switches may be simultaneously used in order to add differ-­ent types of additional content.

NOICONS

Create a report without any images

NOCORRECTIONS

Do not log corrections

NODETAILS

Suppress details for the occurences

OPENRESULT

All entries in the report are opened in Initial view (closed by default if JavaScript is enabled)

Set the path for referenced objects 
--linkpath

HTML reports are generated without exporting referenced objects. This option requires a path (URL) to a folder where the referenced objects reside (Default: folder "\etc\reporttemplate" in pdfaPilot CLI directory)

Example: 
--linkpath="file:\\\Programme\pdfaPilot\etc\reporttemplate"
Customize your report

If you create a HTML report, you can completely customize it by adapting the CSS-File to your needs. You can even exchange the pictures.

You can find all material used for the HTML reports within the folder "\etc\reporttemplate" in your pdfaPilot CLI directory.

XML

XML file which is intended to be processed with software (parsers). The scheme of the XML report structure can be found within the xsd-file stored in "\var\XMLV2 report schema\".

MHT

A mht file is created. MHT is a data format created by Microsoft which offers the possibility to include all resources (like style sheets, images and JavaScripts) to be included in one file. This file type can only be read by Internet Explorer.

TEMPLATE 

TEMPLATE=<path>

Path to template folder (or respective index.html directly) PDF overview reports are created based on a style defined in a HTML/CSS template. A predefined template can be found in the Server/CLI path: ../var/Reports/Templates. Click here for further information.

Report triggers

ALWAYS

Always create a report (default)

IFNOPDFA

Create a report only if the file can-­not be converted to PDF/A

IFPDFA

Create a report only if the file can be converted to PDF/A

Report path 

--report=<Report type>,<Report options>,PATH=<Path>

Full path of report file – the report path must not contain any commas.

  • Note: PATH= must always be the last element.

Example: 

--report=HTML,NOICONS,OPENRESULT,PATH=C:\Sample.html

Set the report language 

-l --language=<language>

Defines the language in which the report is generated. Default language is English (en). The language is specified by using a two digit abbreviation. The following values can be used in the standard configuration:

Parameters

EN

English

DE

German

FR

French

IT

Italian

ES

Spanish

JA

Japanese

Command line output

Display progress 

--noprogress

Switch off progress information.

Display hits 

--nohits

Switch off output of hits (errors, warnings, information).

Display summary 

--nosummary

Switch off summary information.

Display timestamp 

--timestamp

Show a timestamp for each line of command line output.

Structure of command line output

Checks 

Hit    Type of hit    Name of check   [Name of font]   [Name of glyph]

1. Hit

  • always visible
  • keyword

2. Type of hit

  • always visible
  • possible values: "PDFA", "Error", "Info", "Warning" (only for      additional profile)

3. Name of check

  • always visible
  • never empty

4. Name of font

  • only visible for hits that belong      to a font check
  • can be empty

5. Name of glyph

  • only visible for hits that belong      to a font check
  • can be empty

Corrections 

Fix    Name of fixup   [Name of font]

1. Fix

  • always visible
  • keyword
2. Name of fixup
  • always visible
  • never empty
3. Name of font
  • only visible for fixups that      belong to a font correction
  • can be empty
Failed corrections 
FixFailure   Name of fixup  [Name of font]
1. FixFailure
  • always visible
  • keyword
2. Name of fixup
  • always visible
  • never empty
3. Name of font
  • only visible for fixups that belong to a font correction
  • can be empty
Progress 
Progress Value %