# Create New Entity

Creating a new **Entity** is the first operational step in building Smart Forms in ONEWEB.\
This section explains how to create a new entity and introduces the **Entity Menu**, which is used to configure, preview, and manage entity behavior.

***

### Starting Point: Entity Menu (Top‑Left)

#### Step 1: Create a New Entity

1. Open **App Designer**
2. From the **Entity Menu** (top‑left), click **Create New Entity**
3. A confirmation popup appears

#### Step 2: Confirm Creation

* Click **OK** to proceed
* A blank entity is created and opened for configuration

<figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FHxOutlTNmrZ2xq7e8U0m%2Fimage.png?alt=media&#x26;token=56cc375f-2093-4ed7-a472-e63b404df00f" alt=""><figcaption></figcaption></figure>

***

### Entity Configuration Overview

Once an entity is created, its configuration options become available through the **Entity Menu**.

<figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FRnKpqcW7B2YsMD9uobaR%2Fimage.png?alt=media&#x26;token=87a6874d-f926-4d28-b08e-48d7b948efdb" alt=""><figcaption></figcaption></figure>

> **Note**\
> The Entity Menu is always accessible from the **top‑right corner** of the screen whenever an entity is open.

***

### Edit Entity Configuration

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FlUurLep5GhFIe1eMQLvE%2Fimage.png?alt=media&#x26;token=54bc8732-4ba2-4219-8f54-24d1179fbc4e" alt=""><figcaption></figcaption></figure></div>

This icon opens the **Entity Configuration** panel, where core entity properties are defined.

#### Commonly Used Property

* **Entity Name** – The most important property\
  Choose a name that clearly identifies the business scope of the entity\
  (e.g. `Customer`, `Invoice`, `PurchaseOrder`)

#### Entity Configuration Properties

| Property           | Mandatory | Description                        |
| ------------------ | --------- | ---------------------------------- |
| Entity ID          | Yes       | System‑generated unique identifier |
| Entity Name        | Yes       | User‑defined business name         |
| Template Code      | Yes       | Active UI template                 |
| Theme Code         | Yes       | Active UI theme                    |
| System Code        | Yes       | Application schema code            |
| Version            | Yes       | Entity version                     |
| Default Search     | No        | Default entity for search screen   |
| Default Insert     | No        | Default entity for insert screen   |
| Require Workflow   | No        | Enable workflow integration        |
| Workflow Workqueue | No        | Workqueue mapping                  |
| Tab Condition      | No        | Enable conditional tabs            |
| Hide Tab           | No        | Hide child tabs                    |
| View Mode          | No        | Open entity in read‑only mode      |
| Load Tab           | No        | Auto‑load tab                      |
| History Flag       | No        | Enable history tracking            |
| Image Viewer       | No        | Enable image viewer                |

***

### Configure Action Flow (Microflow Integration)

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FriMBbK4E1ztdxWyE1Ju0%2Fimage.png?alt=media&#x26;token=a68bd42a-4e3f-479c-9ea6-cd3a84735e6c" alt=""><figcaption></figcaption></figure></div>

This icon is used to configure **Action Flow**, allowing the entity to:

* Integrate with **Microflow Designer**
* Trigger backend logic during entity operations

***

### Save Entity

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FI0z3BSv5YNXuIX5Lp6xy%2Fimage.png?alt=media&#x26;token=8918c0aa-d156-483b-bbeb-554c8a076b0f" alt=""><figcaption></figcaption></figure></div>

This icon saves the current entity configuration.

> **Best Practice**\
> Save frequently after each configuration change.

***

### Preview Entity (Search Mode)

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FeyHo0RISCEntyBC8YZoI%2Fimage.png?alt=media&#x26;token=046b5e5c-1c9f-42c7-82e5-9c3383978213" alt=""><figcaption></figcaption></figure></div>

This opens a **Search Preview** of the entity.\
Useful when:

* Table configuration is partially defined
* You want to validate search behavior early

***

### Preview Entity (Create / Insert Mode)

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2F5eFg6aFHh9k1jXB1FL9w%2Fimage.png?alt=media&#x26;token=d36cf2b8-7ffc-44fc-b7f1-e38d5365987a" alt=""><figcaption></figcaption></figure></div>

This icon opens the **Create / Insert Preview**, allowing you to:

* Preview data entry UI
* Validate input layout before full configuration

***

### Help

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FaAOtwVnAmZM9z9h21JIa%2Fimage.png?alt=media&#x26;token=88f65251-9c57-4d21-8660-c0b8d5e49ead" alt=""><figcaption></figcaption></figure></div>

Opens the **Help screen** for entity-related guidance.

***

### Back to Application

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FhlvnERmsua5wtMiWSLn3%2Fimage.png?alt=media&#x26;token=f69a52ec-a01a-4b76-b7c5-407546305d2c" alt=""><figcaption></figcaption></figure></div>

Returns to the **Application screen**.

***

### Console Logs

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FrBsslTUcc804DKliIKOX%2Fimage.png?alt=media&#x26;token=c425390d-ec10-411b-9c44-6a9e16a5885d" alt=""><figcaption></figcaption></figure></div>

Opens the **Console**, where users can:

* View activity logs
* Debug entity behavior

***

### Smart Data Entry

<div align="left"><figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FPEqNrl73MvEYrZGPrMky%2Fimage.png?alt=media&#x26;token=72429f7a-32f5-4bbe-9ade-7bf91a3adb8d" alt=""><figcaption></figcaption></figure></div>

Opens the **Smart Data Entry screen** for quick data input and testing.

***

### Summary

Creating a new Entity involves:

* Initial creation via Entity Menu
* Defining entity properties
* Saving and previewing behavior
* Integrating with Microflow if needed

Key takeaways:

* Entity creation is the foundation of Smart Forms
* Entity Menu centralizes configuration and previews
* Proper naming and scope definition is critical
* Frequent saving and previewing ensure faster development


---

# 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.onewebstack.com/designer-reference/app-designer/entity/create-new-entity.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.