# verifyWebImages

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to compare the image on the web page specified in the input against the provided image path. The result is stored in the given dynamic variable for further use during test execution.

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

## **Syntax**

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

| Argument                            | Description                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>\<ObjectType><br>(Required)</p>  | Provide the object type which you want to perform the verify web image operation. (e.g., Image)                                                        |
| <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>\<image path><br>(Required)</p>  | Provide the path of the image which you want to compare with the captured image.                                                                       |
| <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: Verifying the Image Displayed in a Web Object**

In this example, we are explaining how to validate whether the image displayed in a specified object matches the expected reference image on the web page.

* **Action**: verifyWebImages
* **Input Value**: ImageObject;;0;C:\TestImages\Logo.png
  * The first argument (**ImageObject**) 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 object when multiple matching elements are present.
  * The fourth argument (**C:\TestImages\Logo.png**) specifies the expected reference image path that needs to be verified.
* **Output Value**: {Status}
  * The result of the image verification operation is stored in the **{Status}** dynamic variable.
    * **True**: If the displayed image is verified against the expected reference image.
    * **False**: If the displayed image is not verified against the expected reference image.
* **Logical Explanation**: The **verifyWebImages** action reads the identification details and expected reference image path from the **Input Value** column (**ImageObject;;0;C:\TestImages\Logo.png**). The action locates the matching object based on the specified object type and index and compares the image rendered on the web page with the provided reference image. The execution result of the verification operation (True) is stored in the **{Status}** variable.

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

### **Example 2: Verifying the Image Displayed in a Web Object using Optional Parameters**

In this example, we are explaining how to validate whether the image displayed in a specified object matches the expected reference image on the web page using optional identification parameters.

* **Action**: verifyWebImages
* **Input Value**: ImageObject;Logo;0;C:\TestImages\Logo.png
  * The first argument (**ImageObject**) specifies the object type to be identified.
  * The second argument (**Logo**) specifies an optional identification value for the object.
  * The third argument (**0**) specifies the index of the object when multiple matching elements are present.
  * The fourth argument (**C:\TestImages\Logo.png**) specifies the expected reference image path that needs to be verified.
* **Output Value**: {Status}
  * The result of the image verification operation is stored in the **{Status}** dynamic variable.
    * **True**: If the displayed image is verified against the expected reference image.
    * **False**: If the displayed image is not verified against the expected reference image.
* **Logical Explanation**: The **verifyWebImages** action reads the identification details and expected reference image path from the **Input Value** column (**ImageObject;Logo;0;C:\TestImages\Logo.png**). The action locates the matching object based on the specified object type, optional identification value, and index and compares the image rendered on the web page with the provided reference image. The execution result of the verification operation (True) is stored in the **{Status}** variable.

<figure><img src="/files/0vw746Ab1HVxC3rBwOYB" 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/verifywebimages.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.