Skip to main content

IExtractorActivity Interface

IExtractorActivity is a public interface inheriting the IPersistedActivity interface, that defines the InArguments and the OutArguments expected from an extractor activity.

Definition​

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

Description​

A public interface inheriting the IPersistedActivity interface, that defines the InArguments and the OutArguments expected from an extractor activity.

This interface must not be directly implemented. When building an extractor activity, use one of the provided abstract classes: ExtractorCodeActivity, ExtractorNativeActivity, or ExtractorAsyncCodeActivity.

Members​

Methods​

  • GetCapabilities(System.Threading.Tasks.Task<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentTypeCapabilities[]>
    • A method that needs to be implemented if the extractor activity can declare its own capabilities (such as document types it can process and associated fields that the extractor can target, based on its internal taxonomy). This method is called at design time. If necessary, the extractor activity can implement any functionality (including UI) in order to collect information from the user at design time, so that it can compute and report the 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 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.