getBarCodeText Step

Use this feature to read a barcode from a specified file and return the decoded barcode value as text in a FlowWright Variable or Global variable.

Last published at: September 16th, 2026

Description:

The GetBarcodeText workflow step reads a barcode from a specified file and returns the decoded result as text.

The step supports:

  • Specifying the barcode file path.
  • Storing the decoded barcode text in a Variable or Global variable.
  • Optionally selecting the barcode type to decode.
  • Returning a True or False result for subsequent workflow processing.

 

Inputs

  • Barcode file path – The barcode file path property specifies the path to the file containing the barcode that should be read.
  • Select barcode type – The Select barcode type property specifies the barcode decoding type to be used.
  • Variable/Global to hold the text – The Variable/Global to hold the text property specifies the Variable or Global variable where the decoded barcode result is stored.
 

 

Returns

  • True – The True return path can be connected to the next workflow activity when the barcode-reading operation succeeds.
  • False – The False return path can be used for an alternative workflow path or error-handling logic when the barcode-reading operation does not succeed.
 

 

Usage:

The GetBarcodeText step is typically placed after a workflow has obtained a barcode-containing file and needs to extract the barcode value as text.

A typical workflow pattern is:

Obtain Barcode File → Get Barcode Text → Process Barcode Value

The decoded value can then be used by later workflow activities to:

  • Identify a document or item.
  • Populate a workflow Variable.
  • Perform workflow routing.
  • Search for a corresponding database record.
  • Validate an identifier.
  • Build a notification.
  • Pass the barcode value to another system.
  • Continue document-processing automation.
  • Perform additional text processing.

 

 

Typical Workflow Suggestions:

Read a Barcode from an Uploaded File

Use the step after a file has been uploaded or otherwise made available to the workflow.

Example:

File Upload → Get Barcode Text → Process Barcode

Configure the barcode file path with the location of the barcode-containing file and store the decoded value in a Variable or Global variable.

 

Extract an Identifier from a Barcode

Use GetBarcodeText when the barcode contains an identifier that can be used later in the workflow.

Example:

Scan Document → Get Barcode Text → Retrieve Record

For example, a barcode could represent an order, invoice, shipment, or document identifier.

You can then pass the retrieved text to a subsequent database or business-processing activity.

 

Use the Barcode to Retrieve a Database Record

You can use the decoded barcode value as input to subsequent database processing.

Example:

Get Barcode Text → GetDBFieldValue → Process Record

A typical pattern is:

  1. Read the barcode.
  2. Store the decoded text.
  3. Use the decoded value as a record identifier.
  4. Retrieve or process the corresponding database record.

 

Route a Workflow Based on the Barcode Value

Use the decoded barcode text as an input to subsequent workflow decision logic.

Example:

Get Barcode Text → Evaluate Barcode → Route Workflow

For example, different barcode prefixes or identifiers can follow different workflow paths.

 

Specify the Barcode Type

Use Select barcode type when the workflow needs to specify the barcode decoding type.

Example:

Barcode File → Get Barcode Text → Process Result

Configure:

Barcode file path: Barcode image file

Select barcode type: Appropriate barcode type

The barcode-type property is optional in the XML.

 

Store the Decoded Barcode for Reuse

Store the result in a Variable or Global variable when multiple subsequent activities need access to the barcode value.

Example:

Get Barcode Text → Store Barcode Value → Multiple Subsequent Steps

The step provides a dedicated required property for storing the decoded text.

 

Validate a Document Identifier

Use the decoded barcode value in a document-validation workflow.

Example:

Get Document → Get Barcode Text → Validate Identifier → Continue Processing

You can compare the retrieved text with expected workflow or database information in subsequent activities.

 

Process Scanned Documents

Use the step as part of an automated document-processing workflow.

Example:

Receive Scanned Document → Get Barcode Text → Identify Document → Process Document

