Custom Field

Edit Page New Page Revisions

Custom Field

In ERPNext, a standard set of fields is present on every form. You can add a custom field to a form as needed if you need to collect information but there isn't a standard field for it.

The Field in a specific Form or a Document type (hereinafter referred to as DocType) can be added by going to Customize Form.

Go to: to access Custom Field.

Home > Customization > Form Customization > Custom Field

Moreover, you can access any DocType's list view and choose Customize from the menu options.

1. How to create a Custom Field

  1. Click New from the Custom Field list.

  2. Document: Choose the document to which the custom field must be added.

  3. Label: Type the label you want to assign to your custom field here.

  4. Field Type: A list of pre-defined Field Types for ERPNext can be retrieved from this drop-down menu. From this menu, you can choose the type of your custom field.

  5. Refresh.

Get more information on field kinds here.

Moreover, you can add, change, or remove a Field from a specific Form by going to Customize Form.

1.1. Additional Details

  1. Options: This field is used when you wish to specify or be more detailed with your data. E.g., when you have set the Field to be a 'Select Field', you would be needed to provide the selection alternatives here.
  2. If you want your custom field to be a "Link Field," you must specify the form to which it will be linked in the fetch from field. For instance, you want to add a Custom Field called "Project" to the DocType "Item". To ensure that the Field is updated with the list of all the necessary DocTypes, you must enter "Project" in the Fetch From Field and "Link" as the Field Type.
  3. Fetch If Empty: Checking this box will prevent this Field from being overwritten if a value already exists based on Fetch From.
  4. Insert the field's default value here if you wish it to be retrieved for this field.
  5. Depends On: Here, you can provide a need for the Field's presentation. For instance, the two fields "Asset Category" and "Asset Name Series" in the DocType Item will only be seen if the Field "Is Fixed Asset" is checked. Is fixed asset would be the dependency condition in this case.
  6. Field Description:Here, you may add a description for the field that will be shown beneath this one.
  7. You can determine which roles within your organization will have the ability to change this Field by setting the permission level. Role Based Permissions can help you better comprehend this.
  8. The Field will be present in the popup that displays when a user hovers over a link for a particular document type in the preview if Show Preview Popup for the document type is checked (in list view and other link fields).
  9. When displaying the Form in a Grid View, this setting will specify the width allotted to this Field.

1.2. More Properties

  • Is Required Field: If you want to make this Field mandatory when submitting a DocType, click this box.

  • When you want the value of this Field to be unique, use the Unique checkbox.

  • If the Custom Field asks for a code or identification number, this can be done. For instance, the item code for an item and the GST number for a customer.

  • When you want this field to be read-only or not editable, set it to read-only. In this scenario, the Field's value must be automatically obtained from other fields.

  • When you wish a field to be buried or to cover over another field, check this box.

  • When you want the print button to be concealed from the Print Format, use Print Hidden. For further information, see Checkout Fields in Print Format.

  • No Copy: Ticking this box prevents other fields in the DocType from being copied.

  • Allow on Submit: This lets you edit the Field even after you've sent the form out. For further details, see Modifying Value in Submitted Document.

  • In List View: This will make the field visible in the List View of the DocType. Standard Filter: The field will be added as a standard filter to the Document's List view.

  • When this box is checked, the Global Search will be able to search this Field.

  • Bold: By making this Field type bold, you are giving the Field extra value.

  • Report Hide: If you tick this box, the report will not display this field.

  • Ignore XSS Filter: You can view this Field without the HTML tags by selecting this option.

  • When this checkbox is selected, it becomes translateable when Custom Translations are used on this.

Previous Page

Left

Next Page

Right