Skip to main content

Result CSV

The result CSV contains one row for each input row the CLI writes to output, including skipped rows.

Default Output Path

For customers.csv, the default single-file result path is:

customers_result.csv

Override it with:

optimus check customers.csv --map mapping.yml --standard --out ./results/customers_checked.csv

In folder mode, result files are written to the folder's results directory.

Default Columns

When output.columns and --out-columns are not set, the CLI writes:

  1. row
  2. Configured custom columns in YAML order
  3. Standard validation result columns

Standard validation result columns are:

vat_id
vat_id_status
name
name_status
name_determined
street
street_status
street_determined
zip
zip_status
zip_determined
city
city_status
city_determined
checked_at

Selecting Columns

Use --out-columns:

optimus check customers.csv --map mapping.yml --standard --out-columns row,vat_id,vat_id_status,checked_at

Or YAML:

output:
columns:
- row
- customer_number
- vat_id
- vat_id_status
- checked_at

Custom columns must use the output name from customColumns, not the input CSV header.

Column Shortcuts

ShortcutExpands to
allDefault output: row, configured custom columns, and all standard result columns.
all_originalsrow, custom columns, vat_id, name, street, zip, city.
all_statusesvat_id_status, name_status, street_status, zip_status, city_status.
all_determinedname_determined, street_determined, zip_determined, city_determined.

Status Values

vat_id_status uses the record status returned by the API, for example:

  • Valid
  • Invalid
  • Unavailable

For skipped rows, the CLI writes:

  • SKIPPED

For request or response failures, the CLI can write:

  • ERROR
  • TEMP_ERROR

Field status columns such as name_status, street_status, zip_status, and city_status use field match status values returned by the API, for example:

  • Match
  • NoMatch
  • NotQueried
  • NotReturned

When the API returns a NoMatch field result with a correction value, the CLI writes the correction into the matching *_determined column.

Output Encoding And Delimiter

Set output format in YAML:

output:
delimiter: ";"
encoding: "utf-8"
bom: true

Or through options:

optimus check customers.csv --map mapping.yml --standard --out-delimiter ";" --out-encoding utf-8 --no-bom

If no output delimiter is set, the CLI uses the input delimiter. If that is also not set, it uses ;.