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 Form

The Analyze Form activity uses the Form Recognizer Analyze Form API to extract key-value pairs and table data from a specified document (File Path or File URL) using a specified training model (Model Id).

After completing the analyze form operation, the activity outputs the results in an AnalyzeOperationResult object (Response Object) and a Page[] object (Pages). 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 Form activity inside the Azure Form Recognizer Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter the AnalyzeOperationResult and Page[] variables for the Output properties.
  6. Run the activity.
    • Your input properties are sent to the Analyze Form API.
    • The API returns the AnalyzeFormResponse and FormPage[] 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 Form

Allowed values

Enter a String or String variable.

Notes

N/A


Timeout

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

Yes

Default value

30000ms ((30 seconds) not shown)

Allowed values

Enter a Int32 or Int32 variable.

Notes

N/A


Input

File Path

The local path to the form document 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

  • Supported form document formats: .json, .pdf, .jpg, .png, and .tiff (all other format types are ignored).

File URL

The URL to the form document 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

  • Supported form document formats: .json, .pdf, .jpg, .png, and .tiff (all other format types are ignored).

Model Id

The identifier of the training model that you want to use to analyze the form.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the Model Id value, add an activity or run an external process that outputs the model identifier (e.g., Train Model, Get Models).

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


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


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.
  • If the model can't find a field, a null value is returned.

Pages

The results of the form analysis, including the key-value pairs and table information extracted from the page.

Attributes
Details

Type

Page[]

Required

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

Default value

Empty

Allowed values

Enter a Page[] variable

Notes

  • Each Page object includes KeyValuePairs and Tables properties.

Updated 15 days ago


Analyze Form


Suggested Edits are limited on API Reference Pages

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