Configuration Component Toggles

Configuration — Component Toggles

The components section controls which parts of your solution are included in the generated documentation. All components are enabled by default — you only need this section if you want to turn something off.

Config

components:
  tables: true
  forms: true
  views: true
  relationships: true
  flows: true
  classicWorkflows: true
  plugins: true
  webResources: true
  securityRoles: true
  globalChoices: true
  emailTemplates: true
  modelDrivenApps: true
  connectionReferences: true

  environmentVariables:
    enabled: true
    showDefaultValue: true
    showCurrentValue: false     # see note below

Component reference

Toggle	What it includes
tables	Table schema — columns, types, required flags, custom vs standard
forms	Main, Quick Create, and Card forms — tabs, sections, and fields
views	Saved views — columns, filter conditions, linked entity joins
relationships	1:N relationships — direction, custom vs OOB, included in the ER diagram
flows	Power Automate flows — trigger, nested action tree, Mermaid flowchart
classicWorkflows	XAML-based classic workflows — trigger config, condition steps, branch actions
plugins	Plugin assemblies — assembly metadata, step registrations, entity/message/stage bindings
webResources	JavaScript web resources — function index, namespace, JSDoc, optional AI summaries
securityRoles	Security roles — privilege matrix per entity for all 8 operations
globalChoices	Solution-level option sets — values, labels, hidden flags
emailTemplates	Email templates — subject, plain text body with field placeholders
modelDrivenApps	Model-driven apps — entity list, app settings, role mappings
connectionReferences	Connection references — connector name, logical name
environmentVariables	Environment variable definitions — type, default value, optional current value

Environment variables — extra options

Environment variables have two additional display options:

environmentVariables:
  enabled: true
  showDefaultValue: true    # show the default value column
  showCurrentValue: false   # show the current (live) value column

Caution with showCurrentValue: true — current values are read from your solution export and may contain real runtime data such as connection strings, service URLs, or configuration values. Be careful enabling this if your documentation is shared broadly or stored in a public wiki.

Turning a component off

Set the value to false:

components:
  emailTemplates: false     # exclude email templates from output
  globalChoices: false      # exclude global choices from output

Components that are turned off are completely excluded — they won't appear anywhere in the generated documentation.

ERD fine-tuning

The ER diagram on the Data Model page shows relationships between custom entities. If the diagram is too noisy, you can exclude specific entities or relationships:

erd:
  excludeEntities:
    - cr123_auditlog
    - cr123_tempdata
  excludeRelationships:
    - cr123_account_cr123_auditlog

excludeStandardRelationships: true (the default) automatically filters out all standard Dataverse relationships — only custom relationships are shown.