> 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-screen.md).
# Entity Screen
## **Overview**
The Entity Screen setting allows users to create and manage screens for displaying entities in DinePlan. Users can configure the screen settings, select the entities to be displayed, define mappings, and organize the order of available Entity Screens.
## **Screen Elements**
#### **Entity Screen List**
| **Screen Element** | **Description** |
| ---------------------------- | ------------------------------------------------------------ |
| Entity Screen List | Displays the available Entity Screens. |
| Search | Allows users to search for an Entity Screen. |
| Add Entity Screen | Creates a new Entity Screen. |
| Edit Entity Screen | Opens the selected Entity Screen for editing. |
| Delete Entity Screen | Deletes the selected Entity Screen. |
| Sort Entity Screens | Allows users to change the display order of Entity Screens. |
| Close | Closes the Entity Screen settings. |
| Name | Specifies the name of the Entity Screen. |
| Ticket Type | Specifies the Ticket Type associated with the Entity Screen. |
| View Mode | Specifies the view mode for the Entity Screen. |
| Background Image | Specifies the background image for the screen. |
| Ask Ticket Type | Enables or disables asking for the Ticket Type. |
| Search Value Replace Pattern | Specifies the search value replacement pattern. |
| Background Color | Specifies the background color of the screen. |
| Row Count | Specifies the number of rows displayed. |
| Column Count | Specifies the number of columns displayed. |
| Button Height | Specifies the height of the buttons. |
| Fly Button Height | Specifies the height of the fly buttons. |
| Page Count | Specifies the number of pages displayed. |
| Font Size | Specifies the font size used on the screen. |
| Use State DisplayFormat | Enables or disables the state display format. |
| Refresh Entities | Enables or disables entity refreshing. |
## Working
#### **Add an Entity Screen**
1. From the Entity Screen List, select "Add Entity Screen".
2. Enter the Entity Screen name in "Name".
3. Configure the required details under "General Settings".
4. Under "Entity List", select the required "Entity Type" and entities.
5. Under "Mappings", select "Add" and configure the required mapping details.
6. Select "Save" to save the Entity Screen.
#### **Edit an Entity Screen**
1. From the Entity Screen List, select the required Entity Screen.
2. Select "Edit Entity Screen".
3. Update the required details.
4. Select "Save" to save the changes.
#### **Delete an Entity Screen**
1. From the Entity Screen List, select the Entity Screen you want to remove.
2. Select "Delete Entity Screen".
3. A confirmation message is displayed.
4. Select "Yes" to delete the Entity Screen or "No" to cancel the operation.
#### **Change Sort Order**
1. From the Entity Screen List, select "Sort Entity Screens".
2. Drag the Entity Screens to arrange them in the required order.
3. Select "OK" to save the new order.
## **Use Case**
* Create separate screens for different entity types.
* Configure how entities are displayed on the screen.
* Assign specific Ticket Types to an Entity Screen.
* Select the entities that should be displayed on a screen.
* Configure screen appearance using background images, colors, rows, columns, and font size.
* Configure mappings based on terminals, user roles, departments, and Ticket Types.
* Edit existing Entity Screens when configuration changes are required.
* Arrange Entity Screens in the required display order.
## **Notes**
* The Name field is required when creating an Entity Screen.
* Ticket Type and Entity Type must be configured before saving the Entity Screen.
* Use "Search" to quickly locate an existing Entity Screen.
* Select "Yes" in the confirmation message to permanently delete the selected Entity Screen.
---
# 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-screen.md?ask=&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.
.png?alt=media)
