entity-document-generator-config schema

One config row for the generic engine-entity.document-generator job — generate a structured-data artifact (json/csv) per eligible row via the FileService, store it in a DMS cabinet, and stamp the file id onto the row.

Pull the full JSON Schema: erp schema pull entity-document-generator-config  ·  MCP: erp_get_schema {"name":"entity-document-generator-config"}

Top-level properties

Property	Type	Required	Notes
document_code	string	yes	Stable identifier / natural key for idempotent seeding.
source_entity	string	yes	Entity whose rows get a document.
status_field	string
when_status_in	string		Comma-separated statuses a row must be in to be eligible (e.g. COMPLETED for an audit report). Blank = every row.
filter_field	string		Optional single-column equality pre-filter.
filter_value	string
target_file_field	string	yes	Text column on the source row that receives the generated file id. Its non-blank state IS the dedupe marker.
format	string		one of: json, csv
cabinet_id	integer		DMS cabinet id (engine-file) the artifact is stored in. Give this OR cabinet_name.
cabinet_name	string		Portable alternative to cabinet_id: the job resolves a cabinet by this name for the tenant, creating it if absent. Preferred for seed-data rows (no hardcoded id).
file_name_template	string		Generated file name. Supports ${id} ${date} ${ts} ${uuid} and ${field:<name>}. Default: <document_code>-${id}-${date}.<ext>.
include_fields	string		Comma-separated source fields to include in the artifact. Blank = all fields.
child_entity	string		Optional child entity whose rows (matched by child_match_field == source id) are embedded (json) alongside the record.
child_match_field	string		FK column on child_entity pointing at the source row's id.
template_ref	string		Reserved: a print-template id, for the future render_mode:template branch. Not used today (see description).
regenerate	boolean		When true, regenerate even if target_file_field is already populated.
seeded_by	string
active	boolean	yes