Skip to main content

ExtractorNativeActivity Class

The ExtractorNativeActivity abstract class adds functionality to the IExtractorActivity interface and the NativeActivity abstract class, crucial for creating a NativeActivity for document data extraction.

Definition​

  • Namespace: UiPath.DocumentProcessing.Contracts.DataExtraction

Description​

Abstract class that implements the UiPath.DocumentProcessing.Contracts.DataExtraction.IExtractorActivity interface and the System.Activities.NativeActivity abstract class.

This class must be implemented in order to construct a NativeActivity 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(NativeActivityContext context) method needs to be overridden.

Framework for data extraction activity​

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

  • Specific details about the document under extraction, including its original file path, text version, and document object model.
  • Details regarding the fields the extractor activity is expected to process, set by the Data Extraction Scope activity in the Configure Extractors wizard.

The OutArgument holds the extraction results. This is made up of an ExtractorResult object, which contains a DataPoints list with entries for each successfully identified requested input field.

Members​

Constructors​

ExtractorNativeActivity() - 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.