<h1 class="title">Website Form Builder</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/website/tree/12.0/website_form_builder"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/website-12-0/website-12-0-website_form_builder"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/186/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module provides websites the feature of adding custom forms in any page.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#installation" id="id1">Installation</a></li> <li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id3">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id6">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id7">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li> <li><a class="reference internal" href="#other-credits" id="id9">Other credits</a></li> <li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id1">Installation</a></h2> <p>Install some other addon that provides <code>website_form</code> support to benefit from this one's features. Hints:</p> <ul class="simple"> <li><code>website_crm</code></li> <li><code>website_form_project</code></li> <li><code>website_hr_recruitment</code></li> <li><code>website_sale</code></li> </ul> <a name="configuration"></a> <h2><a class="toc-backref" href="#id2">Configuration</a></h2> <p>To configure this module, you need to:</p> <ol class="arabic simple"> <li>Have <em>Administration / Settings</em> privileges.</li> <li>Go to <em>Settings &gt; Activate developer mode</em>.</li> <li>Go to <em>Settings &gt; Technical &gt; Database Structure &gt; Models</em>.</li> <li>Search for the model you want to manage website form access for.</li> <li>When you find it, it will have a <em>Website Forms</em> section where you can:<ul> <li>Allow the model to get forms, by checking <em>Allowed to use in forms</em>.</li> <li>Give the model forms a better name in <em>Label for form action</em>.</li> <li>Choose the field where to store custom fields data in <em>Field for custom form data</em>. If you leave this one empty and the model is a mail thread, a new message will be appended with that custom data.</li> </ul> </li> <li>In the <em>Fields</em> tab, there's a new column called <em>Blacklisted in web forms</em>. It's a security feature that forbids form submitters to write to those fields. When you create a new website form, all its model fields are automatically whitelisted for the sake of improving the UX. If you want to have higher control, come back here after creating the form and blacklist any fields you want, although that will only work for custom fields.</li> </ol> <a name="usage"></a> <h2><a class="toc-backref" href="#id3">Usage</a></h2> <p>To use this module, you need to:</p> <ol class="arabic simple"> <li>Go to any of your website pages.</li> <li>Edit it.</li> <li>Drag and drop the <em>Form</em> snippet into the page.</li> <li>Use the snippet overlay to add, edit and remove fields.</li> <li>If you want to set a hidden field, make sure you set a valid default value on it, or users may get hidden errors and they might even be unable to send the form!</li> </ol> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h2> <ul class="simple"> <li>These type of fields will not appear, they are forbidden since they make no sense in this module's context, or a correct implementation would be adding not much value while adding lots of complexity:<ul> <li><code>id</code></li> <li><code>create_uid</code></li> <li><code>create_date</code></li> <li><code>write_uid</code></li> <li><code>write_date</code></li> <li><code>__last_update</code></li> <li>Any <code>one2many</code> fields</li> <li>Any <code>reference</code> fields</li> <li>Any <code>serialized</code> fields</li> <li>Any read-only fields</li> </ul> </li> <li>You should include <a class="reference external" href="https://github.com/odoo/odoo/pull/21628">https://github.com/odoo/odoo/pull/21628</a> in your installation to get a better UX when a user has already sent a form and cannot resend it.</li> <li>To edit any <code>&lt;label&gt;</code> text, you need to click twice. Review the problem once <a class="reference external" href="https://bugzilla.mozilla.org/show_bug.cgi?id=853519">https://bugzilla.mozilla.org/show_bug.cgi?id=853519</a> gets fixed.</li> <li>You cannot edit base fields blacklisted status manually because <a class="reference external" href="https://github.com/OCA/website/pull/402#issuecomment-356930433">Odoo forbids that for security</a>.</li> <li><code>website_form</code> works in unexpected and undocumented ways. If you plan to add support in your addon, <a class="reference external" href="https://github.com/OCA/website/pull/402#discussion_r157441770">this is a good place to start reading</a>.</li> <li>If you add a custom file upload field to a form that creates records in models that have no <code>mail.thread</code> inheritance, your users will be unable to send the form.</li> <li>This module it's incompatible with 'website_form_recaptcha' module.</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id5">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/website/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_form_builder%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id6">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id7">Authors</a></h3> <ul class="simple"> <li>Tecnativa</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id8">Contributors</a></h3> <ul class="simple"> <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>: * Jairo Llopis &lt;<a class="reference external" href="mailto:jairo.llopis&#64;tecnativa.com">jairo.llopis&#64;tecnativa.com</a>&gt; * Alexandre Díaz &lt;<a class="reference external" href="mailto:alexandre.diaz&#64;tecnativa.com">alexandre.diaz&#64;tecnativa.com</a>&gt;</li> </ul> <a name="other-credits"></a> <h3 class="with-subtitle"><a class="toc-backref" href="#id9">Other credits</a></h3> <h3 class="section-subtitle" id="images"><span class="section-subtitle">Images</span></h3> <ul class="simple"> <li><a class="reference external" href="https://openclipart.org/detail/281632/form">https://openclipart.org/detail/281632/form</a></li> <li><a class="reference external" href="https://openclipart.org/detail/224192/simple-grey-small-pencil-icon-white-background">https://openclipart.org/detail/224192/simple-grey-small-pencil-icon-white-background</a></li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id10">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/website/tree/12.0/website_form_builder">OCA/website</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>