required, include

Reference · Source keys · Documentation

Updated

Browse documentation
On this page

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

Definition

A missing required source blocks the run. include: false skips a source.

Distinguish required input from a skipped source

Use required: true for a source whose absence must block the run. Use include: false when the configuration should skip that source. Skipping a source is a deliberate exclusion; it does not prove that the source file is present or valid.

For example, if a process analysis depends on the claims event log, keep that log required. If you temporarily exclude another export while investigating it, record that exclusion alongside the results so readers know which evidence was absent.

Check the validation outcome

Run observatory validate --config observatory.yaml and inspect each source status. A failed optional source can be excluded only if another analytical source supplies admitted rows. The exit-code rules explain when the command still returns a failure.