[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)[Frappe](/kb/frappe/)Quick Entry Forms

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

FrappeQuick Entry Forms

Build custom Quick Entry dialogs that create several linked documents from a single form.

UpdatedMar 13, 2026

Tagsfrappejavascriptdialogclient-side

Reading time3 min

On this page[Basic Pattern](#basic-pattern)[Registration](#registration)[Adding Custom Fields](#adding-custom-fields)[Multi-Document Creation](#multi-document-creation)[Alias Field Mapping](#alias-field-mapping)[Combining Address and Contact Entry](#combining-address-and-contact-entry)[Key Design Decisions](#key-design-decisions)

Custom Quick Entry dialogs provide efficient data entry that can create multiple linked documents in a single form submission.

## Basic Pattern

Extend `frappe.ui.form.QuickEntryForm` to add custom fields and behavior:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.ui.form.MyQuickEntryForm </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">MyQuickEntryForm</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">extends</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    frappe.ui.form.QuickEntryForm</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">constructor</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">doctype</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">after_insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">init_callback</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">doc</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">force</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">super</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(doctype, after_insert, init_callback, doc, force);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.skip_redirect_on_error </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;  </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Keep dialog open on failure</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">render_dialog</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Add custom fields before rendering</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.mandatory </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.mandatory.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">concat</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_variant_fields</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">());</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">super</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">render_dialog</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_variant_fields</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Custom fields added to the quick entry dialog</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        ];</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">};</span>
```

## Registration

Wire the custom form to a doctype's list view via `frappe.listview_settings`:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.listview_settings[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">] </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    hide_name_column: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    hide_name_filter: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    quick_entry: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    quick_entry_doc: frappe.ui.form.PlayerQuickEntryForm,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">};</span>
```

**File location:**`<doctype_name>_list.js` alongside the DocType definition. Frappe automatically loads these for list views.

## Adding Custom Fields

The `get_variant_fields()` method returns field definitions using the same schema as DocType fields:

```
<span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_variant_fields</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Create New Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Check"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family Details"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            depends_on: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"eval:doc.create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family Name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"family_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            mandatory_depends_on: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"eval:doc.create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Existing Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            depends_on: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"eval:!doc.create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            mandatory_depends_on: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"eval:!doc.create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Guardian Contact"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            depends_on: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"eval:doc.create_new_family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Email"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"email_address"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Email"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Phone"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"phone"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Phone"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ];</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

Key field properties:

**`depends_on`** — Conditional visibility using `eval:` expressions

**`mandatory_depends_on`** — Conditional mandatory requirement

**`options: "Email"` / `options: "Phone"`** — Built-in validation for Data fields

## Multi-Document Creation

Override `insert()` to create linked documents before the main document:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">async </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.create_new_family) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">create_family</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">super</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">async </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">create_family</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">doc</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc;</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// 1. Create the Family</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">family</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        doctype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        family_name: doc.family_name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// 2. Create a Contact for the guardian</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">contact</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        doctype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Contact"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        first_name: doc.first_name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        last_name: doc.last_name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        email_ids: [{ email_id: doc.email_address, is_primary: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> }],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        phone_nos: [{ phone: doc.phone, is_primary_mobile_no: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> }],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// 3. Add guardian to the family</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        doctype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family Guardian"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parent: family.name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parenttype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parentfield: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"guardians"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        guardian: contact.name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// 4. Set the family on the main document</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.family </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> family.name;</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// 5. Clean up temporary fields</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">delete</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.family_name;</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">delete</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.email_address;</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">delete</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.phone;</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">delete</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc.create_new_family;</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

## Alias Field Mapping

When the target doctype has readonly fields that would be hidden in dialogs, use alias fieldnames and remap them before insertion:

```
<span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">map_field_names</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        email_address: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"email_id"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,       </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// email_id is readonly on Contact</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        mobile_number: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"mobile_no"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,      </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// mobile_no is readonly on Contact</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        map_to_first_name: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"first_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        map_to_last_name: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"last_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    };</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    Object.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">entries</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(map_field_names).</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">forEach</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(([</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">alias</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">real</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc[real] </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc[alias];</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">delete</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">this</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.dialog.doc[alias];</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">super</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">insert</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

This lets users fill in `email_address` (which is visible and editable) instead of `email_id` (which Frappe hides because it's readonly).

## Combining Address and Contact Entry

A common pattern merges two linked doctypes into one quick entry:

```
<span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_variant_fields</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Contact fields</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Contact Details"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"First Name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"map_to_first_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Last Name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"map_to_last_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Email"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"email_address"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Email"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Phone"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"mobile_number"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Phone"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Address fields</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Address Details"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Address Line 1"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"address_line1"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"City"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"city"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"State"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"state"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Country"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"country"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Country"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        { label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"ZIP Code"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">), fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"pincode"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ];</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

## Key Design Decisions

| Decision                      | Approach                                                                         |
| ----------------------------- | -------------------------------------------------------------------------------- |
| Keep dialog open on error     | `this.skip_redirect_on_error = true` in constructor                              |
| Add fields before rendering   | Modify `this.mandatory` in `render_dialog()` before `super.render_dialog()`      |
| Conditional field visibility  | Use `depends_on: "eval:doc.field_name"`                                          |
| Create linked docs            | Override `insert()`, create via `frappe.db.insert()`, then call `super.insert()` |
| Handle readonly target fields | Use alias fieldnames + remap in `insert()`                                       |
| Clean up temp fields          | `delete this.dialog.doc.temp_field` before `super.insert()`                      |

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

[← PreviousQuery Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Next →Script Reports](/kb/frappe/script-reports/)

CC0This article is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Basic Pattern](#basic-pattern)
- [Registration](#registration)
- [Adding Custom Fields](#adding-custom-fields)
- [Multi-Document Creation](#multi-document-creation)
- [Alias Field Mapping](#alias-field-mapping)
- [Combining Address and Contact Entry](#combining-address-and-contact-entry)
- [Key Design Decisions](#key-design-decisions)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
