Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Use the ReadBarcode component

Read a single barcode and return its contents by using the ReadBarcode component in RPA Desktop Design Studio.

Before you begin

Add the Barcode Reader plugin from the Plugins Manager before using the connector. For more information about adding the SSH plugin, see Manage plugins in RPA Desktop Design Studio.

Role required: none

About this task

The ReadBarcode component reads a single barcode from an image file that it receives from another component.

The ReadBarcode component can return both the value and the encoding type (format) of the barcode. The encoding value that the Type parameter returns may be one of the following supported formats:

  • AZTEC
  • CODABAR
  • CODE_39
  • CODE_93
  • CODE_128
  • DATA_MATRIX
  • EAN_8
  • EAN_13
  • ITF
  • MAXICODE
  • PDF_417
  • QR_CODE
  • RSS_14
  • RSS_EXPANDED
  • UPC_A
  • UPC_E
  • All_1D
  • UPC_EAN_EXTENSION
  • MSI
  • PLESSEY
  • IMB
  • PHARMA_CODE

If the component can't read the barcode, it returns an error.

Procedure

  1. In the Toolbox pane, navigate to Utilities > Barcode.

  2. Drag the ReadBarcode component to the Design surface.

  3. Confirm the configuration of the component's input fields.

    For more information, see Configure port properties.

  4. Connect the data and control ports of the ReadBarcode component to the corresponding ports of the other components as described in the following table.

    PortDescriptionPort typeData typeRequired
    ImageReceives an image that contains a barcodeData InBitmapYes
    TypeReturns the barcode typeData OutStringYes
    ResultReturns the encoded value of the barcodeData OutStringYes

    To test the component, on the Design tab, select Run.

Parent Topic:Barcode