Skip to Content

Forms | Components API

by
Odoo

$ 169.23

v 15.0 Third Party 40
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 10402
Technical Name formio_components_api
LicenseOPL-1
Websitehttps://www.novacode.nl
Versions 14.0 15.0 16.0 17.0 18.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 10402
Technical Name formio_components_api
LicenseOPL-1
Websitehttps://www.novacode.nl
Versions 14.0 15.0 16.0 17.0 18.0

Forms | Components API

Frontend / Backend integration, interaction, reactivity and validation with Form Components.

Simple configuration and some Python programming (using APIs) in the Form Builder.

Form Builder: Components API (tab, smartbuttons)

Learn more about the Components API types and the usage below.

Contact us for questions, support and training.

Load API

Prepopulate values into Form (input/field) components like textfields, number, datetime, radio and checkbox inputs, datagrid rows etc.

This basically can set the default form data (component values) and configuration of a Form, by backend (Python) programming and APIs in the Form Builder.

The Python code values key, refers to the component's API Property Name in the Form Builder

(Select component) getData & Domain API

Fetch, filter and load (Odoo) data into a select component's choices/options, by backend (Python) programming and APIs.

Change API

Upon change of an input component, use the Form Builder API (Python Code) to return data and/or configuration to change/update other Form components.

This enables highly reactive and dynamic Forms, through integration by backend (Python) programming and APIs.

The Python code values key, refers to the component's API Property Name in the Form Builder

Validation API

Implement backend/server validations for Forms with Python code, having full API (eg ORM/database) access to implement any validation logic.

Form with errors ...

About the Components API

Some features and examples

API Applies for and when (on event) Description
Load API Upon form load, so one time. Set default form data (component values) and configuration of a form, by Python Code in the Form Builder.
Especially used to prepopulate form components like textfields, radio and checkbox inputs, datagrid rows etc.

Examples:
  • Load customer info. So the form respondent doesn't have to provide all details, which avoids input effort and mistakes.
  • Load data from invoices, eg from a certain period, into a datagrid. A datagrid row represents the invoice with necesary fields (as form components).
  • Load data from shipments from a certain period. Put every invoice as a row in a datagrid.
getData & Domain API Select components with a configured (Odoo) URL endpoint.
Upon click on the select component. 		Fetch, filter and load (Odoo) data into a select component's choices/options.
Which also can be (dynamically) filtered by a Domain API, defined with Python Code in the Form Builder.

Examples, to load into a select component:
  • Countries
  • Products, filtered by anything eg. category, stockable etc.
  • Contacts (partners) from the commercial partner of the logged in portal user.
  • Serial/Lot numbers belonging to the shipments of the commercial partner of the logged in portal user.
Change API Upon change of an input component (textfield, radio, checkox, select, datagrid, etc). Upon change of an input component, use the Form Builder API (Python Code) to return data and/or configuration to change/update other Form components.

Examples:
  • Upon choosing a country (in select component), prefill the country-code of a phonenumber component.
  • Upon choosing a product category (in select component), change the domain API parameters to filter the Product select (component) by the choosen category.
  • Upon providing a year (in textfield or select component), load all invoices from that year in a datagrid component (as invoice per row).
Validation API Provides backend (server) validation on form submission for input components, which shows the errors in the form. Implement backend/server validations for Forms with Python code, having full ORM (database) access to implement any validation logic.
By purchasing this module you support the Forms project.
One License is permitted per customer project. 
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.