Help Centre › Building Processes
This article describes the RPA Screen functionality to wait for an image to appear on the screen.
For a full list of available functions, please read SCREEN functions.
Description
The SCREEN Wait for image on screen function waits until a specified image appears on the screen, checking at regular intervals until the timeout is reached.
Setting it up
To use the SCREEN Wait for image on screen function, follow these instructions:
{{popups:rpas/add:action=screen-wait-for}}
Once on a process map:
- Navigate to the process where you would like to add the SCREEN Wait for 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 Wait for 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 wait for |
| Timeout | No | Number (seconds) | 30 | Maximum time to wait for the image to appear |
| Interval | No | Number (seconds) | 0.5 | Time between each check for the image |
| 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 | location | The variable name to store the result |
Output variables
The {location} variable contains an object with properties: x, y, width, height, center_x, center_y. Returns null if the image was not found within the timeout period.
Errors
| Error | Description |
|---|---|
| Image file not found | The specified image file path does not exist |
Tips
- This function returns null on timeout rather than raising an exception; check the variable for null to determine if the image was found