UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Analyze Receipt

The Analyze Receipt activity uses the Form Recognizer Analyze Receipt API to extract field text and semantic values from a specified receipt document (File Path or File URL).

After completing the operation, the activity outputs the recognition results in an AnalyzeOperationResult object (Response Object) and the understanding results in Receipt[] object (Receipts). Both of these outputs can be used as input variables in subsequent activities (e.g., conditional logic).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Azure Form Recognizer Scope activity to your project.
  3. Add the Analyze Receipt activity inside the Azure Form Recognizer Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter the AnalyzeOperationResult and Receipt[] variables for the Output properties.
  6. Run the activity.
    • Your input properties are sent to the Analyze Receipt API.
    • The API returns the AnalyzeOperationResult and Receipt[] values to your output property variables.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Analyze Receipt

Allowed values

Enter a String or String variable.

Notes

N/A


Input

File URL

The URL to the receipt file that you want to analyze.

Attributes
Details

Type

String

Required

Yes (if FIle Path is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • Enter a value for either File URL or File Path (not both).
  • Supported receipt file formats: PNG, JPEG, TIFF, and PDF (all other format types are ignored).

File Path

The local path to the receipt file that you want to analyze.

Attributes
Details

Type

String

Required

Yes (if FIle URL is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • Enter a value for either File URL or File Path (not both).
  • Supported receipt file formats: PNG, JPEG, TIFF, and PDF (all other format types are ignored).

Common

TimeoutMS

Specifies the amount of time to wait (in milliseconds) for the analyze receipt operation to complete before an error is thrown.

Attributes
Details

Type

Int32

Required

No

Default value

30000ms ((30 seconds) not shown)

Allowed values

Enter a Int32 or Int32 variable.

Notes

N/A


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

IncludeTextDetails

If selected, the result includes text lines and element references.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A

---

Output

Response Object

The operation response as a deserialized object.

Attributes
Details

Type

AnalyzeOperationResult

Required

No (required to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a AnalyzeOperationResult variable

Notes

  • To get the JSON string representation, use the ToString method.

Receipts

The understanding results of the receipt analysis, including the key/value information for the most relevant parts of the receipt.

Attributes
Details

Type

Receipt[]

Required

No (required to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Receipt variable

Notes

  • Each Receipt object includes the following properties that you can use in other activities:
    • Merchant Name
    • Merchant Phone Number
    • Merchant Address
    • Transaction Date
    • Transaction Time
    • Total
    • Subtotal
    • Tax

Updated 15 days ago


Analyze Receipt


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.