Custom Field
How to use Custom Field in Customization: access, working steps, fields, related records and troubleshooting.
Purpose and access
Use Customize Form and Custom Field for supported record extensions. Choose an appropriate field type, label, identifier and placement. Test required, unique and link behavior in staging, and check impact on reports, imports and APIs.
This page is a record page in System Admin → Customization. Use the link above to open the configured destination; permissions are checked by the destination service.
Before you start
Prepare the required information: DocType, Field Type.
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 Custom Field from System Admin → Customization, 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.
- 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 |
|---|---|---|
Is System Generatedis_system_generated | Check Optional · Read-only | Enable or disable the named option only when it matches the intended record behavior. |
DocTypedt | 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 |
Module (for export)module | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Module Def |
Labellabel | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Placeholderplaceholder | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Fieldnamefieldname | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Insert Afterinsert_after | Select Optional | Select the label after which you want to insert new field. |
Lengthlength | Int Optional | Enter a whole-number value. |
Filterslink_filters | JSON Optional | Filters applied to Link queries and Attachment Gallery files. |
Field Typefieldtype | Select Required | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Button Colorbutton_color | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Precisionprecision | Select Optional | Set non-standard precision for a Float or Currency fieldAvailable choices
|
Hide Secondshide_seconds | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hide Dayshide_days | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Optionsoptions | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Sort Optionssort_options | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Fetch Fromfetch_from | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Fetch on Save if Emptyfetch_if_empty | Check Optional | If unchecked, the value will always be re-fetched on save. |
Collapsiblecollapsible | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Collapsible Depends Oncollapsible_depends_on | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Default Valuedefault | Text Optional | Provide the required record description or content. Keep operational instructions clear and applicable. |
Depends Ondepends_on | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Mandatory Depends Onmandatory_depends_on | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Read Only Depends Onread_only_depends_on | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Non Negativenon_negative | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Is Mandatory Fieldreqd | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Uniqueunique | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Is Virtualis_virtual | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Read Onlyread_only | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Maskmask | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Ignore User Permissionsignore_user_permissions | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hiddenhidden | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Print Hideprint_hide | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Print Hide If No Valueprint_hide_if_no_value | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Alignmentalignment | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
No Copyno_copy | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Set only onceset_only_once | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow on Submitallow_on_submit | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
In List Viewin_list_view | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
In Standard Filterin_standard_filter | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
In Global Searchin_global_search | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
In Previewin_preview | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Boldbold | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Report Hidereport_hide | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow in Quick Entryallow_in_quick_entry | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow Bulk Editallow_bulk_edit | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Ignore XSS Filterignore_xss_filter | Check Optional | Don't HTML Encode HTML tags like <script> or just characters like < or >, as they could be intentionally used in this field |
Translatabletranslatable | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hide Borderhide_border | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Show Dashboardshow_dashboard | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Field Descriptiondescription | Text Optional | Provide the required record description or content. Keep operational instructions clear and applicable. |
Permission Levelpermlevel | Int Optional | Enter a whole-number value. |
Widthwidth | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Columnscolumns | Int Optional | Number of columns for a field in a List View or a Grid (Total Columns should be less than 11) |
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.