Web Form
Web Forms provide an easy way to collect information from users through your website with minimal configuration. Submitted data is automatically stored as records in the selected DocType.
A Web Form can be configured as:
- A public form that anyone can access.
- A form that requires users to log in.
- A private form accessible only through secure request links.
Web Forms are ideal for registrations, contact forms, surveys, customer requests, applications, and other data collection workflows.
How to Create a Web Form
To create a Web Form, search for New Web Form using the Awesome Bar.
- Enter a Title.
- Select the DocType where submitted records will be stored.
- Optionally enter an introduction for the form.
- Click Get Fields to automatically import fields from the selected DocType, or manually choose the required fields.
- Enable Published.
- Save the Web Form.
Each form submission creates a new record in the selected DocType.
Configuring Form Fields
After selecting a DocType, you can choose which fields should appear on the Web Form.
You can either:
- Automatically import all available fields using Get Fields.
- Select only the fields required for your form.
Include only the fields users need to complete. Keeping forms concise generally improves submission rates.
Standard Web Forms
Enabling the Is Standard option creates a standard Web Form that can be distributed as part of a custom application.
When this option is enabled, Frappe creates a dedicated folder inside the selected module containing:
.pyfile for server-side logic..jsfile for client-side customization.
These files should be committed to your version control system so the Web Form can be installed on other sites along with your application.
The Is Standard option is visible only when Developer Mode is enabled.
Standard Web Forms are best suited for reusable applications that need to be deployed across multiple Frappe sites.
Additional Resources
After creating a Web Form, you can further enhance its functionality by customizing its appearance, behavior, and access permissions, including support for private request-based forms.