Skip to main content

Surface Actions

Description

Surface Actions combines multiple image-based interactions into a single step, so you can chain clicks, data entry, and other operations without adding a separate step for each one. Use this step when your workflow requires several sequential actions on the same screen, such as filling out a form across multiple fields in a remote or virtual environment. It includes a built-in retry count for automatic reattempts if image matching fails, and supports OCR provider configuration for text recognition tasks. Note that this step requires matching screen resolution between workflow creation and execution, and it is not supported on Linux.

Prerequisites:

  • Use machines with similar scale and resolution at the time of workflow creation and workflow execution.

  • Open the remote or virtual machine in full-screen mode.

Limitation:

Surface Actions step is not supported on Linux.

Configurations

Field NameDescription
Step NameName of the step. The name must be unique in a single workflow.
Template Match PatternSelect the pattern option from the list.
- Retrieve Single closest match: It searches for and retrieves a single closest match. If the image is not found or multiple matches are found, then it throws an error.
- Retrieve Multiple close matches: It searches for matching patterns and retrieves the closest matches.
- Retrieve All matches: It searches for and retrieves all matches (not below 50% or above 150% of the original size). The field is mandatory. The data type is String.
Template Image IndexSpecify the image index. The image index determines which image to use when multiple similar images are found and starts with 0. The field is mandatory. The data type is Integer.
Retry CountThe field allows the system to automatically reattempt the image-matching process up to the specified count.
OCR ProviderOCR Provider shows the selected OCR provider details.
EditClick Edit to change or update the selected OCR provider information.
Configure ProviderClick Configure Provider to configure the selected OCR provider information.
For details see,Appendix Surface Actions: Configure OCR provider .
Template ImageDisplays the template image with respect to which the user will perform actions.The field is mandatory.
Add / Edit ImageClick to show the Surface Spy window. You can perform capture and locate functions and change editable step properties. The field is mandatory.
Table Fields: Action Fields
ActionClick on the row to select the action details. For details, see Appendix: Surface Actions: How to guide.The field is mandatory. The data type is String.
Wait For(in seconds)Provide the Wait For to set a specific duration in seconds before the performing action.The field is mandatory. The data type is Integer.
Match PatternSelect the pattern option from the list.
- Single Closest Match: It searches for and retrieves a single closest match. If the image is not found or multiple matches are found, then it throws an error.
- Multiple close matches: It searches for matching patterns and retrieves the closest matches.
- All matches: It searches for and retrieves all matches (not below 50% or above 150% of the original size).
Note: The field works the same as the field
Template Match Pattern and applies to table rows only. The field is mandatory. The data type is String.
Image IndexSpecify the image index. The image index determines which image to use when multiple similar images are found and starts with 0.
Note: The field works the same as the field
Template Image Index and applies to table rows only. The field is mandatory. The data type is Integer.
Field InformationUse the field to provide additional information about the action just like providing comments.