Web Form
How to use Web Form in Websites & Portals: access, working steps, fields, related records and troubleshooting.
Purpose and access
Maintain published pages, web forms and portal configuration. Keep public content separate from role-restricted ERP data. Test logged-out access and the correct linked stakeholder account before release.
This page is a record page in System Admin → Websites & Portals. Use the link above to open the configured destination; permissions are checked by the destination service.
Before you start
Prepare the required information: Title, Select DocType.
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 Web Form from System Admin → Websites & Portals, 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.
- Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
- 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 |
|---|---|---|
Titletitle | Data Required | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Routeroute | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Select DocTypedoc_type | 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 |
Modulemodule | 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 |
Is standardis_standard | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Introductionintroduction_text | Text Editor Optional | Maintain formatted content for the record; review any public-facing output before publishing. |
Web Form Fieldsweb_form_fields | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Web Form Field |
Key requiredkey_required | Check Optional | If enabled, the web form can only be used with a Key from a corresponding Web Form Request . |
Anonymous responsesanonymous | Check Optional | If enabled, all responses on the web form will be submitted anonymously |
Login requiredlogin_required | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Apply document permissionsapply_document_permissions | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow editing after submitallow_edit | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow multiple responsesallow_multiple | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow deleteallow_delete | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow incomplete formsallow_incomplete | Check Optional | Allow saving if mandatory fields are not filled |
Allow commentsallow_comments | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allow printallow_print | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Print Formatprint_format | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Print Format |
Max attachment sizemax_attachment_size | Int Optional | Set size in MB |
Show attachmentsshow_attachments | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hide navbarhide_navbar | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hide footerhide_footer | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Allowed embedding domainsallowed_embedding_domains | Small Text Optional | Specify the domains or origins that are permitted to embed this form. Enter one domain per line (e.g., https://example.com). If no domains are specified, the form can only be embedded on the same origin. |
Condition JSONcondition_json | JSON Optional | Structured data field. Preserve the required object format and validate it before using it in an integration. |
Show listshow_list | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Titlelist_title | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
List Columnslist_columns | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Web Form List Column |
Show sidebarshow_sidebar | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Website Sidebarwebsite_sidebar | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Website Sidebar |
Submit button labelbutton_label | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Banner Imagebanner_image | Attach Image Optional | Upload an appropriate image in a supported format. Logo and profile images have different purposes and access requirements. |
Breadcrumbsbreadcrumbs | Code Optional | List as [{"label": _("Jobs"), "route":"jobs"}] |
Success titlesuccess_title | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Success URLsuccess_url | Data Optional | Go to this URL after completing the form |
Success messagesuccess_message | Text Optional | Message to be displayed on successful completion |
Meta titlemeta_title | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Meta descriptionmeta_description | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Meta imagemeta_image | Attach Image Optional | Upload an appropriate image in a supported format. Logo and profile images have different purposes and access requirements. |
Client scriptclient_script | Code Optional | For help see Client Script API and Examples |
Custom CSScustom_css | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Child tables
Web Form Fields — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Fieldfieldname | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow. |
Fieldtypefieldtype | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Custom Labellabel | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Allow Read On All Link Optionsallow_read_on_all_link_options | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Mandatoryreqd | 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. |
Show in filtershow_in_filter | 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. |
Optionsoptions | Text Optional | Provide the required record description or content. Keep operational instructions clear and applicable. |
Max Lengthmax_length | Int Optional | Enter a whole-number value. |
Max Valuemax_value | Int Optional | Enter a whole-number value. |
Precisionprecision | Select Optional | Set non-standard precision for a Float or Currency fieldAvailable choices
|
Display 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. |
Descriptiondescription | Text Optional | Provide the required record description or content. Keep operational instructions clear and applicable. |
Defaultdefault | 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. |
List Columns — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Fieldfieldname | Select Required | Choose one of the configured list values. Status fields may be controlled by the record workflow. |
Fieldtypefieldtype | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Custom Labellabel | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Optionsoptions | Text Optional | Provide the required record description or content. Keep operational instructions clear and applicable. |
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.