> 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/script.md).
# Script
### **Overview**
The Script feature in the Back Office allows authorized users to create and manage scripts used within the system. Users can define a script by providing a Name, Handler, and Script content, and can test the script when required. This provides a centralized way to maintain and manage the scripts configured in the system.
### **Screen Elements**
| **Screen Element** | **Description** |
| ------------------ | ---------------------------------------------------------------- |
| Script List | Displays the available scripts. |
| Search | Allows users to search for a specific script. |
| Add Script | Opens the screen to create a new script. |
| Edit Script | Allows users to modify the selected script. |
| Delete Script | Deletes the selected script after confirmation. |
| Change Sort Order | Allows users to change the order in which scripts are displayed. |
| Close | Closes the Script screen. |
### **Working**
#### **Add a Script**
1. From the Script List, select "Add Script".
2. Enter the script name in "Name".
3. Enter the required handler in "Handler".
4. Enter the script content in "Script".
5. Select "Save" to save the script.
Note: The Name field is required. If it is left blank, the system displays the message "Name" should not be empty.
#### **Edit a Script**
1. From the Script List, select the required script.
2. Select "Edit Script".
3. Update the required details.
4. Select "Save" to save the changes.
#### **Delete a Script**
1. Select the script you want to remove from the Script List.
2. Select "Delete Script".
3. A confirmation message is displayed.
4. Select "Yes" to delete the script or "No" to cancel the operation.
#### **Change Sort Order**
1. From the Script List, select "Change Sort Order".
2. Adjust the order of the scripts as required.
### **Use Case**
* Create new scripts by entering the required Name, Handler, and Script content.
* Configure scripts to define the required instructions or actions for specific system operations.
* Test configured scripts using the "Test" option to verify that the script works as expected.
* Edit existing scripts to update their name, handler, or script content when changes are required.
* Search for specific scripts using the "Search" option to quickly locate them in the Script List.
* Delete scripts that are no longer required by selecting "Delete Script" and confirming the deletion.
* Change the display order of scripts using "Change Sort Order" to organize them according to the required sequence.
* Manage all configured scripts from a centralized Script List, including adding, editing, testing, deleting, searching, and sorting scripts.
### **Notes**
* A script must have a Name before it can be saved.
* Use "Edit Script" to modify an existing script.
* Use "Delete Script" to remove a script after confirming the deletion.
* Use "Test" to test a script before or after making changes, as required.
* "Change Sort Order" can be used to organize the script list.
* Use "Search" to quickly locate a script in the list.
---
# 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/script.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)
