activities
latest
false
Document Understanding Activities
Last updated Oct 8, 2024

ExtractorCodeActivity Class

ExtractorCodeActivity abstract class, a combination of the IExtractorActivity interface and the CodeActivity abstract class, is cardinal for constructing a CodeActivity for document data extraction.

Definition

  • Namespace: UiPath.DocumentProcessing.Contracts.DataExtraction
  • Assembly: UiPath.DocumentProcessing.Contracts

Description

Abstract class that implements the UiPath.DocumentProcessing.Contracts.DataExtraction.IExtractorActivity interface and the System.Activities.CodeActivity abstract class.
This class is implemented in order to construct a CodeActivity for document data extraction, compatible with the Data Extraction Scope activity and the document processing infrastructure.
In order to implement this abstract class, the Execute(CodeActivityContext context) method needs to be overridden.

Data extraction activity parameters and results

The Data Extraction Scope activity automatically populates all defined InArguments for its child activities. These InArguments include the following information:

  • Specific details about the document under extraction. This includes its original file path, text version, and document object model.
  • Details about the fields that the extractor activity is expected to process. These are configured via the Configure Extractors wizard in the Data Extraction Scope activity.
The OutArgument houses the extraction results. This is composed of an ExtractorResult object, containing a DataPoints list with entries for all successfully identified input fields.

Members

Constructors
ExtractorCodeActivity() - A protected default constructor.
Methods
  • GetCapabilities() - Gets a list of fields the extractor is capable of extracting, for each document type, at design time. This method will only be called at design time, and as such it should NOT use any InArgument(s)
  • ProvidesCapabilities() - Returns true if the extractor is able to provide a list of capabilities.
Properties
  • DocumentPath InArgument<string> - The file path to the document.
  • DocumentText InArgument<string> - The text version of the document.
  • DocumentObjectModel InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> - The document object model of the document.
  • ExtractorDocumentType InArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentType> - The document type information that the extractor takes into account.
  • DocumentBounds InArgument<UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds> - The page range and bounds that the extractor takes into account.
  • ExtractorResult OutArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorResult> - The output of the extractor activity.
  • PersistenceId string - The unique, opaque ID that is used by the scope activities in order to correctly track and configure the extractor activity.
  • PredictionId InArgument<string> - Identifies that the same document is processed in a workflow. It's composed of DocumentId+ JobId.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.