> 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/rules.md).

# Rules

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

The Automation Rules feature allows administrators to manage rules that define actions based on specific events and conditions. Users can create new rules, modify existing rules, delete rules, and change the order of rules.

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

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

#### **Rule List** <a href="#rule-list" id="rule-list"></a>

| **Screen Element**      | **Description**                                                                                         |
| ----------------------- | ------------------------------------------------------------------------------------------------------- |
| Rule List               | Displays the available automation rules, grouped according to their associated events.                  |
| Search                  | Allows users to search for a specific rule.                                                             |
| Add Rule                | Opens the screen to create a new automation rule.                                                       |
| Edit Rule               | Opens the selected rule for modification.                                                               |
| Delete Rule             | Deletes the selected rule after confirmation.                                                           |
| Sort Rules              | Opens the sorting window where rules can be reordered by dragging them.                                 |
| Close                   | Closes the Automation Rules screen.                                                                     |
| Rule Name               | Enter the name of the automation rule.                                                                  |
| Event Name              | Select the event associated with the rule.                                                              |
| Custom Constraint List  | Defines additional conditions for the rule.                                                             |
| Execute rule if         | Specifies whether the rule should be executed when the defined constraint matches.                      |
| Add Custom Constraint   | Adds a custom condition to the rule.                                                                    |
| Actions: Select Actions | Selects the actions to be performed when the rule is executed.                                          |
| Mappings                | Opens the mapping section for defining the applicable terminal, user role, department, and ticket type. |
| Save                    | Saves the automation rule.                                                                              |
| Close                   | Closes the rule configuration screen.                                                                   |

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

#### **Add a Rule** <a href="#add-a-rule" id="add-a-rule"></a>

1. Select "Add Rule" from the Rule List.

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

2. Enter a Rule Name.
3. Select an Event Name.

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

4. Configure the required Custom Constraint.
5. Select the required Actions.

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

6. Open Mappings and select the applicable mapping values.

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

7. Select "Save" to create the rule.

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

#### **Edit a Rule** <a href="#edit-a-rule" id="edit-a-rule"></a>

1. Select the required rule from the Rule List.
2. Select "Edit Rule".

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

3. Update the required rule settings, constraints, actions, or mappings.
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-24d596517279a96de7a616fb12d79006de2c05ec%2Fatt_24_for_3422715932.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Delete a Rule** <a href="#delete-a-rule" id="delete-a-rule"></a>

1. Select the required rule from the Rule List.
2. Select "Delete Rule".

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

3. A confirmation message is displayed asking whether to delete the selected rule.
4. Select "Yes" to confirm the deletion or "No" to cancel.

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

#### **Sort Rules** <a href="#sort-rules" id="sort-rules"></a>

1. Select "Sort Rules".

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

2. In the Sort Rules window, drag the rules to change their order.

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

3. Select "OK" to apply the new order.

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

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

* Trigger specific actions automatically when a defined event occurs in the POS system.
* Apply additional conditions to ensure an automated action is performed only when the required criteria are met.
* Automate routine processes that would otherwise require staff to perform the same action manually.
* Configure different automated actions based on specific events, such as order or transaction-related activities.
* Apply automation to specific terminals when different POS terminals require different operational behavior.
* Restrict an automation rule to particular user roles or departments when the action should apply only to selected staff or areas.
* Apply different automation rules to specific ticket types when the required action depends on the type of transaction being processed.
* Manage multiple automation rules and arrange their order when the sequence of rule execution is important.

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

* Rule Name must be entered before saving a rule.
* Select the appropriate Event Name when creating or configuring a rule.
* Custom constraints can be added when additional conditions are required.
* Actions can be selected for the rule from Select Actions.
* Mappings can be configured based on Terminal, User Role, Department, and Ticket Type.
* Multiple mappings can be added or removed as required.
* Verify the rule configuration before selecting "Save".
* Deleting a rule requires confirmation.
* Use "Sort Rules" to change the order of existing rules.
* Rules in the sorting window can be reordered by dragging them.


---

# 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/rules.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.
