Report Block

Description

Qinertia CLI can generate processing reports at the end of the workflow. The processing report details all operations done during the processing job as well as quality results and figures. Please read the Session report page to get a full description of the JSON report version. It will give you an accurate idea of the information included in the report.

You can generate several processing reports using different template and output format such as JSON, PDF or HTML.

JSON Block Sample

In this following example, we ask Qinertia CLI to generate two processing reports, one in JSON and one in PDF.

"reports": [
  {
    "name": "JSON report",
    "template": "jsonStandard",
    "outputDir": "./report/json"
  },
  {
    "name": "PDF report",
    "template": "pdfStandard",
    "outputDir": "./report/pdf"
  }
]

Block Specification

The reports block is an array, each entry describe an report generation job as describe below:

Parameter	Type	Optional	Description
reports[].name	string		Report generation job name. This has nothing to do with the generated output files and is used for status feedback.
reports[].template	string		Template to use to generate the report. The template includes the report format such as (JSON, HTML, PDF): jsonStandard: Output a JSON report containing basic processing information. pdfStandard: Output a PDF report containing basic processing information. htmlStandard: Output a HTML report containing basic processing information.
reports[].outputDir	string		Relative or absolute path where the report files have to be written. If not specified the parameter is set to ./ please see the note below.

Output Relative Path

If you use a relative path in the reports[].outputDir parameter, it is referenced to the JSON process file unless you have specified an output base path with the --output option while invoking Qinertia command line.