field_map

Reference · Source keys · Documentation

Updated

Browse documentation
On this page

Earlier command and setup reference · Engine 18.6.0rc590 / Reader 8.11.0rc649

Definition

Each canonical field and the one physical column that holds it.

Map meaning to physical headers

This fragment uses the column names in the claims example:

field_map:
  event_id: event_ref
  trace_id: case_id
  activity: activity
  start_ts: started
  end_ts: finished
  employee_id: handled_by

The left side is the canonical field understood by the contract. The right side is the one physical column containing that field in this export. Check the actual header row before copying the example.

Choose the right mapping mechanism

field_map is a source declaration. The adapter's column_map is a list of accepted header names in a contract; it is edited through the separate adapter procedure. Validate after either change, and inspect a known claim to confirm that IDs, activities and timestamps have retained their intended meanings.