Custom Form

Before we venture to learn form customization tool, click here to understand the architecture of forms in ERPNext. It shall help you in using Customize Form tool more efficiently.

Customize Form is the tool which allows user to customize property of the standard fields, and insert custom fields as per the requirement. Let's assume we need to set Project Name field as a mandatory field in the Sales Order form. Following are the steps which shall be followed to achieve this.

Step 1: Go to Customize Form

Go to Customize Form from:

Setup >> Customize >> Customize Form

You can also reach the Customize Form tool from the List Views.

Customize Form List

Step 2: Select Document Type

If navigate from the list view, Document Type will be automatically set in the Customize Form.

If you reach customize form from the Setup module, or from awesome bar, then you will have to manually select Document Type in which customization needs to be made.

Customize Form select doctype

Step 3: Edit Property

On selecting Document Type, all the fields of the Document Type will updated as rows in the Customize Form.

To customized Project field, click on the respective row, and check "Mandatory". With this, Project field will become mandatory in the Sales Order.

Customize Form select doctype

Like setting setting field Mandatory, following are the other customization options in the Customize Form tool.

  • Change Field Type.
  • Edit Field Labels to suit your industry/language.
  • Set field precision for the Currency field.
  • To hide field, check Hidden.
  • Customize Options for the Select field.

Step 4: Update

To save your customizations, Update Customize Form.

To have customizations take effect, reload your ERPNext account once.

Other Customizations

From Customize Form, you can also do following customizations:

  • Max Attachment Limit: Define maximum no. of files which can attached on a document.
  • Default Print Format: For one document type, you can have multiple print formats. In the Customize Form, you can also set default Print Format for a document.
  • Set Title Field
  • Sort Field and Sort Order: Define field based on which documents in the list view will be sorted.

Note: Though we want you to do everything you can to customize your ERP based on your business needs, we recommend that you do not make “wild” changes to the forms. This is because, these changes may affect certain operations and may mess up your forms. Make small changes and see its effect before doing some more.

Following are the properties which you can customize for a specific field from Customize Form.

Field property Purpose
Print hide Checking it will hide field from the Standard print format.
Unique For a unique field, same value cannot repeat in another document.
Hidden Checking it field will hide field in the data entry form.
Mandatory Checking it will set field as mandatory.
Field Type Click here to learn about of fields types.
Options Possible result for a drop down fields can be listed here. Also for a link field, relevant Doctype can be provided.
Allow on submit Checking it will let user update value in field even in submitted form.
Default Value defined in default will be pulled on new record creation.
Description Gives field description for users understanding.
Label Label is the field name which appears in form.

Next: Custom Doctype