Activities
latest
false
- Overview
- Document Processing Contracts
- About the Document Processing Contracts
- Box Class
- IPersistedActivity Interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- ICapabilitiesProvider Interface
- IExtractorActivity Interface
- ExtractorPayload Class
- DocumentActionPriority Enum
- DocumentActionData Class
- DocumentActionStatus Enum
- DocumentActionType Enum
- DocumentClassificationActionData Class
- DocumentValidationActionData Class
- UserData Class
- Document Class
- DocumentSplittingResult Class
- DomExtensions Class
- Page Class
- PageSection Class
- Polygon Class
- PolygonConverter Class
- Metadata Class
- WordGroup Class
- Word Class
- ProcessingSource Enum
- ResultsTableCell Class
- ResultsTableValue Class
- ResultsTableColumnInfo Class
- ResultsTable Class
- Rotation Enum
- SectionType Enum
- WordGroupType Enum
- IDocumentTextProjection Interface
- ClassificationResult Class
- ExtractionResult Class
- ResultsDocument Class
- ResultsDocumentBounds Class
- ResultsDataPoint Class
- ResultsValue Class
- ResultsContentReference Class
- ResultsValueTokens Class
- ResultsDerivedField Class
- ResultsDataSource Enum
- ResultConstants Class
- SimpleFieldValue Class
- TableFieldValue Class
- DocumentGroup Class
- DocumentTaxonomy Class
- DocumentType Class
- Field Class
- FieldType Enum
- LanguageInfo Class
- MetadataEntry Class
- TextType Enum
- TypeField Class
- ITrackingActivity Interface
- ITrainableActivity Interface
- ITrainableClassifierActivity Interface
- ITrainableExtractorActivity Interface
- TrainableClassifierAsyncCodeActivity Class
- TrainableClassifierCodeActivity Class
- TrainableClassifierNativeActivity Class
- TrainableExtractorAsyncCodeActivity Class
- TrainableExtractorCodeActivity Class
- TrainableExtractorNativeActivity Class
- Document Understanding Digitizer
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding Process - Studio Template
- Document Understanding Activities
- About the Document Understanding Package
- Project Compatibility
- Set PDF Password
- Merge PDFs
- Get PDF Page Count
- Extract PDF Text
- Extract PDF Images
- Extract PDF Page Range
- Extract Document Data
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- Classify Document
- Create Classification Validation Task
- Create Classification Validation Task and Wait
- Wait for Classification Validation Task and Resume
- Intelligent OCR
- About the IntelligentOCR Activities Package
- Project Compatibility
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Intelligent Keyword Classifier
- Present Classification Station
- Create Document Classification Action
- Wait for Document Classification Action and Resume
- Train Classifiers Scope
- Keyword Based Classifier Trainer
- Intelligent Keyword Classifier Trainer
- Data Extraction Scope
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait for Document Validation Action and Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release Notes
- About the OCR Contracts
- Project Compatibility
- IOCRActivity Interface
- OCRAsyncCodeActivity Class
- OCRCodeActivity Class
- OCRNativeActivity Class
- Character Class
- OCRResult Class
- Word Class
- FontStyles Enum
- OCRRotation Enum
- OCRCapabilities Class
- OCRScrapeBase Class
- OCRScrapeFactory Class
- ScrapeControlBase Class
- ScrapeEngineUsages Enum
- ScrapeEngineBase
- ScrapeEngineFactory Class
- ScrapeEngineProvider Class
- OmniPage
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
Document Understanding Activities
Last updated Apr 10, 2024
ExtractorCodeActivity Class
Namespace:
UiPath.DocumentProcessing.Contracts.DataExtractionAssembly:
UiPath.DocumentProcessing.ContractsAbstract 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.
Note:
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.
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
DocumentPathInArgument<string> - The file path to the document.DocumentTextInArgument<string> - The text version of the document.DocumentObjectModelInArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> - The document object model of the document.ExtractorDocumentTypeInArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorDocumentType> - The document type information that the extractor takes into account.DocumentBoundsInArgument<UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds> - The page range and bounds that the extractor takes into account.ExtractorResultOutArgument<UiPath.DocumentProcessing.Contracts.DataExtraction.ExtractorResult> - The output of the extractor activity.PersistenceIdstring - The unique, opaque ID that is used by the scope activities in order to correctly track and configure the extractor activity.PredictionIdInArgument<string> - Identifies that the same document is processed in a workflow. It's composed of DocumentId+ JobId.
