Skip to main content

Surface Get Value

Description

Surface Get Value reads and extracts text from a specific region of the screen using image recognition and optical character recognition (OCR). Use this step when you need to capture displayed text — such as field values, labels, or status messages — from a remote or virtual environment where direct object access is not available. It locates the target area by matching a reference image captured through Surface Spy, then applies OCR to extract the text into an output field for use in later workflow steps. If the step has trouble reading characters accurately, you can enable the Convert to Greyscale option to improve OCR results.

Configurations

Field NameDescription
Step NameName of the step. This name has to be unique in a single workflow.
Match Pattern
- 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).
PositionPosition has a default value Custom. Custom position is based on a relative position to a position on an image.
Image Index
Image index is generated by the image locator on surface spy.It is identified by the image locator on surface spy.
locating the image on the screen. Image index automatically populated the Image Index and is the preferred way.
You may set this manually, however locating the image on the screen automatically populates the Image Index and is the preferred way.
Output fieldSpecify a field to hold the extracted text.
Timeout(in seconds)Specify a timeout in seconds to get value from the image.
Convert To grey scaleIn case the step is not able to read characters in an image accurately you may enable Convert to grey scale checkbox to fetch better results.
ImageDepicts the image with respect to which we need to Get Value.