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

# Automation Command

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

The Automation Command feature allows administrators to manage the commands available for different operational requirements in DinePlan. The Automation Command List displays the existing commands and provides options to search, add, edit, delete, and sort them.

When adding or editing a command, administrators can configure its general settings and define mappings based on terminal, user role, department, ticket type, enabled states, visible states, and visibility.

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

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

| **Screen Element**         | **Description**                                                    |
| -------------------------- | ------------------------------------------------------------------ |
| Automation Command List    | Displays the available automation commands.                        |
| Search                     | Searches for a specific automation command.                        |
| Add Automation Command     | Opens the screen to create a new automation command.               |
| Edit Automation Command    | Opens the selected command for modification.                       |
| Delete Automation Command  | Deletes the selected automation command after confirmation.        |
| Sort Automation Commands   | Allows commands to be reordered by dragging and dropping.          |
| General Settings           | Contains the configuration options for the automation command.     |
| Name                       | Specifies the name of the automation command.                      |
| Button Header Resource Key | Specifies the resource key for the button header.                  |
| Color                      | Sets the color of the command button.                              |
| Font Size                  | Sets the font size of the command button.                          |
| Button Header              | Specifies the text displayed on the command button.                |
| Toggle Values              | Enables or disables value-related settings.                        |
| Image Path                 | Specifies the image path for the command.                          |
| Values                     | Specifies values associated with the command.                      |
| Confirmation               | Specifies the confirmation option for the command.                 |
| Group Code                 | Specifies the group code associated with the command.              |
| Permission                 | Specifies the permission required for the command.                 |
| Mappings                   | Defines where and under which conditions the command is available. |
| Add / Delete               | Adds or removes a mapping entry.                                   |
| Terminal                   | Specifies the terminal where the command is available.             |
| User Role                  | Specifies the applicable user role.                                |
| Department                 | Specifies the applicable department.                               |
| Ticket Type                | Specifies the applicable ticket type.                              |
| Enabled States             | Specifies the states in which the command is enabled.              |
| Visible States             | Specifies the states in which the command is visible.              |
| Visibility                 | Specifies where the command is displayed.                          |

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

#### **Add an Automation Command** <a href="#add-an-automation-command" id="add-an-automation-command"></a>

1. From the Automation Command List, select "Add Automation Command".

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

2. Enter the automation command name in "Name".
3. Configure the required options such as "Button Header Resource Key", "Color", "Font Size", "Button Header", "Image Path", "Values", "Confirmation", "Group Code", and "Permission".

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

4. Select "Mappings" to configure the mapping for the automation command.

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

5. Select "Add" and configure the required "Terminal", "User Role", "Department", "Ticket Type", "Enabled States", "Visible States", and "Visibility".

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

6. Select "Save" to save the automation command.

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

#### **Edit an Automation Command** <a href="#edit-an-automation-command" id="edit-an-automation-command"></a>

1. From the Automation Command List, select the required automation command.
2. Select "Edit Automation Command".

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

3. Update the required details 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-fe5db2b6ef3cf82dc41be3534f229d20051ab2af%2Fatt_53_for_3422715932.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Delete an Automation Command** <a href="#delete-an-automation-command" id="delete-an-automation-command"></a>

1. Select the automation command you want to remove from the Automation Command List.
2. Select "Delete Automation Command".

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

3. A confirmation message is displayed.
4. Select "Yes" to delete the automation command 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-81ecd438da34ae78481afcf083e537906601a253%2Fatt_57_for_3422715932.png?alt=media" alt=""><figcaption></figcaption></figure>

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

1. From the Automation Command List, select "Sort Automation Commands".

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

2. Drag and drop the automation commands to arrange them in the required order.

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

3. Select "OK" to save the new sort order.

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

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

1. Add new automation commands to support additional operational actions.
2. Edit existing commands when their configuration or display details need to be updated.
3. Delete automation commands that are no longer required.
4. Sort commands to arrange them in a preferred sequence for easier access.
5. Configure button headers, colors, font sizes, and images to customize command display.
6. Define mappings to make commands available for specific terminals, user roles, departments, or ticket types.
7. Configure enabled and visible states to control when commands are available or displayed.
8. Assign permissions and confirmation settings to control access and user interaction with commands.

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

* The Name field is required when creating an automation command.
* Review the mappings before saving to ensure the command is configured for the required conditions.
* Deletion requires confirmation before the selected automation command is removed.
* Use Sort Automation Commands to maintain the required command 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/automation-command.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.