Work with OCR and OCR Studio

Optical character recognition or optical character reader (OCR) in Hero_Flow lets users convert images of typed or printed text into machine-encoded text.

Using OCR, users can spend less time and avoid risks associated with human error turning forms into data that can be processed.

Open OCR

Select OCR from the navigation menu.

OCR Overview Page

View the saved OCR functions.

The OCR overview page displays all of the saved OCR functions.

You can view the:

  • OCR function name - Name given to identify the OCR function.
  • Number of versions - The number of different versions for the OCR function.
    • Individual versions can be accessed within the OCR Studio above the layout template image.
  • Created - The date the OCR function was created.
  • Settings:
    • Edit -  Open the function in OCR Studio to edit the model.
    • Clone - Copy the OCR function.
    • Delete -  Delete the OCR function.

Create an OCR Function

To create a new OCR function:

  1. After opening OCR in Hero_Flow, click Create OCR Function.

  2. Enter a name for the OCR function and click Next.

  3. Select a layout template from the file browser by clicking Choose file...
    Click OK.

    An OCR layout template is the reference image to base the OCR readings on for future Input images.

    Supported file types:

    • .jpg
    • .png
    • .pdf

  4. The layout template image is displayed in the OCR Studio.
    The OCR Studio allows users to define the fields where the text to convert is located.

  5. Click Field in the toolbar to define a field to convert the text within.
    Click and drag on the layout template image to create a field in which to convert the text within.

  6. Configure the Add Field form

    Enter a name for the field.
    Select a field type:

    • Typed text - The field searches and registers typed text. (String)
    • Barcode - The field searches and registers a barcode or QR code. 
    • Checkbox - The field searches and registers a single checkbox. (Boolean)
    • Numbers (Typed/Handwritten) - The field searches for numbers that could be typed or handwritten. (String)

    Select an OCR Engine:

    • Hero OCR Engine - The OCR engine software that performs character recognition.

    Click OK to save.

  7. Repeat the process of creating fields for each field on the layout template image to OCR.

  8. Click Save after all needed fields have been created.

Results Preview

The results preview section in the OCR Studio displays the created fields, the OCRed text, and the OCR model's confidence percentage that it is correct.

View the results preview

The results preview is located to the right of the layout template image and can be toggled on/off with the Preview button in the toolbar.

Edit and Delete Fields

Fields created in the OCR Studio can be edited or deleted from the panel on the right under the fields heading.

Edit a field

To edit a field:

  1. Locate the field name in the field panel and click the edit icon.
  2. The field configuration form is displayed and can be edited.
  3. Click OK to save the field configuration.

Delete a field

To delete a field:

  1. Locate the field name in the field panel and click the X icon.
  2. The field is deleted from the OCR Studio layout template image.

No additional warning is displayed for deleting a fields. 

Deleting a field cannot be undone.

Layout Template Images with Multiple Pages

OCR Studio currently does not support multipage images.

Only the first page on the image is used.


Clicking the Settings heading displays the files selected for the OCR model.

Add additional template images to the OCR model

OCR Studio does not currently support multipage images.

Only the first page on the image is used.

OCR Studio Toolbar and Controls


At the top of the OCR Studio, a toolbar is displayed.

  • Save - Select to save the OCR function at the current progression. 
    • Saved OCR function are displayed on the OCR overview page.
  • Field - Select to create a field on the layout template image.
  • Zoom in - Zoom in on the layout template image.
    • Keyboard shortcut - option+mouse wheel
  • Zoom out - Zoom out on the layout template image.
    • Keyboard shortcut - option+mouse wheel
  • Preview - Toggles the results preview panel and resets the layout template image to the starting position.

Use an OCR Function in a Flow

After an OCR function has been saved, it can be used as a function in a Flow.

To use an OCR function in a Flow:

  1. Open and start creating a Flow in the Flow Studio.
  2. View the OCR functions in the element browser.
  3. Click and drag an OCR function from the element browser onto the Flow Studio canvas.
  4. Connect the OCR function using a cable from an element in the Flow.
  5. Configure the fields for the OCR function.
  6. Click OK to finish adding the OCR function to the Flow.

OCR Snippet Outputs

After adding a OCR function in a Flow, the fields created in the OCR Studio are available to use an output field in the Output. This type of field is called a snippet.

A snippet is an image (Binary data type) of what OCR captures from the fields created in the OCR studio.