Help Centre › Building Processes
This article describes the RPA Screen functionality to check if an image exists on the screen.
For a full list of available functions, please read SCREEN functions.
Description
The SCREEN Check if image exists on screen function checks whether a specific image is currently visible on the screen and returns a boolean result.
Setting it up
To use the SCREEN Check if image exists on screen function, follow these instructions:
{{popups:rpas/add:action=screen-exists}}
Once on a process map:
- Navigate to the process where you would like to add the SCREEN Check if image exists on screen function
- Click on the green button's drop-down (right side of the green button labelled "Process")
- On the menu that appears, click on the "+ Activity" item
- From here you can select the SCREEN Check if image exists on screen option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Image path | Yes | Text | - | The file path to the reference image to check for |
| Confidence | No | Number (0.0-1.0) | 0.9 | The minimum confidence threshold for a match |
| Region | No | Array [x, y, w, h] | - | Restrict the search to a specific screen region |
| Variable | No | Text | exists | The variable name to store the result |
Output variables
The {exists} variable contains a boolean value: true if the image was found, false otherwise.
Errors
This action does not produce errors. It returns false if the image is not found.
Tips
- Use this for a fast boolean check when you do not need the coordinates of the image