This article describes the RPA Screen functionality to find an image on the screen.

For a full list of available functions, please read SCREEN functions.

Description

The SCREEN Find image on screen function locates an image on the screen and returns its position, dimensions, and center coordinates.

Setting it up

To use the SCREEN Find image on screen function, follow these instructions:

Once on a process map:

Navigate to the process where you would like to add the SCREEN Find image 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 image on screen option
Click "Add" once you are done

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
Grayscale	No	Boolean	true	Whether to convert images to grayscale before matching
Variable	No	Text	location	The variable name to store the result

The {location} variable contains an object with properties: x, y, width, height, center_x, center_y. Returns null if the image is not found.

Error	Description
Image file not found	The specified image file path does not exist

Lower the confidence value for images that may appear slightly different due to rendering or scaling
Use the region parameter to speed up the search by limiting the area scanned