Document Understanding Activities
Last updated Jul 15, 2024

ExtractorCodeActivity Class

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


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.

All the defined InArguments are automatically populated by the Data Extraction Scope Data Extraction Scope activity for all child activities.

The InArguments contain:

Information about the document from which data is to be extracted, specifically the original file path, the text version, and the document object model.

Information about the fields expected to be understood and processed by the extractor activity. These document types are set by the Data Extraction Scope activity after their configuration in the Configure Extractors wizard of the scope activity.

The OutArgument contains the extraction results, in an ExtractorResult object, with as many entries in the DataPoints list as successfully identified requested input fields.


  • ExtractorCodeActivity() - A protected default constructor.
  • 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.
  • 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.
  • Description
  • Members

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.