> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/backoffice/enitites/entity.md).

# Entity

### **Overview** <a href="#overview.1" id="overview.1"></a>

The Entity feature allows administrators to create and manage entities such as tables and members within DinePlan. It provides options to add individual entities, edit existing entities, delete entities, create multiple entities at once using Batch Create Entities, and change the order in which entities are displayed.

This helps administrators maintain entity records efficiently and organize them according to operational requirements.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-4061bc22bbef4c45b4d73e3dbf65d2ea9d3a1cc8%2Fimage%20(152).png?alt=media" alt=""><figcaption></figcaption></figure>

### **Screen Elements** <a href="#screen-elements.1" id="screen-elements.1"></a>

| **Screen Element**    | **Description**                                          |
| --------------------- | -------------------------------------------------------- |
| Entity List           | Displays the available entities grouped by entity type.  |
| Search                | Allows users to search for a specific entity.            |
| Add Entity            | Opens the screen to create a new entity.                 |
| Edit Entity           | Opens the selected entity for editing.                   |
| Delete Entity         | Deletes the selected entity after confirmation.          |
| Batch Create Entities | Allows multiple entities to be created at the same time. |
| Change Sort Order     | Allows users to rearrange the order of entities.         |
| Entity Type           | Specifies the type of entity being created.              |
| Warehouse             | Specifies the warehouse associated with the entity.      |
| Account               | Specifies the account associated with the entity.        |
| OK                    | Confirms the batch creation or sort order changes.       |
| Cancel                | Cancels the current operation.                           |
| Close                 | Closes the Entity screen.                                |

### **Working** <a href="#working.1" id="working.1"></a>

#### **Add an Entity** <a href="#add-an-entity" id="add-an-entity"></a>

1. From the Entity List, select "Add Entity".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-8ca51b8bf105c00be9e0b3ddfaa2d654bad5e5c0%2Fatt_12_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Select the required entity type in "Entity Type".
3. Enter or select the required "Warehouse".
4. Enter or select the required "Account".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-a9078a945520d238adebed6b365b7c03ed2eda4a%2Fatt_13_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

5. Select "Save" to save the entity.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-7ddd38f2ae8ba44cf6fd0c5bd10fcd6e725c13bc%2Fatt_14_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Edit an Entity** <a href="#edit-an-entity" id="edit-an-entity"></a>

1. From the Entity List, select the required entity.
2. Select "Edit Entity".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-d9b44c78ce9c981371a184d7caec397f7d2a8135%2Fatt_15_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Update the required entity details.
4. Select "Save" to save the changes.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-7ddd38f2ae8ba44cf6fd0c5bd10fcd6e725c13bc%2Fatt_14_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Delete an Entity** <a href="#delete-an-entity" id="delete-an-entity"></a>

1. From the Entity List, select the entity you want to remove.
2. Select "Delete Entity".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-4428055f0c883a322fded2ce400e9475adfc5953%2Fatt_17_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

3. A confirmation message is displayed.
4. Select "Yes" to delete the entity or "No" to cancel the operation.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-3e5b46ed6e1e0aa9616a1052d3625f064272ed17%2Fatt_18_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Batch Create Entities** <a href="#batch-create-entities" id="batch-create-entities"></a>

1. From the Entity List, select "Batch Create Entities".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-a0fe391d33a1bf89ce98e62c856634025915a34f%2Fatt_19_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Enter the entity names, with each entity on a separate line.
3. Select "OK" to create the entities.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-d17c3af616ad1f22b892512afea8b8190f2b1930%2Fatt_20_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Change Sort Order** <a href="#change-sort-order.1" id="change-sort-order.1"></a>

1. From the Entity List, select "Change Sort Order".

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-2e1163a29c1ba08f77b293425f1ba90eb0d4d9bb%2Fatt_21_for_3422650690.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Adjust the order of the entities as required.

### **Use Case** <a href="#use-case.1" id="use-case.1"></a>

* Create individual entities for managing operational records such as tables or members.
* Create multiple entities at once using the "Batch Create Entities" option.
* Edit existing entity details when configuration or operational requirements change.
* Delete entities that are no longer required.
* Search for specific entities when managing a large list of records.
* Associate an entity with the required warehouse and account during configuration.
* Arrange entities in a preferred order for easier identification and navigation.
* Maintain organized entity records according to the operational requirements of the restaurant.

### **Notes** <a href="#notes.1" id="notes.1"></a>

* The "Entity Type" must be selected when creating an entity.
* The "Batch Create Entities" option creates an entity for each line entered.
* Deleting an entity requires confirmation before removal.
* Use "Change Sort Order" to rearrange the display order of entities.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.rbsgo.com/dineplan/backoffice/enitites/entity.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
