Help Centre › Building Processes
This article describes the RPA Screen functionality to find all matches of an image on the screen.
For a full list of available functions, please read SCREEN functions.
Description
The SCREEN Find all matches on screen function locates all occurrences of an image on the screen and returns an array of their positions.
Setting it up
To use the SCREEN Find all matches on screen function, follow these instructions:
{{popups:rpas/add:action=screen-find-all}}
Once on a process map:
- Navigate to the process where you would like to add the SCREEN Find all matches 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 Find all matches 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 find on screen |
| 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 | locations | The variable name to store the results |
Output variables
The {locations} variable contains an array of location objects, each with properties: x, y, width, height, center_x, center_y.
Errors
| Error | Description |
|---|---|
| Image file not found | The specified image file path does not exist |
Tips
- Use screen-count first to check the expected number of matches before retrieving all locations