Screen OCR Scan Activity
The Screen OCR Scan activity captures text from a specified area of the screen or the entire screen. It then processes the recognized text using Optical Character Recognition (OCR) and transfers the result into a designated variable.
| Field | Description | Requirement |
|---|---|---|
| X-coordinate | Specifies the X-coordinate of the top-left corner of the screen area to scan. Must be used in conjunction with Y-coordinate, Width, and Height. | Optional |
| Y-coordinate | Specifies the Y-coordinate of the top-left corner of the screen area to scan. Must be used in conjunction with X-coordinate, Width, and Height. | Optional |
| Width | Defines the width of the screen area to scan. Must be used in conjunction with X-coordinate, Y-coordinate, and Height. | Optional |
| Height | Defines the height of the screen area to scan. Must be used in conjunction with X-coordinate, Y-coordinate, and Width. | Optional |
| Language | Selects the language library to use for OCR, improving recognition accuracy for specific languages. | Required |
| Result text name | Defines the name of the variable where the OCR-recognized text will be stored. | Required |
Action Types & Examples
X-coordinate
- Format: Digit
- Example Result:
68
Y-coordinate
- Format: Digit
- Example Result:
347
Width
- Format: Digit
- Example Result:
120
Height
- Format: Digit
- Example Result:
35
Language
- Format: String (predefined options)
- Example Result:
TUR
Result Text Name
- Format: String
- Example Result:
screenOcrScan
Implementation Examples
Field Setup - Scenario 1: Scan a specific screen region - X-coordinate: "68" - Y-coordinate: "347" - Width: "120" - Height: "35" - Language: "ENG" - Result text name: "partialScreenText" - Scenario 2: Scan the entire screen - X-coordinate: (leave blank) - Y-coordinate: (leave blank) - Width: (leave blank) - Height: (leave blank) - Language: "TUR" - Result text name: "fullScreenText"
Execution Parameters - Configure activity to scan a specific region: - Set X-coordinate to "68" - Set Y-coordinate to "347" - Set Width to "120" - Set Height to "35" - Select Language as "ENG" - Assign Result text name to "ocrOutput"
Technical Notes
The X-coordinate, Y-coordinate, Width, and Height fields must be used together to define a specific screen region. If any one of these fields is specified, all four must be provided. If all four are left blank, the activity scans the entire screen. The values for Width and Height must be integers.