Skip to main content

UiPath Screen OCR

UiPath.OCR.Activities.UiPathScreenOCR

Description​

Extracts a string and associated information about the textual content of images. The UiPath Screen OCR activity is optimized for usage on screen images. The activity can be used in any UI Automation scenario in which an OCR engine is needed.

note

UiPath Screen OCR is available as a cloud service as well as part of the on-premises Linux Computer Vision.

Supported list of characters​

The UiPath Screen OCR activity only supports the following list of characters:

! \ " # ¥ € £ $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ \ ] _ a b c d e f g h i j k l m n o p q r s t u v w x y z { | } ~

Project compatibility​

Windows-Legacy | Windows

Configuration​

Properties panel​

Common

  • DisplayName - The display name of the activity.

Input

  • Image - The image that you want to process. This field supports only Image variables.

Logon

  • ApiKey - The API key used to provide you access to the UiPath Screen OCR (not required for the Preview period).
  • Endpoint - The endpoint for UiPath Screen OCR. The default project settings value is https://ocr.uipath.com.
  • Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for a response from the server before an error is thrown. The default value is 100000 milliseconds (100 seconds).

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • UseLocalServer - Determines if a local server should be used. This field only supports Boolean values (True, False). The default value is False.
    important

    To use local server mode, you need to install the UiPath.ComputerVision.LocalServer package version 21.6 or higher.

  • UseSeparateOcrProcess - If set to true, new OCR processes are created depending on the configured scheduler. The parameter is ignoored if local server is used and the processes will be used.

Output

  • Result - Provides the extracted words along with their on-screen position. This field supports only KeyValuePair<Rectangle,String> variables.
  • Text - Provides the extracted text. This field supports only String variables.