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
- ContentValidationData Class
- EvaluatedBusinessRulesForFieldValue Class
- EvaluatedBusinessRuleDetails Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- FieldValue Class
- FieldValueResult 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
- Rule Class
- RuleResult Class
- RuleSet Class
- RuleSetResult Class
- 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
- FieldValueDetails Class
- 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
- Configuring external connection
- 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
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- Document Understanding Project Extractor Trainer
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Redact Document
- 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 Jun 11, 2025
PREVIEWRedact Document
UiPath.IntelligentOCR.Activities.Redaction.RedactDocument
The Redact Document activity generates a redacted PDF based on the original input PDF (provided as the Document Path), the Extraction Result and Words To Redact input fields.
The Redact Document activity uses the Document Object Model to access the location of all words identified in the PDF, while the Extraction Result and Words To Redact fields are used as input for the data that should be redacted, as follows:
- Every entry in the Words To Redact input array is considered as a string for a case-insensitive, continuous search within the document for redaction purposes.
- Extraction Result values that have a reference will be redacted based on this reference value (including customer area selections as reference for a value). Both regular fields and table cells are redacted.
- Extraction Result values that lack a reference (added without a reference to a field where Requires Reference is set to False) are considered similarly to entries in the Words To Redact field. This means that all occurrences of that specific text found in the input document will be redacted.
The activity searches for words using the Document Object Model, and fuzzy matching is not available.
For handling critically sensitive documents, we highly recommend performing human validation of extraction results and using reference-based values and selections. This ensures a comprehensive review of all data that needs to be redacted, minimizing the chances of OCR errors or word order issues affecting the final redaction output.
Designer panel
Input
- Document Path: The path to the document you want to redact.
- Document Object Model: The Document Object Model for the input documented obtained from the Digitize Document activity.
- Extraction Results
(Optional): The extraction results of the data extraction process, stored in an
ExtractionResultvariable. You can retrieve this from the Data Extraction Scope activity. - Words To Redact (Optional): A list of strings that will be redacted, in addition to the data sourced from the Extraction Results input field.
- Output File: The output file path where you want to save the redacted PDF.
Properties panel
Common
- DisplayName: The display name of the activity.
Input
- Document Path: The path to the document you want to redact.
- Document Object Model: The Document Object Model for the input documented obtained from the Digitize Document activity.
- Extraction Results (Optional): The extraction results of the data
extraction process, stored in an
ExtractionResultvariable. You can retrieve this from the Data Extraction Scope activity. - Words To Redact (Optional): A list of strings that will be redacted, in addition to the data sourced from the Extraction Results input field.
- Output File: The output file path where you want to save the redacted PDF.
Misc
- Private: If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- Output File: The output file which contains the redacted information.
Redaction Settings
- BorderColor: The color of the border used for redaction.
- BorderThickness: The thickness of the border used for redaction.
- Dpi: The Dots per inch value that represents the quality of the images embedded in the redacted PDF.
- FillColor: The fill color used for redaction.
