PDF Reports

The CLI can request a PDF report from the API and save it after a completed validation operation.

Request A PDF

optimus check customers.csv --map mapping.yml --qualified --pdf

YAML default:

defaults:
  pdf: true

Disable PDF output even when YAML enables it:

optimus check customers.csv --map mapping.yml --qualified --no-pdf

Signing

Request a digitally signed PDF:

optimus check customers.csv --map mapping.yml --qualified --pdf --sign

YAML default:

defaults:
  pdf: true
  sign: true

--sign requires PDF output. Use --no-sign to disable signing when YAML enables it.

Save Location

Set the PDF directory:

optimus check customers.csv --map mapping.yml --qualified --pdf --pdf-dir ./pdf

YAML default:

defaults:
  pdfDir: ./pdf

When pdfDir is not set, the CLI saves PDFs:

1. In the output CSV directory when --out is set.
2. Otherwise in the input file directory.

File Names

The CLI uses the API-provided PDF file name when available. Otherwise it uses:

<input-name>_report.pdf

Add a timestamp:

optimus check customers.csv --map mapping.yml --qualified --pdf --pdf-timestamp

The timestamp format is:

yyyy-MM-dd_HHmmss

Email Options

Ask the API to send a notification email:

optimus check customers.csv --map mapping.yml --qualified --notify

Ask the API to send the PDF by email:

optimus check customers.csv --map mapping.yml --qualified --pdf --email-pdf

--email-pdf requires PDF output.