Get Document Analysis

The Get Document Analysis activity uses the Amazon Textract GetDocumentAnalysis API to asynchronously retrieve the result of a document analysis operation (JobId). If the document analyzed includes a table, you have the option to indicate if the first row contains column headers (DiscoverColumnHeaders) and/or ignore empty rows in the table (IgnoreEmptyRows).

After retrieving the document analysis, the activity returns the document properties in a PageDetail[] object that you can use as input variables in other activities outside of the Amazon Textract Activities Package.

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 Amazon Scope activity to your project.
3. Add an activity or run an external process that outputs a JobId value (e.g., Start Document Analysis.
4. Add the Get Document Analysis inside the *Amazon Scope activity.
5. Enter values for the Input properties.
6. Create and enter a PageDetail[] variable for your Output property.

7. Run the activity.

   • Your input properties are sent to the GetDocumentAnalysis API.
   • The API returns the PageDetail[] value to your output property variable.
     
     

     

     
     

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	Get Document Analysis
Allowed values	Enter a String or String variable.
Notes	N/A

Input

JobId

The identifier assigned to the document analysis process that you want to retrieve.

Attributes	Details
Type	String
Required	No (recommended if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a String or String variable
Notes	To get the JobId String value, use an external process or activity that includes the JobID value in its output (e.g., Start Document Analysis or external API call)

Options

DiscoverColumnHeaders

Indicates whether the tables in the document include column headers.

Attributes	Details
Type	Checkbox
Required	No
Default value	Not Selected
Allowed values	Selected or Not Selected
Notes	N/A

IgnoreEmptyRows

Indicates whether empty rows in the document tables should be ignored when analyzing the document.

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

Pages

The properties extracted from the analyzed document(s).

Attributes	Details
Type	PageDetail[]
Required	No (recommended if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a PageDetail[] variable
Notes	See Page Detail for the description of the of the PageDetail object and its properties.

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.