Knowledge Base

Custom Field

  • 67views
  • February 7, 2024

Custom Field

Each form within BizCentric adheres to a standard set of fields. However, if you need to record specific information for which there is no standard field available, you can incorporate a Custom Field into the form to suit your needs.

You can go to Customize Form and add the Field in a particular Form or a Document type (hereafter referred to as DocType).

To access Custom Field, go to:

> Home > Customization > Form Customization > Custom Field

You can also go to the list view of any DocType and select Customize from the Menu options.

1. How to create a Custom Field

  1. Go to the Custom Field list and click on New.
  2. Document: Select the Document in which you need to add the Custom Field.
  3. Label: Enter what Label would you like to give to your Custom Field.
  4. Field Type: BizCentric already has a set of Field Types defined which can be fetched from this drop-down menu. You can select the Type of your Custom Field from within this menu.
  5. Update.

Learn more about Field types here.

You can also go to Customize Form and add, edit or remove a Field in a particular Form.

1.1. Additional Details

  1. Options: This field becomes relevant when you need to specify or narrow down data. For instance, if you choose the field to be a ‘Select Field,’ you would need to input the selection options here.
  2. Fetch From: When you intend for your Custom Field to be a ‘Link Field,’ you must designate the form to which this field is linked. For example, if you wish to create a Custom Field named ‘Project’ in the DocType ‘Item,’ you need to specify the Field Type as ‘Link’ and input ‘Project’ in the Fetch From field to ensure that the field is populated with the list of all the required DocTypes.
  3. Fetch If Empty: Enabling this checkbox ensures that the field will not be overwritten based on Fetch From if a value already exists.
  4. Default Value: Input the default value for the field that you wish to be fetched if no other value is specified.
  5. Depends On: Here, you can define a condition for when the field should be displayed. For instance, in the DocType ‘Item,’ the fields ‘Asset Category’ and ‘Asset Naming Series’ will only appear if the ‘Is Fixed Asset’ field is checked. The dependency condition here would be is_fixed_asset.
  6. Field Description: You can provide a description for the field here, which will be displayed below the field.
  7. Permission Level: This will allow you to specify which roles within your organization will be able to edit this Field. You can go through Role Based Permissions for more understanding on this.
  8. In Preview: If Show Preview Popup for the document type is checked, the Field will be included in the popup that appears on hovering over links of the document type.
  9. Width: This will define the width allocated to this Field while viewing the Form in a Grid View.

1.2. More Properties

  • Is Mandatory Field: This checkbox can be selected if you require this field to be mandatory when submitting a DocType.
  • Unique: Tick this checkbox if you want the value of this field to be unique. This is applicable in scenarios where the Custom Field represents a code or an identification number, such as Item Code for items or GST Number for customers.
  • Read Only: Select this option if you want the field to be read-only or non-editable. In such cases, the field’s value will be automatically fetched from other fields.
  • Hidden: Check this Field when you want this Field to be hidden, or to hide an existing Field.
  • Print Hide: In cases that you want the print button to be hidden from the Print Format. Checkout Fields in Print Format for more information.
  • No Copy: By selecting this option, copying of this field in the DocType will be restricted.
  • Allow on Submit: This option enables you to make changes to the field even after submitting the form.
  • In List View: Enabling this will display the field in the List View of the DocType.
  • In Standard Filter: This setting turns the field into a standard filter in the List view of the Document.
  • In Global Search: Checking this box allows the field to be searchable from the Global Search.
  • Bold: This option renders the field type in bold, adding emphasis to the field.
  • Report Hide: When selected, this field will not be visible in the reports.
  • Ignore XSS Filter: Enabling this option allows you to view this field without the HTML tags.
  • Translatable: When this box is checked, it becomes translatable while applying Custom Translations to this.

1.3 Field name

  • By default, custom fields have a prefix of custom_ added to their field names. This precaution is taken to prevent any possible conflict with current or future standard fields.
  • If your customizations necessitate a particular field name, you have the option to rename any existing custom field by navigating to the Custom Field doctype and selecting the “Rename Fieldname” button.