> 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/automation/state.md).
# State
### **Overview**
The State feature in Back Office allows administrators to manage the different states used to represent the progress or status of orders within the system. Users can create new states, modify existing state details, remove states that are no longer required, and arrange the order in which states are displayed.
Each state can also be configured with options such as Group Code, State Type, Color, Display Format, and whether it should appear in specific reports or on tickets. This provides flexibility to configure order states according to the operational requirements of the restaurant.
### **Screen Elements**
| **Screen Element** | **Description** |
| ------------------------- | ------------------------------------------------------------------ |
| State List | Displays the available states configured in the system. |
| Search | Allows users to search for a specific state. |
| "Add State" | Opens the screen to create a new state. |
| "Edit State" | Allows users to modify the selected state. |
| "Delete State" | Allows users to remove the selected state after confirmation. |
| "Change Sort Order" | Allows users to rearrange the order in which states are displayed. |
| Name | Specifies the name of the state. |
| Group Code | Allows a group code to be assigned to the state. |
| State Type | Specifies the type of state. |
| Color | Allows a color to be assigned to the state. |
| Display Format | Specifies the display format for the state. |
| Show on End of Day Report | Controls whether the state is displayed on the End of Day Report. |
| Show on Product Report | Controls whether the state is displayed on the Product Report. |
| Show on Ticket | Controls whether the state is displayed on tickets. |
| "Save" | Saves a newly created or updated state. |
| "Close" | Closes the State screen. |
| "Yes" | Confirms deletion of the selected state. |
| "No" | Cancels the deletion. |
| "OK" | Saves the updated sort order. |
| "CANCEL" | Cancels the sort-order changes. |
### **Working**
#### **Add State**
1. Open the State List from the Back Office.
2. Select "Add State".
3. Enter the required state name in Name.
4. Configure the Group Code, State Type, Color, and Display Format as required.
5. Enable or disable Show on End of Day Report, Show on Product Report, and Show on Ticket as required.
6. Select "Save" to add the state to the list.
#### **Edit State**
1. Select the state you want to modify.
2. Select "Edit State".
3. Update the state details as required.
4. Select "Save" to save the changes.
#### **Delete State**
1. Select the state you want to remove.
2. Select "Delete State".
3. A confirmation message is displayed.
4. Select "Yes" to delete the state or "No" to cancel.
#### **Sort States**
1. Select "Change Sort Order".
2. The list of states is displayed in the sort-order window.
3. Arrange the states in the required order.
### **Use Case**
* Create new states to represent additional order statuses required for restaurant operations.
* Edit existing states when their configuration or display settings need to be updated.
* Delete states that are no longer required in the system.
* Arrange states in a preferred order for easier identification and workflow management.
* Configure whether a state should appear on the End of Day Report.
* Configure whether a state should appear on the Product Report.
* Control whether a state is displayed on tickets using Show on Ticket.
* Use Search to quickly locate a specific state when managing a larger list.
### **Notes**
* The Name field is required when creating a state.
* Select the appropriate State Type while configuring a state.
* Report and ticket display options can be enabled or disabled based on the required configuration.
* Review the selected state before using "Delete State", as deletion requires confirmation.
* Use "CANCEL" when you do not want to apply changes made to the sort order.
---
# 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/automation/state.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)
