> For the complete documentation index, see [llms.txt](https://docs.oneweb.tech/oneweb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oneweb.tech/oneweb/reference/app-designer-reference/entity/create-new-entity/buttons.md).

# Buttons

Buttons are used inside Smart Forms to execute certain actions. App Designer supports 3 Types of Button Configuration inside your smart form - Entity Button, Module Button and Process button.

**Entity Button:** Entity buttons facilitates actions for the entire entity e.g. submitting the form, database calls such as Save/Cancel/Back/Approve or Reject actions on your smart form. Entity buttons can be dragged and dropped between Main Tab and Main module of your Entity. The **Entity Button** configuration provide a list of property settings with 2 icons as shown below:

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FgVLRFqOXuSiC50UVyZfO%2F0?alt=media)

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FX6D96PXihSmTKQX7hyq3%2F1?alt=media)- This Icon is used to open **Button Configuration** popup. Entity Button configuration popup provides a list of settings which can help configure your entity effectively. Entity Button Configuration settings along with their usage are listed in table below:

| **Button Item** | **Default value**            | **Mandatory** | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------- | ---------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Button ID       | System generated             | Y             | Button ID is unique, and it is generated by system.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Entity\_ID      | System generated             | Y             | System auto-displays the Entity ID associated with resp. Button.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| buttonName      | Default system generated no. | Y             | User can edit default value to any value as per business needs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Sequence        | 0                            | Y             | Sequence is used to sequence the buttons while displaying on facade screen. Button with sequence '0' would show before button with sequence '1' and so on.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Button Type     | button                       | Y             | Button Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Page Action     | N/A                          | Y             | <p>Page Action has 3 types - <strong>ENTITY\_SEARCH, ENTITY\_INSERT & ENTITY\_UPDATE</strong></p><ul><li><strong>ENTITY\_SEARCH</strong> is the page action used to display buttons on search screen/Search entity mode.</li><li><strong>ENTITY\_INSERT</strong> is the page action used to display buttons on insert screen/Insert entity mode.</li><li><strong>ENTITY\_UPDATE</strong> is the page action used to display buttons on update screen/Update entity mode.</li></ul><p>(<em>Note:</em> For more information on Entity Modes, Check <a href="bookmark://_topic_63314EntityModes">Entity Modes</a>)</p>                                                                                                                                                                                                                                                                                                                                                                           |
| Button Action   | N/A                          | Y             | <p>There are 7 inbuilt Button actions provided by ONEWEB - <strong>searchResult(), resetSearchCriteria(), addEntity(), cancelEntity(), deleteEntity(), viewHistory() & saveEntity().</strong> The use of each of the inbuilt button functions are listed below:</p><ul><li>searchResult() is used to search for existing records from database based on search criteria.</li><li>resetSearchCriteria() is used to reset the search criteria .</li><li>addEntity() is used to open an entity screen to enter data.</li><li>cancelEntity() is used to close the entity edit screen.</li><li>deleteEntity() is used to delete record from database.</li><li>viewHistory() is used to show the history of the respective screen.</li><li>saveEntity() is used to save the data in the entity to the corresponding database tables.</li></ul><p><em><strong>Note: User can use any customize functions here instead of inbuilt functions, to perform a customized button action.</strong></em></p> |
| Authentication  | No                           |               | Enable to call authorization Engine (IAM- Identity access Management)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Action          | N/A                          |               | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| styleClass      | button\_style                | Y             | Custom Style Of CSS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| sourceTag       | N/A                          |               | Used to define button styles using HTML commands.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| imgFlag         | N/A                          |               | To show the button as image                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FYQDVIARVugeoHkvx1TPA%2Fimage.png?alt=media\&token=30eb825d-13dc-4df1-b814-cd0211532b64)- This Icon is used to delete a Button from your Smart Form Layout.

**Module Button:** Facilitates user actions for 1-Many module in an entity. The scope of module buttons is limited to module levels and would not impact an entire Entity. It can be used to add, delete or update records of the module. The Module Button contains the same configuration settings as an Entity button as shown above, except different options available for Button Actions specific to modules. The Button action configuration options specific to module configuration are shown below:

