Help Centre › Building Processes
This article describes the RPA Screen functionality to click on an image on the screen.
For a full list of available functions, please read SCREEN functions.
Description
The SCREEN Click image on screen function finds an image on the screen and clicks on it. You can configure the click type, button, and offset from the image center.
Setting it up
To use the SCREEN Click image on screen function, follow these instructions:
{{popups:rpas/add:action=screen-click}}
Once on a process map:
- Navigate to the process where you would like to add the SCREEN Click 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 Click image 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 and click |
| 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 |
| Clicks | No | Number | 1 | The number of clicks to perform |
| Button | No | Select (left, right, middle) | left | The mouse button to use for clicking |
| Offset X | No | Number | 0 | Horizontal offset from the image center in pixels |
| Offset Y | No | Number | 0 | Vertical offset from the image center in pixels |
| Variable | No | Text | location | The variable name to store the location of the clicked image |
Output variables
The {location} variable contains an object with properties: x, y, width, height, center_x, center_y of the found image.
Errors
| Error | Description |
|---|---|
| Image not found on screen | The specified image could not be found on the screen |
| Image file not found | The specified image file path does not exist |
Tips
- Use the offset parameters to click relative to the image center, for example to click a button next to a label
- Set clicks to 2 for a double-click action