SCREEN Find all matches on screen function

The SCREEN Find all matches on screen function in RPA.

Help CentreBuilding 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:

  1. Navigate to the process where you would like to add the SCREEN Find all matches on screen function
  2. Click on the green button's drop-down (right side of the green button labelled "Process")
  3. On the menu that appears, click on the "+ Activity" item
  4. From here you can select the SCREEN Find all matches on screen option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
Image pathYesText-The file path to the reference image to find on screen
ConfidenceNoNumber (0.0-1.0)0.9The minimum confidence threshold for a match
RegionNoArray [x, y, w, h]-Restrict the search to a specific screen region
VariableNoTextlocationsThe 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

ErrorDescription
Image file not foundThe specified image file path does not exist

Tips

  • Use screen-count first to check the expected number of matches before retrieving all locations

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.