Customize Form
Customize Form is a tool that allows you to modify existing DocTypes in ERPNext without changing the core application. Using this tool, you can add Custom Fields, modify existing field properties, reorganize the layout, and configure document-level settings to match your organization’s requirements.
Before customizing a form, it is recommended to understand how DocTypes work in ERPNext, since every form is based on a DocType.
To access Customize Form:
Home > Customization > Form Customization > Customize Form
Alternatively, open the List View of any DocType, click Menu, and select Customize.
1. How to Customize a Form
- Open Customize Form.
- Select the DocType you want to customize.
- Once the DocType is selected, all configurable settings and fields become available.
- Make the required changes.
- Click Update to save the customization.
2. Form Customization Options
2.1 Change Label
The Change Label option allows you to rename the display label of standard fields without changing the actual field name stored in the database. This is useful when adapting ERP terminology to suit your organization’s workflow or industry.
For example, you can change the label Customer to Client or Consumer using Custom Translations.
2.2 Title Field
The Title Field determines which Data field is displayed as the document title in list views, search results, and link previews. Choosing an appropriate title field makes records easier to identify.
2.3 Default Print Format
If multiple Print Formats exist for a DocType, you can specify which one should be selected by default whenever the document is printed.
2.4 Image Field
The Image Field specifies which Attach Image field should represent the document. This image is displayed in supported views wherever the document is shown.
2.5 Maximum Attachments
Use this setting to define the maximum number of files that users can attach to documents of the selected DocType.
2.6 Search Fields
Search Fields determine which fields are searched when users look up records through Link fields. Adding commonly used fields improves search accuracy and makes documents easier to locate.
2.7 Sort Field
The Sort Field defines the field used to order records in the List View. For example, records can be sorted by Item Name, Posting Date, or Creation Date.
2.8 Sort Order
Choose whether records should be sorted in Ascending or Descending order based on the selected Sort Field.
2.9 Default Email Template
If multiple Email Templates are available for a DocType, you can choose one as the default template whenever users send emails from that document.
3. Additional Properties
| Property | Description |
|---|---|
| Hide Copy | Disables the Copy option for the selected DocType. |
| Is Table | Marks the DocType as a Child Table that can be embedded inside another document. |
| Quick Entry | Enables Quick Entry so users can create records using only the essential fields. |
| Track Changes | Creates a version history that records all changes made to documents of this DocType. |
| Track Views | Maintains a log of users who have viewed the document. |
| Allow Auto Repeat | Allows documents to be automatically recreated at scheduled intervals using Auto Repeat. |
| Allow Import | Allows records of the selected DocType to be imported using the Data Import Tool. |
| Show Preview Popup | Displays a preview popup when hovering over document links. The popup includes mandatory fields and fields marked as “In Preview”. |
4. Customizing Fields
Customize Form provides a visual interface for managing fields within a DocType.
You can:
- Add new Custom Fields.
- Edit existing fields and their properties.
- Delete custom fields.
- Move fields above or below existing fields.
- Add Section Breaks and Column Breaks to reorganize the form layout.
- Configure field visibility, permissions, mandatory status, default values, and other properties.
These customizations allow you to tailor ERPNext forms to your business processes without modifying the application’s core code.
5. Layout Maintenance Tools
5.1 Trim Table
The Trim Table option removes unused database columns that belong to deleted custom fields. Although a field may have been removed from the form, its corresponding database column still exists until Trim Table is executed.
Running this action helps keep the database clean by permanently deleting unnecessary columns.
5.2 Reset Layout
Reset Layout restores the form’s layout to its default ERPNext arrangement. It removes layout-related customizations such as field positioning, section breaks, and column layouts while retaining the existing fields.
5.3 Reset All Customizations
This option completely removes all customizations made to the selected DocType and restores it to its original ERPNext configuration.
The following customizations are removed:
- Custom Fields
- Modified field properties
- Layout changes
- Custom form settings
Since this action cannot be easily reversed, it should only be used when you want to completely reset the DocType.
