Surface Retrieve Image

Description

Surface Retrieve Image captures a selected region of the screen and saves it as an image file for use in later workflow steps. Use this step when you need to extract a visual snapshot of a specific area — such as a chart, table, or confirmation message — from a remote or virtual environment. It locates the target region by matching a reference image and its relative position attributes, then saves the captured output in your choice of format (JPG, JPEG, PNG, or BMP) to a specified folder and file name. The saved image is commonly passed to downstream OCR steps to extract text from the captured region.

Configurations

Field Name	Description
Step Name	Name 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).
Click Types	Click Type has five options as below:
Click	It performs left click action.
Right Click	It performs right click action.
Double Click	It performs double-click action.
Middle Click	It performs left Middle click action.
Mouse Move	It performs Mouse Move action.
Position	It is the position on the selected image to perform the action.The only position that is available is, Custom.Custom is the relative position from the entire image.
Image Index	Image index is generated by the image locator of surface spy.
Folder Path	Click Browse button and select the path where you want to save the image file.
File Name	Specify the name of the file. Select the type of file. For example, .jpg or .png.
Timeout(in seconds)	Specify a timeout in seconds to locate the image.
Image	View the selected image.