Overview
Overview
The target image can be read into text or tables using the OCR engine provided by the Microsoft OCR Library.
Microsoft OCR is an open-source-based OCR engine and can be used locally without a separate OCR server.
If the corresponding language pack is not installed, add the language in Settings > Language Settings in Windows.
The features provided by the Microsoft OCR library are as follows:
Extract image information: GetImageText, GetImageTextInfo, GetTextOnFile, GetTextInfoOnFile
Mouse action features: TextClick, TextDoubleClick, TextRightClick, TextHover
Image capturing feature: GetTextBound
Image recognition features: WaitTextAppear, WaitTextDisappear
The Microsoft OCR library samples can be referenced using the designer or Windows Explorer.
• Designer Path: > Help > Samples > Sample > MicrosoftOCR
• Windows Explorer path: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\MicrosoftOCR
Common Properties
Common Properties
IMAGE
Information (size/position) of the captured image is displayed.
Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|
Image | Image | Y | - | Y | View captured images. |
Bounds | String | Y | - | Y | Shows the specified position and size of the target UI object as relative coordinates based on the screen. (Unit: Pixel) Example> '0,0,100,100' You can also specify it as a variable. |
OCR
You can enter settings related to OCR.
Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|
Output | Variable | Y | - | Y | Specifies the variable to store the OCR result. |
Language | Combo Box | Y | - | Y | Specifies the language of the document you want to read. You must select all languages included in the target. |
FilePath | String | Y | - | Y | Specifies the path of the OCR target file. Only png, jpg, and bmp files are allowed. |
Scale | Number | N | % | N | Specifies the scale (%) to scale the original image when performing OCR. If there is no input value, an Auto-scale value is applied. |
MORE OPTIONS
Properties | Type | Required | Unit | Auto-Setting | Description |
|---|---|---|---|---|---|
DrawBounds | Toggle button | N | - | Y | Specifies whether to draw the area to be recognized. |
On Error | Combo box | N | - | N | Select the processing method for occurred errors: - Ignore: Ignore the error and proceed. - Retry: Try the task one more time. - Goto: Try the scenario for the specified time if the activity fails. - Event: Select an event created within the project. |
DESCRIPTION
Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|
DESCRIPTION | Text | N | - | N | Enter the description for the activity card. The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input. |
GetImageText
GetImageText
Overview
This activity card has the function of converting characters in the image to text.
Application procedures
Double-click No Target on the activity card.
Specify the range of target images to extract text from.
In the [Output] field, enter a variable to save the text extracted from the area of the image specified in Output.
In the Properties window, specify other required properties.
Card output properties
Property | Type | Additional Comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Returns the characters in the image converted to text. | 'Google' |
Card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Descriptions |
|---|---|---|---|---|---|---|
Y | Bounds | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Image | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Language | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_GetImageText_Test
GetImageTextInfo
GetImageTextInfo
Overview
This activity card recognizes characters in a specified image and returns image information (height, width, etc.) and text.
Application procedures
Double-click No Target on the activity card .
Specify the range of target images to extract text from.
In the [Output] Output field, enter a variable to save the image information obtained from the image area specified in Output.
Specify the desired values for the other properties.
Card output properties
Properties | Type | Additional Comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Recognizes characters in an image and returns image information (height, width, etc.) and text. | 'Bounds(0,0,270,89)-Text(Google)' |
Card input properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
Y | Bounds | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Image | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Language | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_GetImageTextInfo_Test
Text info result value output in the example
Bounds: Boundary area on the screen of text
Bounds(1678,25,32,10)-Text(Gmail)
Bounds(1727,26,36,12)-Text(Olga))
Bounds(824,198,270,89)-Text(Google)
Bounds(845,406,44,13)-Text(Google)
Bounds(908,404,12,13)-Text(B44)
Bounds(968,406,17,10)-Text(I'm)
Bounds(990,406,45,13)-Text(Feeling)
Bounds(1040,406,35,13)-Text(Lucky)
Bounds(32,891,57,14)-Text(cystels)
Bounds(31,935,26,13)-Text(aa)
Bounds(87,935,53,13)-Text(HIZUx)
Bounds(169,937,44,13)-Text(Google)
Bounds(218,935,26,13)-Text(3)
Bounds(273,935,36,13)-Text(Bxe|)
Bounds(319,935,25,13)-Text(aay)
Bounds(1669,935,109,13)-Text(MASA)
Bounds(1740,930,9,25)-Text(Al)
Bounds(1754,930,28,25)-Text(etal)
Bounds(1808,935,27,13)-Text(oat)
Bounds(1863,935,25,13)-Text(aa)
GetTextOnFile
GetTextOnFile
Overview
This activity card recognizes the text of a specific image file and reads it as a string.
Application procedures
In the [Output] field, enter a variable to save the file's text extracted through OCR in Output.
Enter the file's path and name to extract text from in FilePath.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional Comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Returns the characters in an image file as text. | 'Google' |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | FilePath | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Language | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_GetTextOnFile_Test
GetTextInfoOnFile
GetTextInfoOnFile
Overview
Recognizes characters in a specific image file and returns image information (position, height, width) and text information.
Application procedures
In the [Output] field, enter variables to store the text and image information of the file extracted through OCR.
In the FilePath field, enter the path and file name of the file to extract text and image information from.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Recognizes characters in an image and returns image information (height, width, etc.) and text. | 'Bounds(0,0,270,89)-Text(Google)' |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | FilePath | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Language | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_GetTextInfoOnFile_Test
Text info result value output in the example
Bounds: Boundary area on the screen of text
Bounds(509,56,237,39)-Text(INVOICE)
Bounds(62,185,52,21)-Text(Date)
Bounds(124,192,4,14)-Text(:)
Bounds(138,185,127,21)-Text(2019.12.03)
Bounds(917,185,129,21)-Text(SAMSUNG)
Bounds(1055,185,51,21)-Text(SDS)
Bounds(1115,186,75,20)-Text(CORP.)
Bounds(62,216,95,26)-Text(Request)
Bounds(165,216,91,21)-Text(Number)
Bounds(264,223,4,13)-Text(:)
Bounds(277,216,99,20)-Text(#100000)
Bounds(148,338,66,22)-Text(DATE)
Bounds(440,338,60,22)-Text(ITEM)
Bounds(659,338,113,22)-Text(AMOUNT)
Bounds(917,338,175,22)-Text(DESCRIPTION)
Bounds(118,412,126,20)-Text(2019.11.29)
Bounds(429,412,84,21)-Text(TEMA)
Bounds(703,412,27,22)-Text(10)
Bounds(958,412,72,22)-Text(DESC)
Bounds(1038,412,9,21)-Text(1)
Bounds(118,485,126,20)-Text(2019.11.30)
Bounds(428,486,84,20)-Text(ITEMB)
Bounds(701,491,30,19)-Text(20)
Bounds(958,485,92,21)-Text(DESC)
Bounds(1037,481,16,37)-Text(2)
Bounds(118,559,124,21)-Text(2019.12.01)
Bounds(427,559,87,21)-Text(ITEMC)
Bounds(958,559,72,21)-Text(DESC)
Bounds(1037,559,13,21)-Text(3)
Bounds(700,567,29,18)-Text(30)
Bounds(117,632,128,20)-Text(2019.12.02)
Bounds(427,632,87,22)-Text(ITEMD)
Bounds(700,635,31,18)-Text(40)
Bounds(958,632,72,22)-Text(DESC)
Bounds(1036,632,14,22)-Text(4)
FindTextOnFile
FindTextOnFile
Overview
This activity card finds the specified text in a specific image file and returns its location.
Application procedures
In the [Output] Output field, enter a variable to store the location of the text found through OCR.
Enter the text you want to find in Target Text.
In the Bounds field, enter the specific area within the image file where you want to find text.
Enter the path and file name of the original image file in the Source File Path.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comments | Description | Example |
|---|---|---|---|---|
Output | Rect | - | Returns information about the bounds of the found text.※ X, Y, Width, Height | 774,575,52,19 |
card input properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
Y | Image | Bounds | - | - | - | Common properties of the Microsoft OCR library. |
N | Source File Path | String | Y | - | - | Enter the path and file name of the original image file. |
N | Target Text | String | Y | - | - | Enter the text you want to find in the image file. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_FindTextOnFile_Test
TextClick
TextClick
Overview
This activity card finds specific specified text in the image and clicks it.
Application procedures
Double-click No Target on the activity card.
Specify a range of target images to click.
In the [Output] Output field, enter a variable to save the execution result in Output.
In the OCR group properties, enter the percentage of the original image size and the phrase to search for.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comment | Description | Example |
|---|---|---|---|---|
Output | String | - | Position and size (width, height, width, height) of the target UI object retrieved from the Microsoft OCR engine. | 7,11,47,14 |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | Bounds | - | - | - | Common properties of the Microsoft OCR library. | |
N | Target Text | String | Y | - | - | Specify what to search for and click. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_TextClick_Test
TextDoubleClick
TextDoubleClick
Overview
This activity card finds the specific text in the image and double-clicks it.
Application procedures
Double-click No Target on the activity card.
Specify the range of the target image to double-click.
In the [Output] Output field, enter a variable to save the execution result in Output.
In the OCR group properties, enter the percentage of the original image size and the phrase to search for.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comment | Description | Example |
|---|---|---|---|---|
Output | String | - | Position and size (width, height, width, height) of the target UI object retrieved from the Microsoft OCR engine | 7,11,47,14 |
card input properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
Y | Image | Bounds | - | - | - | Common properties of the Microsoft OCR library. |
N | Target Text | String | Y | - | - | Specify what to search for and click. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_TextDoubleClick_Test
TextRightClick
TextRightClick
Overview
This activity card finds a specific specified text in the image and right-clicks on it.
Application procedures
Double-click No Target on the activity card.
Specify the range of the target image to right-click.
In the [Output] Output field, enter a variable to save the execution result in Output.
In the OCR group properties, enter the percentage of the original image size and the phrase to search for.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Position and size (width, height, width, height) of the target UI object retrieved from the Microsoft OCR engine | 7,11,47,14 |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | Image | Bounds | - | - | - | Common properties of the Microsoft OCR library. |
N | Target Text | String | Y | - | - | Specify what to search for and click. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_TextRightClick_Test
TextHover
TextHover
Overview
This activity card finds specific text in the image and hover the mouse pointer over it.
Application procedures
Double-click No Target on the activity card.
Specify the range of the target image to place the mouse pointer on.
In the [Output] Output field, enter a variable to save the execution result in Output.
In the OCR group properties, enter the percentage of the original image size and the phrase to search for.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comments | Description | Example |
|---|---|---|---|---|
Output | String | - | Position and size (width, height, width, height) of the target UI object retrieved from the Microsoft OCR engine | 7,11,47,14 |
card input properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
|---|---|---|---|---|---|---|
Y | Image | Bounds | - | - | - | Common properties of the Microsoft OCR library. |
N | Target Text | String | Y | - | - | Specify what to search for and click. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample > P_TextHover_Test
GetTextBound
GetTextBound
Overview
This activity card finds specific text in an image and get the coordinate information of that area.
Application procedures
Double-click No Target on the activity card.
Specify the range of images to get area information from.
In the [Output] Output field, enter a variable to save the execution result in Output.
In the OCR group properties, enter the percentage of the original image size and the phrase to search for.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comment | Description | Example |
|---|---|---|---|---|
Output | String | - | Position and size (width, height, width, height) of the target UI object retrieved from the Microsoft OCR engine | 7,11,47,14 |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | Image | Bounds | - | - | - | Common properties of the Microsoft OCR library. |
N | Target Text | String | Y | - | - | Specifies what to search for and get realms from. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample >P_GetTextBound_Test
WaitTextAppear
WaitTextAppear
Overview
This activity card waits for the specified character to appear in the image.
Application procedures
Double-click No Target on the activity card.
Specify the range of images to find.
In the [Output] Output field, enter a variable to save the result of the specified text in Output.
Specify the desired values for the other properties.
card output properties
Property | Type | Additional comment | Description | Example |
|---|---|---|---|---|
Output | Boolean | - | Returns results where the specified text appears.※ true if text appears, false otherwise | true |
card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | Bounds | - | - | - | Common properties of the Microsoft OCR library. | |
N | Target Text | String | Y | - | - | Enter the text to wait for. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response. (Sec) |
Y | Image | Image | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Language | - | - | - | Common properties of the Microsoft OCR library. |
Y | OCR | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample >P_WaitTextAppear_Test
WaitTextDisappear
WaitTextDisappear
Overview
This activity card waits for the specified character to disappear from the image.
Application procedures
Double-click No Target on the activity card.
Specify the range of images to find.
In the [Output] Output field, enter a variable to save the result of the disappearance of specific text in Output.
Specify the desired values for the other properties.
Card output properties
Property | Type | Additional comments | Description | Example |
|---|---|---|---|---|
Output | Boolean | - | Returns results where the specified text is missing.※ true if text disappears, false otherwise | False |
Card input properties
Common | Properties | Type | Required | Unit | Auto-settings | Description |
|---|---|---|---|---|---|---|
Y | Bounds | - | - | - | Common properties of the Microsoft OCR library. | |
N | Target Text | String | Y | - | - | Specifies the text to wait for. |
N | Index | Number | N | - | - | If two or more identical strings are found in the specified area, enter a number to select the number of strings. |
N | Timeout | Number | Y | Sec | Y | Enter the amount of time to wait for a response (Sec) |
Y | Image | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Language | - | - | - | Common properties of the Microsoft OCR library. | |
Y | Scale | - | % | - | Common properties of the Microsoft OCR library. |
Sample file
Menu > Help > Sample > Sample > MicrosoftOCR > MicrosoftOCR_Sample >P_WaitTextDisappear_Test