Sap Set Checkbox
sap_set_checkboxSets a SAP checkbox to checked or unchecked by its label text, so agents can toggle form options during GUI automation. Use after retrieving form fields to identify available checkboxes.
Instructions
Set a SAP checkbox to checked or unchecked by its label text.
Use sap_get_form_fields first to see available checkboxes and their current state.
Args:
label: Checkbox label text (e.g., 'Workbench-Aufträge', 'Freigegeben')
checked: True to check, False to uncheck
Only label lookup is supported. If the label is ambiguous or not found: on the desktop backend use sap_com_evaluate or sap_run_script and set .selected = True/False on the element by id (both are desktop-only); on the WebGUI backend use browser_evaluate.
Session parameter:
session=None (default): Uses primary session ("s1")
session="s2": Targets specific session
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"label": "<label>",
"checked": "<checked>"
},
"name": "sap_set_checkbox"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | Yes | ||
| checked | Yes | ||
| session | No | ||
| agent_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error message if success=False | |
| label | No | Label or selector used to find the field | |
| popup | No | Present when a popup dialog is active on screen | |
| value | No | Value that was set | |
| success | No | Whether the operation succeeded | |
| active_window | No | Which window was operated on (e.g., 'wnd[0]', 'wnd[1]'). If 'wnd[1]' or higher, a modal dialog is open. | |
| selector_used | No | CSS selector that matched the field | |
| available_options | No | For dropdown fields: list of valid options when requested value was not found |