diff --git a/foundation/www/docs/assets/img/website/disallow_desk_access.png b/foundation/www/docs/assets/img/website/disallow_desk_access.png new file mode 100644 index 00000000..91fb04bc Binary files /dev/null and b/foundation/www/docs/assets/img/website/disallow_desk_access.png differ diff --git a/foundation/www/docs/assets/img/website/sidebar.png b/foundation/www/docs/assets/img/website/sidebar.png new file mode 100644 index 00000000..6adef60a Binary files /dev/null and b/foundation/www/docs/assets/img/website/sidebar.png differ diff --git a/foundation/www/docs/assets/img/website/success_message.png b/foundation/www/docs/assets/img/website/success_message.png new file mode 100644 index 00000000..f4363de5 Binary files /dev/null and b/foundation/www/docs/assets/img/website/success_message.png differ diff --git a/foundation/www/docs/assets/img/website/webform_introduction.png b/foundation/www/docs/assets/img/website/webform_introduction.png new file mode 100644 index 00000000..b2602c4f Binary files /dev/null and b/foundation/www/docs/assets/img/website/webform_introduction.png differ diff --git a/foundation/www/docs/user/manual/en/website/web-form.md b/foundation/www/docs/user/manual/en/website/web-form.md index 1a6cc37c..fc900edf 100755 --- a/foundation/www/docs/user/manual/en/website/web-form.md +++ b/foundation/www/docs/user/manual/en/website/web-form.md @@ -1,12 +1,10 @@ # Web Forms -Portal Views are viewed by external users, but the community that interacts with the organization, but is not a part of the organization. These are customers, suppliers, job applicants, or students, guardians etc. +> Context: There two types of in-built interfaces available in ERPNext. The 'Desk View' and the 'Web View'. Desk view is for users who regularly interact with ERPNext instance, like employees. It is feature rich and needs a bit of familiarisation. 'Web View' is for users who need to interact with ERPNext instance occasionally. Webforms are similar to the forms you generally fill in various websites on internet. Webforms are part of 'Web View' interface in ERPNext. -The standardized way these users can add or edit records is called "Web Forms". +Stakeholders who are not part of your organisation may need to interact with your ERPNext instance. You can authorise customers, suppliers, job applicants, students, and guardians to access certain information or even create certain transactions. For example, you can let anyone create an account on your website (created with ERPNext) and apply for job. You can let your customers see the details of complaints they have registered. -You can add Web Forms to your ERPNext website that will allow addition/updation of new records for the external users. - -You can add forms in your website for example, Contact Us, Inquiry, Complaint and other forms as per your requirement. Following is the help on adding new Web Form on ERPNext. +This can be done using the Webforms. ### Creating Web Form @@ -14,55 +12,92 @@ To create a new **Web Form** go to: > Website > Web Form > New -1. Set the Web Form title and url. -1. Select the **DocType** in which you want the user to store the records. -1. Select if you require the user to login, edit records, manage multiple records etc. -1. Add the fields you want in the record. +1. Add appropriate 'Title'. +1. 'Route' is set automatically based on the title. You can change it if required. +1. Select the **DocType** in which you want the data filled by user needs to be stored. +1. Select the 'Module' to which this webform belongs. +1. Check 'Published' once your webform is complete and ready to be accessed. +1. Check 'Login Required' if the web form has to be accessible to only those users who have an account and are logged in. +1. Check 'Allow Edit' to make the web form editable, if you leave it unchecked the forms become read-only once it is saved. +1. Check 'Show as Grid' if the data should be displayed in a table format. +1. Check 'Allow Delete' if the user can delete the webforms that he/she has created. +1. Check 'Allow Print' if the user can take a print out. +1. Select the applicable 'Print Format'. +1. Check 'Allow Comments' checkbox if user can add comments. +1. Check 'Allow Incomplete Forms' if user is allowed to save the webforms with partial data. +1. Finally add the fields from DocType in 'Fields Table'. + + +### Introduction + +You can add a small text here to set the context for the web form. + +Web Form Introduction + +### Fields in Web Form + +You can only select the fields available in the DocType. You cannot create new fields directly in the webform. + +You can click on 'Get Fields' button on the top to add all fields in the DocType to the web form. Web Form Entry --- +Once you create the web form, you can view it on the URL(Route) and test it out! -## Web Form View +### Creating Web Forms with Child Table -### Form with Child Table - -Once you create the web form, you can view it on the url and test it out! You can add child tables to your web forms, just like regular forms +You can add child tables to your web forms, just like regular forms. Web form Grid ### Pagination -To help your users fill out long new forms, you can insert page breaks that will appear on new sections. This way the user can focus on only filling one section at a time. +To help your users fill out long new forms, you can insert page breaks that will appear on new sections. This way the user to focus on only filling one section at a time. Web form paging +### Sidebar Settings + +Check 'Show Sidebar' if the sidebar needs to be displayed along with the web form. + +And add the links to be shown in the sidebar of the web form by adding the details in the table. + +Sidebar + ### Payment Gateway Integration -You can now add a Payment Gateway to the web form, so that you can ask users to pay against a web form. A good example for this is a conference ticket :) +You can now add a Payment Gateway to the web form, so that you can ask users to pay against a web form. A good example for this is a conference ticket :) Web form payment ### Portal User -We have also introduced roles for Website users. Now the for each standard Role you can optionally disallow "Desk Access" to that user. +We have also introduced roles for Website users. Before version 11, if you assigned any 'Role' to a user he would get access to 'Desk View'. From version 11 you can assign a 'Role' but still disallow access to 'Desk View' by unchecking 'Desk Access' in Role. -In Portal Settings, you can set a role against each menu item so that only users with that role will be allowed to see that item. +Disallow Desk Access + +In Portal Settings, you can set a role against each menu item so that only users with that role will be allowed to see that item. portal settings ---- +### Custom Script -### Results +You can write code in javascript to implement custom logic and set the URL to the webpage to which the user must be redirected after successful submission of webform. -When website user submits the form, the data will be stored in the document/doctype for which web form is creaeted. +### Actions + +You can add the text in 'Success Message' field and this text will be shown to user once he successfully submits the web form . And the user is redirected to the URL given at 'Success URL' when clicked on 'Continue' button. This is only applicable to webforms accessible without the user login(webforms with 'Login Required' checkbox unchecked). + +Success Message + + +### Result + +When website user submits the form, the data will be stored in the document/doctype for which web form is created. ### Customizing -For customizing web forms, see the [Frappe Documentation of Web Forms](https://frappe.io/docs/user/en/guides/portal-development/web-forms) +For customising web forms, see the [Frappe Documentation of Web Forms](https://frappe.io/docs/user/en/guides/portal-development/web-forms) -### Customizing - -For customizing web forms, see the [Frappe Documentation of Web Forms](https://frappe.io/docs/user/en/guides/portal-development/web-forms) {next}