Field reference
Web Page
How to use Web Page 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.
ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.
Before you start
Prepare the required information: Title.
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 Page 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. |
Dynamic Routedynamic_route | Check Optional | Map route parameters into form variables. Example /project/<name> |
Publishedpublished | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
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 |
Content Typecontent_type | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Slideshowslideshow | 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 Slideshow |
Dynamic Templatedynamic_template | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Main Sectionmain_section | Text Editor Optional | Maintain formatted content for the record; review any public-facing output before publishing. |
Main Section (Markdown)main_section_md | Markdown Editor Optional | Complete the value according to the field label and the record’s validation rules. |
Main Section (HTML)main_section_html | HTML Editor Optional | Complete the value according to the field label and the record’s validation rules. |
Page Building Blockspage_blocks | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Web Page Block |
Context Scriptcontext_script | Code Optional | Set context before rendering a template. Example: context.project = frappe.get_doc("Project", frappe.form_dict.name) |
Javascriptjavascript | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Insert Styleinsert_style | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Text Aligntext_align | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
CSScss | Code Optional | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Full Widthfull_width | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Show Titleshow_title | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Start Datestart_date | Datetime Optional | Record the date and time in the configured system/user time zone. |
End Dateend_date | Datetime Optional | Record the date and time in the configured system/user time zone. |
Titlemeta_title | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Descriptionmeta_description | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Imagemeta_image | Attach Image Optional | Upload an appropriate image in a supported format. Logo and profile images have different purposes and access requirements. |
Show Sidebarshow_sidebar | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Priorityidx | Int Optional | 0 is highest |
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 |
Enable Commentsenable_comments | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Headerheader | HTML Editor Optional | HTML for header section. Optional |
Breadcrumbsbreadcrumbs | Code Optional | List as [{"label": _("Jobs"), "route":"jobs"}] |
Child tables
Page Building Blocks — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Web Templateweb_template | Link Optional | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Web Template |
CSS Classcss_class | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Section IDsection_id | Data Optional | IDs must contain only alphanumeric characters, not contain spaces, and should be unique. |
Add Containeradd_container | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Space at Topadd_top_padding | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Space at Bottomadd_bottom_padding | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Border at Topadd_border_at_top | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Border at Bottomadd_border_at_bottom | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Gray Backgroundadd_shade | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Hide Blockhide_block | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Add Background Imageadd_background_image | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Background Imagebackground_image | Attach Image Optional | Upload an appropriate image in a supported format. Logo and profile images have different purposes and access requirements. |
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.