Get Number

The Get number building block retrieves a number from the screen, either from the entire screen or from a specified Area. You can apply formatting and filtering rules so only numbers matching your requirements are returned (for example, a number embedded in Price: [NUMBER] USD, or only numbers less than or equal to a threshold).

See the Use Numbers and Variables and Capture text on screen lessons for examples of how this works.

Fully expanded, the Get number block shows the following properties:

Note: The screenshot on this page uses the Elegance Design, introduced in 2025.3. If you are using an earlier version, your layout may look different.

Quick-start

1. Drag Get number onto the canvas.
2. Connect the block in the flow and specify Area (or leave it empty to search the whole screen). Optionally configure Find format, separators, OCR settings (Engine, OCR Mode, OCR Precision), and Filter. Set Use occurred if you expect multiple matches, and configure timeout-related settings if needed.
3. Run the flow when it's ready.

Building block parameters

Parameters

• Block header : The green input connector triggers the block to start executing. The green output connector triggers when the number has been retrieved. If Use occurred is set to All, the green output connector triggers for each occurrence until all occurrences are iterated through. You can rename the block by double-clicking the header text and typing a new title.

• Area : Defines where the block searches for a number using X, Y, Width, Height coordinates, starting from the upper-leftmost pixel. The top-left corner of the screen is 0, 0. If no area is defined, the entire screen is searched. You can enter values manually or right-click and select Capture area. Use the expander to work with position and size and their nested sub-properties separately.

• Number found : Outputs the number retrieved from the screen, subject to any Find format and Filter settings.

• Not found : Triggers if a number is not found before the timeout, subject to any formatting and filtering settings. This is typically used to branch the flow or explicitly fail a case by linking it to a Fail block.

• Position found : Outputs the screen position where the number was found as X, Y coordinates. The top-left corner of the screen is 0, 0.

Note that this position is the middle of the retrieved number, not the upper-leftmost pixel of the text. Use the expander to work with X and Y separately.

• Area found : Outputs the screen area where the number was found as X, Y, Width, Height, starting from the upper-leftmost pixel. The top-left corner of the screen is 0, 0. Use the expander to work with position and size and their nested sub-properties separately.

• Find format : Defines a format the number must match in order to be retrieved. For example, with Price: [NUMBER] USD, only numbers inside text such as Price: 123.00 USD are retrieved.

• 1000 separator : Defines the character used to separate thousands in the number. The default is taken from Flow's Windows regional settings (typically , or .).

• Decimal separator : Defines the character used to separate decimals in the number. The default is taken from Flow's Windows regional settings (typically , or .).

• Is case sensitive : Controls whether number recognition should be case sensitive. By default, it is case insensitive.

• Engine : Selects the OCR engine used for text recognition. Supported options include OCR 1.0, OCR 2.0, and ABBYY.

• OCR Mode: Selects the OCR recognition strategy.

• Full mode: Runs four recognition tries in parallel using two different modes (two normal and two inverted colors).

• Fast speed : Runs two recognition tries in parallel (one normal and one inverted colors).

• OCR Precision: Controls how strict OCR recognition is on a character level. Higher precision requires higher confidence before a character is accepted, which can reduce false positives but may also miss characters. Lower precision typically returns more characters but with lower assurance. The best setting depends on font, colors, background, and text size.

• High : Highest confidence/precision. Predefined value is 70.

• Medium : Medium confidence/precision. Predefined value is 50.

• Low : Low confidence/precision. Predefined value is 30.

• Very Low : Lowest confidence/precision. Predefined value is 20.

• Custom : Sets a custom confidence value from 0--100. A value of 0 returns everything recognized, and 100 returns the best possible recognized result.

If the built-in OCR engine does not meet requirements, ABBYY can be used. Contact Customer Success to get started with ABBYY.

• Filter : Defines an additional rule the number must meet to be retrieved (for example, only retrieve numbers that are Greater than 100).

• Filter value : The value used by the selected Filter.

• Use occurred : Selects which occurrence to use if more than one matching number is found. Select All to iterate through all occurrences. When All is selected, Current index and Completed are shown.

• Current index : Outputs the current index while iterating through all occurrences of the number on screen (for example 1, then 2, then 3).

• Completed : Triggers when iteration through all occurrences has completed.

• Default timeout : Controls whether the block uses the default timeout from the flow settings or a custom timeout value.

• Timeout (sec) : Sets the maximum time spent searching for the number before the block gives up and triggers Not found. The default value is 20 seconds. This field is used when Default timeout is not selected.

Note: All cases have a global timeout configured in the Settings panel. This is unrelated to the timeout of a single building block. However, a running case will automatically be cancelled if it runs for longer than the global timeout.

• Scroll to find : Controls whether the block scrolls while searching for the number. This can be useful when searching in scrollable pages and documents.

• Max repeats: Sets the maximum number of scroll attempts before the block stops searching.

• Amount : Sets how much scrolling is performed on each repeat.

• Delay (sec) : Sets the delay in seconds between each scroll amount.

• Await no movement : Delays the search until there has been no movement on the screen for a specified period (for example, two seconds). This is useful when waiting for a screen update (such as a page loading). Regardless of this checkbox, the search occurs after waiting a maximum of 30 seconds.

• Await Timeout: The number of seconds the screen must have seen no movement before proceeding.

Resources