# Abbyy Screen OCR

> `UiPath.AbbyyEmbedded.Activities.AbbyyScreenOCR`

`UiPath.AbbyyEmbedded.Activities.AbbyyScreenOCR`

:::important
The UiPath.AbbyyEmbedded.Activities package has been deprecated and is currently out of support. Also, the package is unlisted from the UiPath Studio Manage Packages official feed. Check the [Deprecation timeline](https://docs.uipath.com/overview/other/latest/overview/deprecation-timeline#deprecated-features-or-capabilities) for more details.
:::

Extracts a string and its information from an indicated UI element or image using Abbyy OCR Engine. It can be used with other OCR activities exclusively within the purpose of screen scraping.

Here are a few examples of activities that can be used together with Abby Screen OCR: [Click OCR Text](https://docs.uipath.com/activities/other/latest/ui-automation/click-ocr-text), [Hover OCR Text](https://docs.uipath.com/activities/other/latest/ui-automation/hover-ocr-text), [Get OCR Text](https://docs.uipath.com/activities/other/latest/ui-automation/get-ocr-text), [Find OCR Text Position](https://docs.uipath.com/activities/other/latest/ui-automation/find-ocr-text), [CV Screen Scope](https://docs.uipath.com/activities/other/latest/ui-automation/cv-scope), [CV Get Text](https://docs.uipath.com/activities/other/latest/ui-automation/cv-get-text-with-descriptor).

This activity will not work within the following activities: [Digitize Document](https://docs.uipath.com/activities/other/latest/document-understanding/digitize-document), [Read PDF With OCR](https://docs.uipath.com/activities/other/latest/document-understanding/read-pdf-with-ocr) or [Read XPS With OCR](https://docs.uipath.com/activities/other/latest/document-understanding/read-xps-with-ocr).

:::note
If you want to use this OCR activity from package UiPath.AbbyyEmbedded.Activities v1.2.0 in Studio v19.10, please install the UiPath.CoreIPC package, version 2.0.1 or higher."
:::

## Properties

#### Common

* **DisplayName** - The display name of the activity.

#### Misc

* **Private** - If selected, the values of variables and arguments are no longer logged at Verbose level.

#### Options

* **CustomRecognitionProfilePath** - Specifies the full path to a custom built Recognition Profile. This field supports only strings and `String` variables.
* **EnginePack** - Specifies which embedded engine must be used for image processing. There are two options, as follows: **Basic** - Supports a wide range of languages, **Extended** - Contains extra support for Chinese, Japanese, and Korean languages. Check the list of all available languages for the **Basic** pack at the bottom of this page.
* **ExtractWords** - If selected, the on-screen position of each detected word is extracted.
* **Language** - The language used by the OCR engine to extract the text from the UI element or image. The language name must be fully written, such as "English", "Japanese", "Romanian". The default value is `"English"`.

  If you want to use one of the following languages **ChinesePRC**, **ChineseTaiwan**, **Japanese**, **Korean**, and **KoreanHangul** you need to install a separate bundle package available in the **Manage Packages** menu.
* **Scale** - The scaling factor of the selected UI element or image. The higher the number is, the more you enlarge the image. This can provide a better OCR read and it is recommended with small images. If you want to scale down, values between 0 and 1 are also accepted. By default, the value is `1`.

#### Output

* **Confidence** - The resulting confidence score, stored in an `Int32` variable. This field supports only `Int32` variables.
* **Result** - The text extracted by the OCR engine along with their on-screen position, stored in a `KeyValuePair<Rectangle,String>`. This field supports only `KeyValuePair<Rectangle,String>`.
* **Text** - The text extracted by the OCR engine, stored in a String variable. This field supports only `String` variables.

  | **Basic Pack - Languages** |
  | --- |
  | Abkhaz |
  | Adyghe |
  | Afrikaans |
  | Agul |
  | Albanian |
  | Altaic |
  | Arabic |
  | ArmenianEastern |
  | ArmenianGrabar |
  | ArmenianWestern |
  | Awar |
  | Aymara |
  | AzeriCyrillic |
  | AzeriLatin |
  | Bashkir |
  | Basque |
  | Belarusian |
  | Bemba |
  | Blackfoot |
  | Breton |
  | Bugotu |
  | Bulgarian |
  | Burmese |
  | Buryat |
  | Catalan |
  | Chamorro |
  | Chechen |
  | Chukcha |
  | Chuvash |
  | Corsican |
  | CrimeanTatar |
  | Croatian |
  | Crow |
  | Czech |
  | Danish |
  | Dargwa |
  | Digits |
  | Dungan |
  | Dutch |
  | DutchBelgian |
  | English |
  | EskimoCyrillic |
  | EskimoLatin |
  | Esperanto |
  | Estonian |
  | Even |
  | Evenki |
  | Faeroese |
  | Farsi |
  | Fijian |
  | Finnish |
  | French |
  | Frisian |
  | Friulian |
  | GaelicScottish |
  | Gagauz |
  | Galician |
  | Ganda |
  | German |
  | GermanLuxembourg |
  | GermanNewSpelling |
  | Greek |
  | Guarani |
  | Hani |
  | Hausa |
  | Hawaiian |
  | Hebrew |
  | Hungarian |
  | Icelandic |
  | Ido |
  | Indonesian |
  | Ingush |
  | Interlingua |
  | Irish |
  | Italian |
  | Kabardian |
  | Kalmyk |
  | KarachayBalkar |
  | Karakalpak |
  | Kasub |
  | Kawa |
  | Kazakh |
  | Khakas |
  | Khanty |
  | Kikuyu |
  | Kirgiz |
  | Kongo |
  | Koryak |
  | Kpelle |
  | Kumyk |
  | Kurdish |
  | Lak |
  | Lappish |
  | Latvian |
  | Lezgin |
  | Lithuanian |
  | Luba |
  | Macedonian |
  | Malagasy |
  | Malay |
  | Malinke |
  | Maltese |
  | Mansi |
  | Maori |
  | Mari |
  | Maya |
  | Miao |
  | Minankabaw |
  | Mohawk |
  | Mongol |
  | Mordvin |
  | Nahuatl |
  | Nenets |
  | Nivkh |
  | Nogay |
  | NorwegianBokmal |
  | NorwegianNynorsk |
  | Nyanja |
  | Occidental |
  | Ojibway |
  | Ossetic |
  | Papiamento |
  | PidginEnglish |
  | Polish |
  | PortugueseStandard |
  | PortugueseBrazilian |
  | Provencal |
  | Quechua |
  | RhaetoRomanic |
  | Romanian |
  | RomanianMoldavia |
  | Romany |
  | Ruanda |
  | Rundi |
  | Russian |
  | RussianWithAccent |
  | Samoan |
  | Selkup |
  | Serbian |
  | SerbianCyrillic |
  | SerbianLatin |
  | Shona |
  | Sioux |
  | Slovak |
  | Slovenian |
  | Somali |
  | Sorbian |
  | Sotho |
  | Spanish |
  | Sunda |
  | Swahili |
  | Swazi |
  | Swedish |
  | Tabassaran |
  | Tagalog |
  | Tahitian |
  | Tajik |
  | Tatar |
  | Thai |
  | Tinpo |
  | Tongan |
  | Tswana |
  | Tun |
  | Turkish |
  | Turkmen |
  | TurkmenLatin |
  | Tuvin |
  | Udmurt |
  | UighurCyrillic |
  | UighurLatin |
  | Ukrainian |
  | UzbekCyrillic |
  | UzbekLatin |
  | Vietnamese |
  | Visayan |
  | Welsh |
  | Wolof |
  | Xhosa |
  | Yakut |
  | Yiddish |
  | Zapotec |
  | Zulu |

  | **Extended Pack - Languages** |
  | --- |
  | ChinesePRC |
  | ChineseTaiwan |
  | Japanese |
  | Korean |
  | KoreanHangul |