Skip to main content

ExtractorAsyncCodeActivity Class

ExtractorAsyncCodeActivity abstract class, essential for creating an AsyncCodeActivity for data extraction, implements the IExtractorActivity interface and AsyncCodeActivity abstract class.

Definition​

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

Description​

An abstract class that implements the UiPath.DocumentProcessing.Contracts.DataExtraction.IExtractorActivity interface and the System.Activities.AsyncCodeActivity abstract class.

This class must be implemented in order to construct a AsyncCodeActivity for data extraction, compatible with the Data Extraction Scope activity and the document processing infrastructure.

In order to implement this abstract class, the BeginExecute() and EndExecute() methods need to be overridden.

Data extraction parameters and outcomes​

The Data Extraction Scope activity auto-populates all defined InArguments for its child activities. Included in these InArguments are the following information:

  • Information about the document awaiting data extraction. This includes the original file path, the text format, and the document object model.
  • Details about the fields the classifier activity is expected to understand and process. These types are configured via the Data Extraction Scope activity in the Configure Extractors wizard.

The OutArgument houses the extraction results in an ExtractorResult object, which contains a list of DataPoints for every successfully identified requested input field.

Members​

Constructors​

ExtractorAsyncCodeActivity() - The 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 of 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 you want the extractor to use.
  • DocumentBounds InArgument<UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds>
    • The page range and bounds that you want the extractor to use.
  • 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.