Field reference

DocType

How to use DocType in Platform Settings: access, working steps, fields, related records and troubleshooting.

System AdminUpdated 12 October 2026Configuration-aware guidance

Purpose and access

Review platform defaults and dependencies within the administrator’s authority. Record the reason and tested impact of changes. Authentication, session settings and security-sensitive configuration need a controlled change process.

This page is a internal/admin record in System Admin → Platform Settings. Use the link above to open the configured destination; permissions are checked by the destination service.

ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.

Before you start

Prepare the required information: Module.

Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.

Working steps

Open DocType from System Admin → Platform Settings, or use ERP Search.
Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
Save the record and address validation messages. Reload and verify the saved values and relationships.
Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.

Field reference

These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.

Field	Type / behavior	How to use it
Permissions`permissions`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: DocPerm
Restrict To Domain`restrict_to_domain`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Domain
User Cannot Search`read_only`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
User Cannot Create`in_create`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Protect Attached Files`protect_attached_files`	Check Optional	Users are only able to delete attached files if the document is either in draft or if the document is canceled and they are also able to delete the document.
Naming Rule`naming_rule`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Set by user Autoincrement By fieldname By "Naming Series" field Expression Expression (old style) Random UUID By script
Auto Name`autoname`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Title Field`title_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Allow Rename`allow_rename`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Module`module`	Link Required	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Module Def
Is Submittable`is_submittable`	Check Optional	Once submitted, submittable documents cannot be changed. They can only be Cancelled and Amended.
Is Child Table`istable`	Check Optional	Child Tables are shown as a Grid in other DocTypes
Is Single`issingle`	Check Optional	Single Types have only one record no tables associated. Values are stored in tabSingles
Is Tree`is_tree`	Check Optional	Tree structures are implemented using Nested Set
Is Calendar and Gantt`is_calendar_and_gantt`	Check Optional	Enables Calendar and Gantt views.
Editable Grid`editable_grid`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Quick Entry`quick_entry`	Check Optional	Open a dialog with mandatory fields to create a new record quickly. There must be at least one mandatory field to show in dialog.
Grid Page Length`grid_page_length`	Int Optional	Enter a whole-number value.
Rows Threshold for Grid Search`rows_threshold_for_grid_search`	Int Optional	Enter a whole-number value.
Allow Bulk Edit`allow_bulk_edit`	Check Optional	Enable bulk update of this field across child table rows.
Track Changes`track_changes`	Check Optional	If enabled, changes to the document are tracked and shown in timeline
Track Seen`track_seen`	Check Optional	If enabled, the document is marked as seen, the first time a user opens it
Track Views`track_views`	Check Optional	If enabled, document views are tracked, this can happen multiple times
Custom?`custom`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Beta`beta`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Is Virtual`is_virtual`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Queue in Background (BETA)`queue_in_background`	Check Optional	Enabling this will submit documents in background
Description`description`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Image Field`image_field`	Data Optional	Must be of type "Attach Image"
Timeline Field`timeline_field`	Data Optional	Comments and Communications will be associated with this linked document
Parent Field (Tree)`nsm_parent_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Max Attachments`max_attachments`	Int Optional	Enter a whole-number value.
Documentation Link`documentation`	Data Optional	URL for documentation or help
Hide Sidebar, Menu, and Comments`hide_toolbar`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Hide Copy`allow_copy`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow Import (via Data Import Tool)`allow_import`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow events in timeline`allow_events_in_timeline`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow Auto Repeat`allow_auto_repeat`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Make Attachments Public by Default`make_attachments_public`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Show Title in Link Fields`show_title_field_in_link`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Translate Link Fields`translated_doctype`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Search Fields`search_fields`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Default Print Format`default_print_format`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Default Sort Field`sort_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Default Sort Order`sort_order`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices ASC DESC
Default View`default_view`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow.
Force Re-route to Default View`force_re_route_to_default_view`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Show in Module Section`document_type`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Document Setup System Other
Icon`icon`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Color`color`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Show Preview Popup`show_preview_popup`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Make "name" searchable in Global Search`show_name_in_global_search`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Default Email Template`default_email_template`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Email Template
Allow document creation via Email`email_append_to`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Sender Email Field`sender_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Sender Name Field`sender_name_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Recipient Account Field`recipient_account_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Subject Field`subject_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Fields`fields`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: DocField
Document Actions`actions`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: DocType Action
Document Links`links`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: DocType Link
Document States`states`	Table Optional	Add the relevant child rows and review required columns, quantities and references before saving. Linked record: DocType State
Has Web View`has_web_view`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow Guest to View`allow_guest_to_view`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Index Web Pages for Search`index_web_pages_for_search`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Route`route`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Is Published Field`is_published_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Website Search Field`website_search_field`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Database Engine`engine`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices InnoDB MyISAM

Child tables

Permissions — child-row fields

