activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- 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
- Release notes
- About the Document Understanding activity 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
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- 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
- Document Understanding Project Extractor
- 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 Dec 5, 2024
Digitize Document
UiPath.IntelligentOCR.Activities.Digitization.DigitizeDocument
Digitizes a document, extracting its Document Object Model (DOM) and text and storing them in their corresponding variable types.
Note: You must assign an OCR
engine to this activity by dragging it into the body of the activity. The chosen OCR
engine is to be used only if the incoming documents require OCR processing. Visit
OCR Engines to check the available OCR
engines. The input and output parameters of the selected OCR engine are
automatically set by the Digitize Document activity.
Properties panel
Common
- DisplayName - The display name of the activity.
Input
- ApplyOcrOnPdf -Establishes if the OCR process should be applied or not to PDF documents. If set to Yes, the OCR is applied to all PDF pages of the document. If set to No, only digitally typed text is extracted. The default value is Auto, determining if the document requires to apply the OCR algorithm depending on the input document.
- DegreeOfParalelism - Specifies how many,
if any, pages to be analyzed in parallel. The
-1value uses the "Number of Cores on the machine - 1". This means that the activity tries to process as many pages in parallel as the number of cores - 1 value, while specifying a positive value uses that specific number of logical processors. By default, this property is set to-1.This property accepts any value that is not greater thanLogicalProcessorCount - 1. - DetectCheckboxes - Detects the available check-boxes from the document while digitizing it. The default value is True.
- DocumentPath - The file path of the
document you want to digitize. This field supports only strings and
Stringvariables.Note:- In case of failure to classify a document that has enough data, in the Digitize Document activity, set the ApplyOcrOnPdf property as Yes.
- Text extraction from PDF files has been upgraded. This results in an optimized extraction process, where both native and scanned text is retrieved at the same time. The process applies OCR only on the images identified in the PDF file. This improvement is available only when the ApplyOCROnPDF option is set to Auto.
Note: The supported file types for this property field are.png,.jpe,.jpg,.jpeg,.tiff,.tif, and.pdf.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- DocumentObjectModel - The Document Object Model (DOM) of the file, stored in a
Documentvariable. This field supports onlyDocumentvariables. - DocumentText - The text extracted from the
specified document. This variable can be subsequently used in the Present
Validation Station activity. This field supports only
Stringvariables.Note: Starting with UiPath.IntelligentOCR.Activities package v6.3.0-preview, the Digitize Document activity comes with a default preselected OCR engine, the UiPath® Document OCR engine.
Both output variables, paired as they are dependent, can be used further in document processing throughout the entire document processing framework (classification, data extraction, human validation, etc.).
If the UiPath.IntelligentOCR.Activities package has been updated to v5.1.0, then the ForceApplyOCR parameter has been replaced with the ApplyOcrOnPDF. Here is the compatibility between the old and new parameters:
- ForceApplyOCR = True is replaced by ApplyOcrOnPDF = Yes;
- ForceApplyOCR = False is replaced by ApplyOcrOnPDF = Auto;
- ForceApplyOCR = Empty is replaced by ApplyOcrOnPDF = Auto;
- ForceApplyOCR = Your defined variable is replaced by ApplyOcrOnPDF = Auto.
Note: The Digitize Document
activity extracts the text from a PDF file and, for complex documents, it applies
pre-processing and post-processing algorithms. This activity can be used together
with other Document Understanding activities.
The Document Object Model is captured in a proprietary object. Visit Document Class for more information.
Tip: To successfully digitize and process
your documents, consider the following advice:
- For an image to be successfully digitized/processed, its width and height dimensions should be between 50 and 10000 pixels. Any image below or above this range is rejected, with an exception message. An image validated with the previously mentioned dimensions and with a total size bigger than 14 MP, is scaled down to 14 MP, while maintaining the aspect ratio (width or height ratio).
- The best results are obtained by keeping the skew angle between +/- 20 degrees.
Visit Manual validation for digitize documents to check how the Digitize Document activity is used in an example that incorporates multiple activities.