The barcode can provide information that helps the workflow identify or route the document.

 

Prepare Data for an Integration

Use the decoded barcode text as input to a downstream integration.

Example:

Get Barcode Text → Prepare Integration Data → External System

The stored barcode value can be passed to another workflow activity or integration component.

 

Generate a Notification from Barcode Information

Use the retrieved barcode value when constructing a notification.

Example:

Get Barcode Text → Process Barcode → Send Notification

You can incorporate the barcode value into a message or use it to identify the item associated with the notification.

 

Handle Barcode Processing Failure

Use the False path to handle situations in which the barcode cannot be successfully processed.

Example:

                         ┌── True → Process Barcode
Start → Get Barcode Text
                         └── False → Handle Failure
The XML explicitly defines True and False return values.

 

Example:

Let’s build and execute the “getBarcodeTextDef” example.          

  • Create a new process definition named “getBarcodeTextDef” and open it in designer mode.
  • Drag a “getBarcodeText” step to the canvas.
  • Connect the dots between the “Start” and “getBarcodeText” steps, as shown above. 
  • Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
  • Define a variable or a global to store the result.
  • Click the "getBarcodeText" step to configure its "Required" properties. Provide a name for the step. Provide the path to a barcode image file on the application server. Provide a variable or a global reference to store the result text. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

  • Click the "getBarcodeText" step to configure its "Optional" properties. Select the barcode type from the drop-down list, then click Save. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and execute it. Render the process instance and click the GetBarcodeText step to view its properties. When the workflow reaches the GetBarcodeText step, FlowWright uses the configured barcode file path to read and decode the barcode. If a barcode type has been configured, that selection is used as part of the barcode decoding configuration. The resulting barcode value is stored in the Variable or Global variable configured in Variable/Global to hold the text. The workflow can then continue through the True path or use the False path for alternative or error-handling processing.

 

Tips:

  • Always provide a valid barcode file path before executing the step.
  • Verify that the specified file is accessible to the FlowWright execution environment.
  • Ensure that the file contains a barcode that can be decoded.
  • Configure a meaningful Variable or Global variable for the decoded text.
  • Verify the stored barcode value after the step executes.
  • Use Select barcode type when the workflow needs to specify a particular decoding type.
  • Confirm the available barcode-type choices in the FlowWright Designer before documenting a specific barcode type.
  • Test the workflow with representative barcode files.
  • Test different barcode images that the workflow is expected to process.
  • Test the workflow with an invalid or unreadable barcode file.
  • Also test the workflow when the specified file cannot be accessed.
  • Connect the True path to normal barcode processing.
  • Connect the False path to appropriate error-handling or alternative processing.
  • Use meaningful Variable names such as varBarcodeText.
  • Verify downstream activities against the actual decoded text returned by the step.
  • Test barcodes containing the types of values expected by the business process.
  • If the barcode value is used as a database identifier, validate it before performing the database operation.
  • If the barcode value is passed to an external system, validate the value before sending it.
  • Avoid logging sensitive barcode values unnecessarily.
  • Test the workflow after changing the barcode type configuration.
  • Test the workflow after changing the source file-generation or upload process.
  • Do not assume the exact list of supported barcode types unless confirmed from the FlowWright Designer.
  • Do not assume that every barcode image will decode successfully; image quality, barcode characteristics, and configuration can affect decoding.
  • Do not assume the exact format of the returned barcode text beyond the step's documented purpose of providing the barcode result in text format.

 

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page, following the same approach described in the supplied SearchAndReplaceString documentation.

Note: Verify and complete any missing configuration after importing the sample, including:

  • Barcode file path.
  • Variable or Global variable used to store the decoded barcode text.
  • Barcode type, if required.
  • Workflow Variable references.
  • Environment-specific file-storage configuration.
  • File-access permissions.
  • Downstream True and False workflow paths.
  • Any database, document, notification, or integration activities that consume the decoded barcode value.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.