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 Async

The Analyze Form Async activity uses the Form Recognizer Analyze Form API to asynchronously 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 operation, the activity outputs the location of the results in a String (Result Location).

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


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

Result Location

The URL containing the Result ID used to track the progress and obtain the result of the operation.

Attributes
Details

Type

String

Required

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

Default value

Empty

Allowed values

Enter a String variable

Notes

  • For more information, see Operation-Location in the Analyze Form API documentation.

Updated 15 days ago


Analyze Form Async


Suggested Edits are limited on API Reference Pages

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