| **Button Item** | **Default value** | **Mandatory** | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------- | ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Button Action   | N/A               | Y             | <p>ONEWEB smart form provides 7 inbuilt Button actions w\.r. Module Button Configuration:</p><ul><li><em>\[MODULE\_ID]Delete()</em> - This action is used to delete Module Record.</li><li><em>actionFormSubmitOnTable( 'insertMany','Y')</em></li><li><em>\[MODULE\_ID]Copy()</em> - This button is used for Copy Record.</li><li><em>actionFormSubmit( 'insertMany','Y')</em> - This button is used for Pop-up logging into the Many module (Hashmap)</li><li><em>\[MODULE\_ID]ImportExcel()</em> - This button is used for Import Excel to the Module Many table.</li><li><em>\[MODULE\_ID]ExportExcel()</em> - This button is used for Export Table to Excel.</li><li><em>$( '#many\_\[MODULE\_ID]\_dialog('close');</em> This button is used to close the Module popup.</li><li><em>popupList('\[POPUP\_ENTITY\_ID]','\[CURRENT\_MODULE\_ID]')</em> - This button is used to open the Neighbor Tab or to open the Popup Entity.</li><li><em>popupActionFlow('\[MODULE\_ID]')</em> - This button is used to open popup.</li></ul><p><em>Note:</em> User can use any customize functions here instead of inbuilt functions, to perform a customized button action.</p> |

**Process Button:** Facilitates smart forms to connect with internal business processes & micro flows. Process buttons can be easily dragged and dropped beside entity button inside your entity. The Process **Button** configuration provide a list of property settings with following 4 tabs as shown below:

Pre-Action: Describes any actions that user wanted to perform on an Entity before performing Process button action. It provides user 3 inbuilt options - cancelEntity(), deleteEntity() and savaEntity(). (Note: User can use any customize functions here instead of inbuilt functions, to perform a customized pre-action)

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FWK4QZpG6qjQSlcp5UhPD%2Fimage.png?alt=media\&token=9efe258c-29f4-40d1-bed2-8e5662ad9541)

Process: Process tab provides list of configuration settings.

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FyeFnDeKdlkQo0OHeWjNL%2Fimage.png?alt=media\&token=c0727bf7-19c7-4741-944a-796cce9551c3)

| **Process Tab Item**  | **Description**                                                        |
| --------------------- | ---------------------------------------------------------------------- |
| Process Server Status | Shows Green Light for active connection.                               |
| Project               | User must select their project in Process Designer from drop down list |
| Process               | User must select their Process in Process Designer                     |
| Process Action        | Action to choose for respective process -                              |

Post Actio&#x6E;*:* Describes any actions that user wanted to perform on an Entity after executing Process button action. It provides user 3 inbuilt options - cancelEntity(), deleteEntity() and savaEntity(). (Note: User can use any customize functions here instead of inbuilt functions, to perform a customized post action)

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FITu4UISCrLrixtG9dQ4I%2Fimage.png?alt=media\&token=135b7783-e454-4aa4-8a43-0798b3479b2d)

Other Settings are similar as other module buttons settings.

![](https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FyBUzoTOsVC6PsVdAzqR4%2Fimage.png?alt=media\&token=b8c41b1d-9311-4cb7-b7dd-a22ad9a443b3)

| **Process Button Item** | **Default value**            | **Mandatory** | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ----------------------- | ---------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Button ID               | System generated             | Y             | Button ID is unique, and it's generated by system.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Entity\_ID              | System generated             | Y             | System auto-displays an Entity ID associated with resp. Button.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| buttonName              | Default system generated no. | Y             | Appropriate name for button as per business needs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Sequence                | 0                            |               | Sequence is used to display buttons in sequence on facade screen. Button with sequence '0' would show before button with sequence '1' and so on.                                                                                                                                                                                                                                                                                                                                                                                                            |
| Button Type             | button                       |               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Page Action             | N/A                          | Y             | <p>Page Action has 3 types - <strong>ENTITY\_SEARCH, ENTITY\_INSERT & ENTITY\_UPDATE</strong></p><ol><li><strong>ENTITY\_SEARCH</strong> is used to display buttons on search screen/Search entity mode.</li><li><strong>ENTITY\_INSERT</strong> is used to display buttons on insert screen/Insert entity mode.</li><li><strong>ENTITY\_UPDATE</strong> is used to display buttons on update screen/Update entity mode.</li></ol><p>(Note : For more information on Entity Modes, check <a href="bookmark://_topic_63314EntityModes">Entity Modes</a>)</p> |
| Authentication          | No                           |               | Enable to call authorization Engine ( IAM- Identity access Management)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Action                  | N/A                          |               | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| styleClass              | button\_style                |               | Custom Style Of CSS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| sourceTag               | N/A                          |               | Used to define button styles using HTML commands.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| imgFlag                 | N/A                          |               | To show the button as image.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.oneweb.tech/oneweb/reference/app-designer-reference/entity/create-new-entity/buttons.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.