Skip to content

Configuration Parse and Render

Lewis Ginn edited this page Jul 20, 2026 · 1 revision

Configuration — Parse & Render Options

Two small sections that control what the parsers keep and how a couple of components are presented.

parse

parse:
  customColumnsOnly: false
  excludeBaseCurrencyFields: true
  excludeStandardRelationships: true
  excludedColumns:
    - timezoneruleversionnumber
    # ...
Field Type Default What it does
customColumnsOnly boolean false true drops every column that isn't custom. Useful when clients only care about what was built for them.
excludeBaseCurrencyFields boolean true Drops the *_base shadow columns Dataverse creates for money fields.
excludeStandardRelationships boolean true Keeps only custom relationships. Also the first tier of ER diagram noise filtering.
excludedColumns string[] 12 system columns Columns excluded from all table documentation.

The 12 built-in exclusions are:

timezoneruleversionnumber   utcconversiontimezonecode   importsequencenumber
overriddencreatedon         exchangerate                transactioncurrencyid
owningteam                  owninguser                  owningbusinessunit
createdonbehalfby           modifiedonbehalfby          versionnumber

⚠️ Setting excludedColumns in your config replaces that list — it does not extend it. If you want to add one more exclusion, you must repeat all 12 plus yours. This applies to every array in the config: arrays are replaced on merge, not concatenated.

render

render:
  formLayout: compact       # compact | detailed
Value What you get
compact (default) A summary table per form
detailed Full tab → section → field breakdown for every form

detailed produces substantially longer documentation. It's the right choice when the forms themselves are the deliverable; compact is right for most as-built docs.

Clone this wiki locally