Skip to main content

Customize Captured Fields

Controlling which fields and sections appear in Docupath's outputs

Customize Captured Fields overview screen showing document type selector and field sections

Customize captured fields is a configuration module that controls which predefined system fields and sections are included or excluded from Docupath's output.

Unlike Instruction Builds (which guide what the AI extracts) or Transformations (which reshape extracted values), Customize captured fields operates as an output filter - determining which fields are allowed to appear in API responses, validation screens, stored extraction results, and export payloads. It supports scoped configuration at four levels (Global, Country, Organization, Trading Party), with a clear precedence hierarchy that resolves conflicts when multiple scopes apply.


How It Works

What "Disabled" Means

When a field is disabled through Customize captured fields:

  • The field is removed from API response payloads

  • The field is not returned to the frontend

  • The field does not participate in rendering, validation, or UI workflows

  • The field is excluded from stored extraction outputs, validation screens, exports, and downstream enrichment/mapping stages

Disabling a field is non-destructive: it does not delete stored document data, change AI extraction behavior, or transform values. The AI still extracts the field internally - Customize captured fields simply controls whether it appears in the output.

Section-Level vs. Field-Level Disabling

Customize captured fields supports two levels of control:

Section-Level Disable - Disables an entire section and all predefined fields inside it. Use this when a whole block of fields is irrelevant for the target output. When a section is disabled, no partial exceptions are possible - all fields in that section are removed.

Field-Level Disable - Disables only selected fields within a section. Use this when you need some fields from a section but not others.

Mandatory sections: The Primary Party section and Secondary Party section cannot be disabled - they are mandatory and always present in output.

Scope Levels and Precedence

Customize captured fields resolves scope from most specific to least specific, with more specific scopes overriding broader ones:

  • Trading Party Specific (both parties) — Applies to documents associated with a specific pair of trading parties (Party A and Party B). Most specific match. Highest priority.

  • Trading Party Specific (single party) — Applies to documents associated with a single specific trading party (Party A or Party B). Overrides Organization, Country, and Global.

  • Organization Specific — Applies to documents associated with a specific organization. Overrides Country and Global.

  • Country Specific — Applies to documents associated with a specific country. Overrides Global.

  • Global — Applies to all documents of a given type. Acts as the default baseline. Lowest priority.

Priority order: Trading Party (both parties) → Trading Party (single party) → Organization → Country → Global

Multi-Organization Customizations

A single customization can be applied to multiple organizations simultaneously using a multi-select dropdown. This is useful for applying identical field visibility rules across several organizations without duplicating configuration.

Duplicate Protection

The system prevents conflicting configurations by blocking duplicate customizations for the same combination of Document Type + Scope + Target. If a configuration already exists for that combination, the existing one must be edited rather than creating a new entry.

Access Control

  • Admin users: Can create, edit, and delete customizations at all scope levels (Global, Country, Organization, Trading Party)

  • Custom users (with access): Can manage customizations at Organization and Trading Party scope only. Global and Country scopes are not visible to Custom users.


Supported Configurations and Options

Configuration

Detail

Disabling levels

Section-level (entire section), Field-level (specific fields within a section)

Scope levels

Global, Country, Organization, Trading Party

Document type scoping

Each customization applies to a specific document type

Multi-organization support

Apply one customization to multiple organizations

Mandatory sections

Primary Party and Secondary Party sections cannot be disabled

Duplicate prevention

Enforced per Document Type + Scope + Target combination


Other Technical Specifications

Parameter

Detail

Field type

Predefined system fields only (not custom fields)

Enforcement

Backend-level — affects API responses, UI rendering, and export payloads

Destructiveness

Non-destructive — disabling does not delete data or alter extraction

Audit logging

All create, update, and delete actions are logged with user, timestamp, scope, target, and affected fields

Access control

Role-based: Admin (all scopes), Custom with access (Organization and Trading Party only)


Notes

  • Customize captured fields applies to predefined system fields only — custom fields added through other mechanisms are not managed here.

  • If no customization exists at any scope, Docupath returns the default system field set.

  • If a document has no country association, Country scope cannot apply — the system falls back to Trading Party / Organization / Global.

  • If a document has no organization association, Organization scope cannot apply — the system falls back to Country / Global.

  • Disabling fields that downstream systems require will break export integrations — always validate export payloads after making changes.

  • Data Export Template variables that reference disabled fields resolve to empty values — keep template mappings aligned with field visibility settings.

  • Custom users cannot see or manage Global or Country scope customizations, even if those scopes affect documents they work with.

  • Mandatory fields under the Primary Party and Secondary Party sections cannot be disabled.

Did this answer your question?