# Select Checkbox

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to select the checkbox specified in the input. The result is stored in the given dynamic variable for further use during test execution

{% hint style="info" %}
The **Select Checkbox** action works only when the **VerifyExists** action is executed in a preceding step.
{% endhint %}

## Syntax

**Input Value**: `<ObjectType>;<VisibleText(Optional)>;<Index>;<abs(optional)>`&#x20;

| Argument                            | Description                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>\<ObjectType><br>(Required)</p>  | Provide the object type which you want to select from the application.                                                                                 |
| <p>\<VisibleText><br>(Optional)</p> | Provide the visible text associated with the object.                                                                                                   |
| <p>\<Index><br>(Required)</p>       | <p>Provide the position of the object you want to identify based on its sequence in the application.<br><strong>Note</strong>: Index start from 0.</p> |
| <p>\<abs><br>(Optional)</p>         | Provide the absolute XPath of the object you want to identify for this operation.                                                                      |

{% hint style="info" %}
**Note**:

* If the last argument **abs** is defined, the action executes using absolute identification based on the specified absolute XPath provided in the input.
* To skip an optional input value, use an extra semicolon (;).
  {% endhint %}

**Output Value**: `<Dynamic Variable>(Optional);<Dynamic Variable>(Optional)`

| Argument                                                     | Description                                                       |
| ------------------------------------------------------------ | ----------------------------------------------------------------- |
| \<Dynamic Variable>(Optional);\<Dynamic Variable> (Optional) | Both dynamic variable stores the status as **True** or **False**. |

### **Example 1: Selecting a Checkbox Element**

In this example, we are explaining how to select checkbox on the application interface.

* **Action**: Select Checkbox
* **Input Value**: Checkbox;;0
  * The first argument (**Checkbox**) specifies the object type to be identified.
  * The second argument is left blank to skip an optional value.
  * The third argument (**0**) specifies the index of the checkbox when multiple matching elements are present.
* **Output Value**: {Status}
  * The result of the select checkbox operation is stored in the **{Status}** dynamic variable with the following possible values:
    * True: If the checkbox is selected successfully.
    * False: If the checkbox is not selected successfully.
* **Logical Explanation**: The **Select Checkbox** action reads the identification details from the **Input Value** column (**Checkbox;;0**). The action locates the matching checkbox element based on the specified object type and index and removes the selection from it. The execution result of the unselect action (True) is stored in the **{Status}** variable.

<figure><img src="/files/zaqbgwZDzVB60Mgl1Mrs" alt=""><figcaption></figcaption></figure>

### **Example 2: Selecting a Checkbox Element Using Optional Parameters**

In this example, we are explaining how to select checkbox on the application interface using optional identification parameters.

* **Action**: Select Checkbox
* **Input Value**: checkbox;accept;0;//\*\[@id="flexCheckDefault"]
  * The first argument (**checkbox**) specifies the object type to be identified.
  * The second argument (**accept**) specifies the visible text associated with the checkbox.
  * The third argument (**0**) specifies the index of the checkbox when multiple matching elements are present.
  * The fourth argument (**//\*\[@id="flexCheckDefault"]**) specifies the absolute XPath used to uniquely identify the checkbox element.
* **Output Value**: {Status}
  * The result of the select checkbox operation is stored in the **{Status}** dynamic variable with the following possible values:
    * **True**: If the checkbox is selected successfully.
    * **False**: If the checkbox is not selected successfully.
* **Logical Explanation**: The **Select Checkbox** action reads the identification details from the **Input Value** column (**checkbox;accept;0;//\*\[@id="flexCheckDefault"]**). The action locates the matching checkbox element using the object type, visible text, index, and absolute XPath and removes the selection from it. The execution result of the unselect action is stored in the **{Status}** variable.

<figure><img src="/files/i0PRxkTZKoPQsJJIkgQn" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.avoautomation.com/avo-assure/actions/web/custom-1/select-checkbox.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.