Field	Type / behavior	How to use it
Role`role`	Link Required	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Role
If user is the owner`if_owner`	Check Optional	Apply this rule if the User is the Owner
Level`permlevel`	Int Optional	Enter a whole-number value.
Select`select`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Read`read`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Write`write`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Create`create`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Delete`delete`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Submit`submit`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Cancel`cancel`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Amend`amend`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Mask`mask`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Report`report`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Export`export`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Import`import`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Share`share`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Print`print`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Email`email`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Impersonate`impersonate`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.

Fields — child-row fields

Field	Type / behavior	How to use it
Label`label`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Type`fieldtype`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Autocomplete Attach Attach Image Attachment Gallery Barcode Button Check Code Color Column Break Currency Data Date Datetime Duration Dynamic Link Float Fold Geolocation Heading HTML HTML Editor Icon Image Int JSON Link Long Text Markdown Editor Password Percent Phone Read Only Rating Section Break Select Signature Small Text Tab Break Table Table MultiSelect Text Text Editor Time
Name`fieldname`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Length`length`	Int Optional	Enter a whole-number value.
Precision`precision`	Select Optional	Set non-standard precision for a Float, Currency or Percent field Available choices 0 1 2 3 4 5 6 7 8 9
Non Negative`non_negative`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Hide Days`hide_days`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Hide Seconds`hide_seconds`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Mandatory`reqd`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Virtual`is_virtual`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Index`search_index`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Not Nullable`not_nullable`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Mask`mask`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Options`options`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Sort Options`sort_options`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Show Dashboard`show_dashboard`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Filters`link_filters`	JSON Optional	Filters applied to Link queries and Attachment Gallery files.
Default`default`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Fetch From`fetch_from`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Fetch on Save if Empty`fetch_if_empty`	Check Optional	If unchecked, the value will always be re-fetched on save.
Button Color`button_color`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Default Primary Info Success Warning Danger
Hidden`hidden`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Show on Timeline`show_on_timeline`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Bold`bold`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow in Quick Entry`allow_in_quick_entry`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Translatable`translatable`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Print Hide`print_hide`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Print Hide If No Value`print_hide_if_no_value`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Report Hide`report_hide`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Display Depends On (JS)`depends_on`	Code Optional	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Collapsible`collapsible`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Collapsible Depends On (JS)`collapsible_depends_on`	Code Optional	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Hide Border`hide_border`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
In List View`in_list_view`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
In Standard Filter`in_standard_filter`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
In Preview`in_preview`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Sticky`sticky`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
In Filter`in_filter`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
In Global Search`in_global_search`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Read Only`read_only`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow on Submit`allow_on_submit`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Ignore User Permissions`ignore_user_permissions`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Allow Bulk Edit`allow_bulk_edit`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Make Attachment Public (by default)`make_attachment_public`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Perm Level`permlevel`	Int Optional	Enter a whole-number value.
Ignore XSS Filter`ignore_xss_filter`	Check Optional	Don't encode HTML tags like <script> or just characters like < or >, as they could be intentionally used in this field
Unique`unique`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
No Copy`no_copy`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Set only once`set_only_once`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Remember Last Selected Value`remember_last_selected_value`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Mandatory Depends On (JS)`mandatory_depends_on`	Code Optional	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Read Only Depends On (JS)`read_only_depends_on`	Code Optional	Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment.
Alignment`alignment`	Select Optional	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Left Center Right
Print Width`print_width`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Width`width`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Max Height`max_height`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Columns`columns`	Int Optional	Number of columns for a field in a List View or a Grid (Total Columns should be less than 11)
Description`description`	Small Text Optional	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Documentation URL`documentation_url`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Placeholder`placeholder`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Show Description on Click`show_description_on_click`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.

Document Actions — child-row fields

Field	Type / behavior	How to use it
Label`label`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Action Type`action_type`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Server Action Route
Action / Route`action`	Small Text Required	Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Group`group`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Hidden`hidden`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.

Document Links — child-row fields

Field	Type / behavior	How to use it
Link DocType`link_doctype`	Link Required	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType
Link Fieldname`link_fieldname`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Parent DocType`parent_doctype`	Link Optional	Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType
Table Fieldname`table_fieldname`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Group`group`	Data Optional	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Hidden`hidden`	Check Optional	Enable or disable the named option only when it matches the intended record behavior.
Is Child Table`is_child_table`	Check Optional · Read-only	Enable or disable the named option only when it matches the intended record behavior.

Document States — child-row fields

Field	Type / behavior	How to use it
Title`title`	Data Required	Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Color`color`	Select Required	Choose one of the configured list values. Status fields may be controlled by the record workflow. Available choices Blue Cyan Gray Green Light Blue Orange Pink Purple Red Yellow

Troubleshooting

Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.

Was this useful?

DocType

Purpose and access

Before you start

Working steps

Field reference

Child tables

Troubleshooting

Related pages