# Form

<figure><img src="/files/egjVvMcN2pW8e958uLBV" alt=""><figcaption></figcaption></figure>

Forms allow the creation of interactive interfaces for data input or dashboard filtering. They can be used to collect user information, apply filters, or trigger data flows — making them a powerful tool for systematizing analytical processes.

***

### **1. Creating a New Form**

<figure><img src="/files/U8rNczSDmMlbyonJaAGP" alt=""><figcaption></figcaption></figure>

* Go to the **Forms** tab.
* Click the **add form (+)** button.
* Set a **Title**, and optionally a **Label** to display on the user interface.
* Choose the **Execution Type**:
  * `Open flow`: Opens a new flow interface.
  * `Run flow (in background)`: Executes the selected flow without opening it.
  * `Refresh current flow`: Refreshes the existing flow after form submission.
* Select the **flow to run** (if you choose option Run flow (in background))

***

### &#x20;**2. Advanced Settings**

* **Reload current flow**: Reloads the active flow after submission.
* **Reset param after flow**: Resets the form parameters after execution.
* **Confirm before load**: Adds a confirmation step before execution.
* **Custom messages**:
  * **On Error**: Message displayed when an error occurs.
  * **On Success**: Message shown after successful execution.

***

### **3. Adding Form Fields**

<figure><img src="/files/H6gxyfwGftjCY6JMWnhW" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/hkX0ZQpvZC5Urdh1B9p5" alt=""><figcaption></figcaption></figure>

* Go to the **Types** tab and drag the desired form elements:
  * Text, Number, Date, Time, Checkbox, Slider, Line divider, etc.
* Organize fields using **grid layouts** for better visual structure.
* Configure each field in the side panel:
  * Link the field to a **parameter** (e.g., `car`, `age`, `money`, etc.).
  * Adjust settings like: `Read Only`, `Required`, `All Permitted`, `Multiple`.
  * Set a **Label**, **Placeholder**, and **Field Tip** to guide the user.

***

### **4. Integration with Data Flows**

Forms can be connected directly to flows that execute SQL, Python, or AutoML steps:

* The **input parameters** from the form are passed as variables into the flow logic.
* This allows you to **dynamically filter data**, **insert records into databases**, or **trigger external APIs** based on user input.

***

#### **Best Practices**

* Use forms to let end users customize dashboards or run simulations.
* Combine field validations (required, multiple selection) to ensure data quality.
* Prefer background execution for heavy processes to keep the interface responsive.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.gaiodataos.com/tools/form.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.