- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
Start document analysis
The Start Document Analysis activity uses the Amazon Textract StartDocumentAnalysis API to asynchronously start the analysis of a document (DocumentName and Version) stored in an Amazon S3 bucket (Bucket).
After starting the document analysis, the activity returns the identifier assigned to the document analysis process as a String (JobId) that you can use as an input variable in the Get Document Analysis Status and Get Document Analysis activities.
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Amazon Scope activity to your project.
- Add the Start Document Analysis inside the Amazon Scope activity.
- Enter values for the S3 Storage input properties.
- Create and enter a
Stringvariable for your Output property. - Run the activity.
-
Your input properties are sent to the StartDocumentAnalysis API.
-
The API returns the
Stringvalue 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 | Start Document Analysis |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
S3 Storage
Bucket
The name of the S3 bucket where the document is stored.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | The AWS Region for the S3 bucket that contains the document must match the Region that you selected in the Amazon Scope activity. For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket; for more information, see step 6 in the Create IAM User section of the Setup guide. |
DocumentName
The case-sensitive name of the file in the specified Bucket that you want to start analyzing.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | Supported document formats: PNG, JPEG, and PDF. |
Version
If the bucket has versioning enabled, you can specify the object version.
| Attributes | Details |
|---|---|
| Type | String |
| Required | No |
| Default value | Empty |
| Allowed values | Enter a String or String 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 |
Output
JobId
The identifier assigned to the document analysis process.
| 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 variable |
| Notes | The variable you create for this property can be used as an input variable in the Get Document Analysis Status and activities. A JobId value is only valid for 7 days. |
Options
AnalysisType
Specifies the types of analysis to perform. Use Tables to return information about the tables that are detected in the input document and Forms to return detected form data.
| Attributes | Details |
|---|---|
| Type | enum |
| Required | No. |
| Default value | All |
| Allowed values | All, Tables, Forms |
| Notes | N/A |
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 guides.
